NsqSharp

An nsqd HTTP client.

HTTP client for interacting with the common API between nsqd and nsqlookupd. See http://nsq.io/components/nsqd.html#pub. See and .

Initializes a new instance of class.

Thrown when is null or empty. The nsqd or nsqlookupd HTTP address. The HTTP request timeout.

Create a topic. Topic creation happens automatically on publish, use this method to pre-create a topic.

The topic. The response from the server.

Delete a topic.

The topic. The response from the server.

Create a channel. Channel creation happens automatically on subscribe, use this method to pre-create a channel.

The topic. The channel. The response from the server.

Delete a channel.

The topic. The channel. The response from the server.

Returns version information as a JSON string.

The response from the server.

Monitoring endpoint, should return OK. It returns a 500 if it is not healthy. At the moment, the only unhealthy state would be if it failed to write messages to disk when overflow occurred.

The response from the server.

Validates the topic name.

Thrown when one or more required arguments are null. Thrown when one or more arguments have unsupported or illegal values. The topic name.

Validates the topic and channel name.

Thrown when one or more required arguments are null. Thrown when one or more arguments have unsupported or illegal values. The topic name. The channel name.

Gets the HTTP address plus route.

Thrown when one or more required arguments are null. The route. The full URL.

POSTs to the specified route using the HTTP address from the constructor.

The route. The body. The response from the server.

GETs from the specified route using the HTTP address from the constructor.

The route. The response from the server.

Initiates and HTTP request to the specified .

Thrown when an exception error condition occurs. The endpoint. The HTTP method. The timeout in milliseconds. The body. The response from the server.

Initializes a new instance of class.

The nsqlookupd HTTP address. The HTTP request timeout.

Publishes a message.

The topic. The message. The response from the nsqd HTTP server.

Publishes a message.

The topic. The message. The response from the nsqd HTTP server.

Publishes multiple messages. More efficient than calling Publish several times for the same message type. See http://nsq.io/components/nsqd.html#mpub.

The topic. The messages. The response from the nsqd HTTP server.

Publishes multiple messages. More efficient than calling Publish several times for the same message type. See http://nsq.io/components/nsqd.html#mpub.

The topic. The messages. The response from the nsqd HTTP server.

Empty a topic.

The topic. The response from the nsqd HTTP server.

Empty a channel.

The topic. The channel. The response from the nsqd HTTP server.

Pause a topic.

The topic. The response from the nsqd HTTP server.

Unpause a topic.

The topic. The response from the nsqd HTTP server.

Pause a channel.

The topic. The channel. The response from the nsqd HTTP server.

Unpause a channel.

The topic. The channel. The response from the nsqd HTTP server.

Returns internal instrumented statistics.

The response from the nsqd HTTP server.

Statistics information for nsqd. See .

version

health

topics

Topic information for nsqd. See .

topic_name

channels

depth

backend_depth

message_count

paused

e2e_processing_latency

Channel information for nsqd. See .

channel_name

depth

backend_depth

in_flight_count

deferred_count

message_count

requeue_count

timeout_count

clients

paused

Client information for nsqd. See .

name

client_id

hostname

version

remote_address

state

ready_count

in_flight_count

message_count

finish_count

requeue_count

connect_ts

sample_rate

deflate

snappy

user_agent

tls

tls_cipher_suite

tls_version

tls_negotiated_protocol

tls_negotiated_protocol_is_mutual

count

percentiles

quantile

value

time

An nsqlookupd HTTP client.

Initializes a new instance of class.

The nsqlookupd HTTP address. The HTTP request timeout.

Returns a list of nsqd producers and channel information for a topic.

The topic to list producers for.

Returns a list of all known topics.

Returns a list of all known channels of a .

The topic to list channels for.

Returns a list of all known nsqd nodes.

Tombstones a specific producer of an existing . Tombstoning a prevents clients from discovering the through nsqlookupd for a configurable -- tombstone-liftime, allowing the to delete the topic without it being recreated by connecting clients.

The topic to list producers for. The nsqd node.

nsqlookupd response to /topics.

Gets or sets the topics.

The topics.

nsqlookupd response from /nodes.

Gets or sets the producers.

The producers.

nsqlookupd producer list from /nodes.

nsqlookupd producer list from /lookup?topic=[topic_name].

Gets or sets the remote address.

The remote address.

Gets or sets the hostname.

The hostname.

Gets or sets the broadcast address.

The broadcast address.

Gets or sets the TCP port.

The TCP port.

Gets or sets the HTTP port.

The HTTP port.

Gets or sets the nsqd version.

The nsqd version.

Gets a value indicating if an entry in is tombstoned.

The tombstones.

Gets or sets the topics.

The topics.

nsqlookupd response from /lookup?topic=[topic_name].

Gets or sets the nodes producing the topic.

The nodes producing the topic.

Gets or sets the channels associated with the topic

The channels associated with the topic.

Static class to start and stop the bus.

Starts the bus service.

Note: This is a blocking call for Console Applications running in interactive mode. This method will block until Ctrl+C is pressed and then initiate a clean shutdown. Thrown when is null. The bus configuration.

Stops the bus permanently. Windows Services - This method is called when the service is stopped or restarted. You do not need to call it directly. ASP.NET Applications (including Web API and WCF) - May call this method directly if clean exit is a high priority. If not called directly it will be called automatically when the hosting enviroment shuts down the application (Application Pool stop/restart, Site stop/restart, etc), although the timeout period before a forced shutdown is not guaranteed. Console Applications - May call this method directly, otherwise it will be called automatically when the user presses Ctrl+C. Windows Forms/WPF Applications - May call this method directly if clean exit is necessary, otherwise it will be called with a short timeout (~3s) when the process exits normally (not force killed).

StructureMap object builder. See .

Object builder interface.

Creates or finds the registered instance of type .

The type to resolve. The registered instance of type .

Creates or finds the registered instance of the specifid .

The type to resolve. The registered instance of the specifid .

Injects an of type into the container.

The instance type. The instance to inject.

Initializes a new instance of the class. See .

Autofac IContainer (result of containerBuilder.Build)

Creates or finds the registered instance of type .

The type to resolve. The registered instance of type .

Creates or finds the registered instance of the specifid .

The type to resolve. The registered instance of the specifid .

Injects an of type into the container.

The instance type. The instance to inject.

Convenience class for writing exceptions to the console. In Production a more robust auditing implementation should be used. See the PointOfSale example for an implementation which uses NLog and SQL Server.

Implement to handle auditing of started, succeeded, and failed messages. .

Occurs when a message is received.

The bus. Message information including the topic, channel, and raw message.

Occurs when a message handler succeeds.

The bus. Message information including the topic, channel, and raw message.

Occurs when a message handler fails.

The bus. Message information including the topic, channel, and raw message.

Occurs when a message is received.

The bus. Message information including the topic, channel, and raw message.

Occurs when a message handler succeeds.

The bus. Message information including the topic, channel, and raw message.

Occurs when a message handler fails.

The bus. Message information including the topic, channel, and raw message.

Convenience class implementing with a .

Implement to specify which channel a message handler should consume/subscribe to. See , , and .

Gets the channel the specified should consume/subscribe to.

The message handler type. See . The channel the specified should consume/subscribe to.

Gets the registered handler types implementing .

The registered handler types implementing .

Initializes a new isntance of the class.

The dictionary of message types to topic names, where Key = handler type, Value = channel name.

Gets the channel the specified should consume/subscribe to.

The message handler type. See . The channel the specified should consume/subscribe to.

Gets the registered handler types implementing .

The registered handler types implementing .

Convenience class implementing with a .

Implement to specify which topic a message type should be produced/published on. See , , and .

Gets the topic the specified should be produced/published on.

The message type. See . The topic the specified should be produced/published on.

Initializes a new isntance of the class.

The dictionary of message types to topic names, where Key = message type, Value = topic name.

Gets the topic the specified should be produced/published on.

The message type. See . The topic the specified should be produced/published on.

Convenience class for creating a Newtonsoft.Json message serializer. See .

Message serializer interface.

Serializes the specified to a byte array.

The value to serialize. The serialized value.

Deserializes the specified to an object of type .

The type of the deserialized object. The value to deserialize. The deserialized object.

Initializes a new instance of the class. See .

The Newtonsoft.Json assembly; typically typeof(JsonConvert).Assembly.

Serializes the specified to a byte array.

The value to serialize. The serialized value.

Deserializes the specified to an object of type .

The type of the deserialized object. The value to deserialize. The deserialized object.

NSQD HTTP publisher.

Interface for an NSQD publisher.

Publishes a on the specified .

The topic. The message.

Multi-Publishes on the specified .

The topic. The messages.

Stops the nsqd publisher.

Initializes a new instance of the class.

Thrown when is null or empty. The nsqd HTTP endpoint. The HTTP request timeout.

Publishes a on the specified .

The topic. The message.

Multi-Publishes on the specified .

The topic. The messages.

Stops the nsqd publisher.

NSQD TCP publisher.

Initializes a new instance of the NsqSharp.Bus.Configuration.BuiltIn.NsqdTcpPublisher class.

Thrown when one or more required arguments are null. The nsqd address. The logger. The configuration.

Publishes a on the specified .

The topic. The message.

Multi-Publishes on the specified .

The topic. The messages.

Stops the nsqd publisher.

StructureMap object builder. See .

Initializes a new instance of the class. See .

StructureMap ObjectFactory.Container

Creates or finds the registered instance of type .

The type to resolve. The registered instance of type .

Creates or finds the registered instance of the specifid .

The type to resolve. The registered instance of the specifid .

Injects an of type into the container.

The instance type. The instance to inject.

Configure and start a new Bus.

Bus configuration.

Gets a list of topics/channels currently handled by this process.

A list of topics/channels currently handled by this process.

true if the process is running in a console window.

Initializes a new instance of the class.

The DI container to use for this bus (required). See for a default implementation. The default message serializer/deserializer. See for a default implementation. The handler to call when a message fails to process. The message type to topic provider. The handler type to channel provider. The default nsqlookupd HTTP endpoints; typically listening on port 4161. The default number of threads per message handler. The NSQ (optional). Handle bus start and stop events (optional). The used by NsqSharp when communicating with nsqd/nsqlookupd. (default = ). Set to true to pre-create all registered topics and channels on the local nsqd instance listening on 127.0.0.1:4151; useful for self-contained clusters (default = false). The message mutator used to modify a message before it's sent (optional). The message router used to specify custom message-to-topic routing logic; used to override (optional). The implementation responsible for handling calls (optional; default = using 127.0.0.1:4150 and the specified and ). true to log using (default = true).

Add message handlers from the specified list of . Uses defaults specified in the constructor.

The message handler types to add. Throws if a type is an invalid message handler.

Adds a message handler. If a duplicate , , and is added the old value will be overwritten.

The concrete message handler type. The message type. The topic name. The channel name. The message serializer (optional; otherwise uses default). The Consumer to use (optional; otherwise uses default). The number of threads per message handler (optional; otherwise uses default). The nsqlookupd HTTP addresses to use (optional; otherwise uses default).

Gets a list of topics/channels currently handled by this process.

A list of topics/channels currently handled by this process.

true if the process is running in a console window.

Implement to act before and after the bus starts and stops. See .

Occurs before the bus starts. If an exception is thrown in this method the bus will not start.

The bus configuration.

Occurs after the bus starts.

The bus configuration. The bus.

Occurs before the bus stops. If an exception is thrown in this method the bus will not stop.

The bus configuration. The bus.

Occurs after the bus stops.

The bus configuration.

Implement this interface to modify a message before it is sent.

Gets a mutated message before it is sent.

The message type. The bus sending this message. The message about to be sent. The mutated message.

Implement this interface to specify custom message-to-topic routing logic based on a message object about to be sent.

Gets the topic a message should be sent on.

The message type. The bus sending this message. The original topic name as provided by the implementation of passed to this bus. The message about to be sent. The topic to send this message on.

Gets the topics a specified can be produced/published on based on the implementation of .

The message type. See . The topics the specified can be produced/published on based on the implementation of .

Topic and channel information for the current process.

The topic name.

The topic channels handled by this process.

Topic and channel information for the current process.

The topic name.

The topic channels handled by this process.

Information about the message being handled.

A unique identifier for this instance of handling this message generated by NsqSharp.

The topic the message was delivered on.

The channel the message was delivered on.

The message.

The deserialized message body (can be null).

Thrown when a message handler configuration is invalid.

Initializes a new instance of the class.

The exception message.

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0).

IBus interface.

Sends a message of type on the configured topic.

The message type. The message.

Sends an empty message of type on the configured topic.

The message type (can be an interface).

Sends a message of type on the configured topic, using to populate the message.

The message type (can be an interface). The method used to populate the object.

Sends messages of type on the configured topic. More efficient than calling .

The message type. The messages.

Gets about the current message being processed. Returns null if the current thread isn't a thread started to handle a message.

Gets the current NSQ message being processed. Returns null if the current thread isn't a thread started to handle a message.

Implement to register a class as a message handler.

The message type.

Handles a message.

The message to handle.

The queue action taken for the failed message.

Message was requeued.

Message was failed permanently.

The category of mesage failure.

The dependency injection container failed to build the object or the handler constructor threw an exception.

The failed to deserialize.

The implementation threw an exception.

The maximum number of attempts was exceeded.

Message information including topic, channel, handler type, message type, raw NSQ message, and deserialized message.

A unique identifier for this instance of handling this message generated by NsqSharp.

The topic the message was delivered on.

The channel the message was delivered on.

The handler .NET type.

The message .NET type.

The message.

The deserialized message body (can be null).

The the handler started processing this message.

The the handler finished processing this message (can be null).

Failed message information. In addition to properties provided by the following are added: , , .

The queue action taken for the failed message.

The category of mesage failure.

The exception (can be null).

Message processing interface for . When the method returns the will automatically handle FIN'ing the message. When an exception is thrown the will automatically handle REQ'ing the message.

Handles a message.

The message.

Called when a has exceeded the specified .

The failed message.

Create a concrete type based on an interface.

Create a concrete object based on an interface.

Create a concrete type based on an interface.

is accepted by for filtering the nsqd addresses returned from nsqlookupd.

Filters a list of nsqd addresses.

nsqd addresses returned by nsqlookupd. The filtered list of nsqd addresses to use.

represents a snapshot of the state of a 's connections and the messages it has seen.

The number of messages received.

The number of messages finished.

The number of messages requeued.

The number of nsqd connections.

is a high-level type to consume messages from NSQ. A instance is supplied an instance to . The supplied instance will be executed concurrently to process the stream of messages consumed from the specified topic/channel. If configured, it will poll nsqlookupd instances and handle connection (and reconnection) to any discovered nsqds. See .


                 
                 using System;
                 using System.Text;
                 using NsqSharp;
                 
                 class Program
                 {
                     static void Main()  
                     {
                         // To test, run:
                         // nsqd.exe
                         // to_nsq.exe -topic=test-topic-name -nsqd-tcp-address=127.0.0.1:4150
            
                         // Create a new Consumer for each topic/channel
                         var consumer = new Consumer("test-topic-name", "channel-name");
                         consumer.AddHandler(new MessageHandler());
                         consumer.ConnectToNsqd("127.0.0.1:4150"); // nsqd tcp address/port
                         //consumer.ConnectToNsqLookupd("127.0.0.1:4161"); // nsqlookupd http address/port
                 
                         Console.WriteLine("Listening for messages. Press enter to stop...");
                         Console.ReadLine();
                 
                         consumer.Stop();
                     }
                 }
                 
                 public class MessageHandler : IHandler
                 {
                     // Handles a message.
                     public void HandleMessage(IMessage message)
                     {
                         string msg = Encoding.UTF8.GetString(message.Body);
                         Console.WriteLine(msg);
                     }
                 
                     // Called when a message has exceeded the specified MaxAttempts.
                     public void LogFailedMessage(IMessage message)
                     {
                         // Log failed messages
                     }
                 }

ConnDelegate is an interface of methods that are used as callbacks in Conn

OnResponse is called when the connection receives a FrameTypeResponse from nsqd

OnError is called when the connection receives a FrameTypeError from nsqd

OnMessage is called when the connection receives a FrameTypeMessage from nsqd

OnMessageFinished is called when the connection handles a FIN command from a message handler

OnMessageRequeued is called when the connection handles a REQ command from a message handler

OnBackoff is called when the connection triggers a backoff state

OnContinue is called when the connection finishes a message without adjusting backoff state

OnResume is called when the connection triggers a resume state

OnIOError is called when the connection experiences a low-level TCP transport error

OnHeartbeat is called when the connection receives a heartbeat from nsqd

OnClose is called when the connection closes, after all cleanup

Creates a new instance of for the specified and . Uses the default and with log level .

Thrown when one or more required arguments are null. Thrown when the or exceed the maximum length or contain invalid characters. Topic and channel names must be greater than 0 and less than or equal to 64 characters longer and must match the pattern "^[\.a-zA-Z0-9_-]+(#ephemeral)?$". Uses with to log messages. Uses the default to configure this . The topic name. The channel name.

Creates a new instance of for the specified and , using the specified . Uses the default .

Thrown when one or more required arguments are null. Thrown when the or exceed the maximum length or contain invalid characters. Topic and channel names must be greater than 0 and less than or equal to 64 characters longer and must match the pattern "^[\.a-zA-Z0-9_-]+(#ephemeral)?$". Uses the default to configure this . The topic name. The channel name. The instance.

Creates a new instance of for the specified and , using the specified . Uses with log level .

Thrown when one or more required arguments are null. Thrown when the or exceed the maximum length or contain invalid characters. Topic and channel names must be greater than 0 and less than or equal to 64 characters longer and must match the pattern "^[\.a-zA-Z0-9_-]+(#ephemeral)?$". Uses with to log messages. The topic name. The channel name. The settings. After config is passed in the values are no longer mutable (they are copied).

Creates a new instance of for the specified and , using the specified and .

Thrown when one or more required arguments are null. Thrown when the or exceed the maximum length or contain invalid characters. Topic and channel names must be greater than 0 and less than or equal to 64 characters longer and must match the pattern "^[\.a-zA-Z0- 9_-]+(#ephemeral)?$". The topic name. The channel name. The instance. The settings. After config is passed in the values are no longer mutable (they are copied).

Retrieves the current connection and message for this .

Messages received, messages finished, messages requeued, and number of nsqd connections.

takes an that can filter the list of nsqd addresses returned by nsqlookupd.

The discovery filter.

perConnMaxInFlight calculates the per-connection max-in-flight count. This may change dynamically based on the number of connections to nsqd the Consumer is responsible for.

Sets a new maximum number of messages this instance will allow in-flight, and updates all existing connections as appropriate. For example, (0) would pause message flow. If already connected, it updates the reader RDY state for each connection.

The maximum number of message to allow in flight.

Adds nsqlookupd addresses to the list for this instance. If it is the first to be added, it initiates an HTTP request to discover nsqd producers for the configured topic. A new thread is created to handle continual polling.

Thrown when is null. Thrown when is empty. The nsqlookupd address(es) to add.

poll all known lookup servers every LookupdPollInterval

return the next lookupd endpoint to query keeping track of which one was last used

Adds nsqd addresses to directly connect to for this instance. It is recommended to use so that topics are discovered automatically. This method is useful when you want to connect to a single, local instance.

Thrown when is null. Thrown when is empty. The nsqd address(es) to add.

Closes the connection to and removes the specified from the list.

Thrown when is null. Thrown when the specified is not in the list of active connections. The nsqd address to disconnect from.

Removes the specified from the list used for periodic discovery.

Thrown when is null. Thrown when the specified is not in the list of current nsqlookupd addresses. Thrown when the is the last nsqlookupd in the list. The nsqlookupd address to remove.

Wait for the to stop. Usually used when another thread calls or .

Synchronously initiates a graceful stop of the (permanent) and waits for the stop to complete.

Asynchronously initiates a graceful stop of the (permanent).

A which can be awaited for the stop to complete.

Sets the instance to handle for messages received by this . This method throws if called after connecting to nsqd or nsqlookupd.

Thrown when is null. Thrown when is less than 1. Thrown when or has been called before invoking . The handler for the topic/channel of this instance. The number of threads used to handle incoming messages for this (default = 1).

AddConcurrentHandlers sets the Handler for messages received by this Consumer. It takes a second argument which indicates the number of goroutines to spawn for message handling. This panics if called after connecting to nsqd or nsqlookupd (see Handler or HandlerFunc for details on implementing this interface)

Indicates whether any connections for this are blocked on processing before being able to receive more messages (ie. RDY count of 0 and not exiting).

true if this instance is starved; otherwise, false.

Command represents a command from a client to an NSQ daemon

Initializes a new instance of the class.

String returns the name and parameters of the Command

WriteTo implements the WriterTo interface and serializes the Command to the supplied Writer. It is suggested that the target Writer is buffered to avoid performing many system calls.

Identify creates a new Command to provide information about the client. After connecting, it is generally the first message sent. The supplied map is marshaled into JSON to provide some flexibility for this command to evolve over time. See http://bitly.github.io/nsq/clients/tcp_protocol_spec.html#identify for information on the supported options

Auth sends credentials for authentication After `Identify`, this is usually the first message sent, if auth is used.

UnRegister creates a new Command to remove a topic/channel for the connected nsqd

Ping creates a new Command to keep-alive the state of all the announced topic/channels for a given client

Publish creates a new Command to write a message to a given topic

MultiPublish creates a new Command to write more than one message to a given topic. This is useful for high-throughput situations to avoid roundtrips and saturate the pipe.

Subscribe creates a new Command to subscribe to the given topic/channel

Ready creates a new Command to specify the number of messages a client is willing to receive

Finish creates a new Command to indiciate that a given message (by id) has been processed successfully

Requeue creates a new Command to indicate that a given message (by id) should be requeued after the given delay NOTE: a delay of 0 indicates immediate requeue

Touch creates a new Command to reset the timeout for a given message (by id)

StartClose creates a new Command to indicate that the client would like to start a close cycle. nsqd will no longer send messages to a client in this state and the client is expected finish pending messages and close the connection

Nop creates a new Command that has no effect server side. Commonly used to respond to heartbeats

Name

Params

Body

IdentifyResponse represents the metadata returned from an IDENTIFY command to nsqd

Max RDY count

Use TLSv1

Use Deflate compression

Use Snappy compression

Auth required

AuthResponse represents the metadata returned from an AUTH command to nsqd

Identity

Identity URL

Permission Count

Conn represents a connection to nsqd Conn exposes a set of callbacks for the various events that occur on a connection

Reader is the interface that wraps the basic Read method. http://golang.org/pkg/io/#Reader

Read reads data from the connection.

The byte array to populate. The number of bytes read.

Writer is the interface that wraps the basic Write method. http://golang.org/pkg/io/#Writer

Write writes data to the connection.

The number of bytes written.

IConn interface

SetLogger assigns the logger to use as well as a level. The format parameter is expected to be a printf compatible string with a single {0} argument. This is useful if you want to provide additional context to the log messages that the connection will print, the default is '({0})'.

Connect dials and bootstraps the nsqd connection (including IDENTIFY) and returns the IdentifyResponse

Close idempotently initiates connection close

WriteCommand is a thread safe method to write a Command to this connection, and flush.

Initializes a new instance of the class.

Connect dials and bootstraps the nsqd connection (including IDENTIFY) and returns the IdentifyResponse

Close idempotently initiates connection close

SetRDY stores the specified RDY count

RemoteAddr returns the configured destination nsqd address

String returns the fully-qualified address

Read performs a deadlined read on the underlying TCP connection

Write performs a deadlined write on the underlying TCP connection

WriteCommand is a thread safe method to write a Command to this connection, and flush.

Flush writes all buffered data to the underlying TCP connection

IsClosing indicates whether or not the connection is currently in the processing of gracefully closing

RDY returns the current RDY count

LastRDY returns the previously set RDY count

MaxRDY returns the nsqd negotiated maximum RDY count that it will accept for this connection

LastMessageTime returns a time.Time representing the time at which the last message was received

Identify request.

client_id

hostname

user_agent

short_id (deprecated)

long_id (deprecated)

tls_v1

deflate

deflate_level

snappy

feature_negotiation

heartbeat_interval

sample_rate

output_buffer_size

output_buffer_timeout

msg_timeout

LogLevel specifies the severity of a given log message

Debug

Info

Warning

Error

Critical

Logging constants

LogLevelDebugPrefix

LogLevelInfoPrefix

LogLevelWarningPrefix

LogLevelErrorPrefix

LogLevelCriticalPrefix

LogPrefix Resolution

MessageDelegate is an interface of methods that are used as callbacks in Message

OnFinish is called when the Finish() method is triggered on the Message

OnRequeue is called when the Requeue() method is triggered on the Message

OnTouch is called when the Touch() method is triggered on the Message

ErrNotConnected is returned when a publish command is made against a Producer that is not connected

Initializes a new instance of the ErrNotConnected class.

Initializes a new instance of the class with serialized data.

ErrStopped is returned when a publish command is made against a Producer that has been stopped

Initializes a new instance of the ErrStopped class.

Initializes a new instance of the class with serialized data.

ErrClosing is returned when a connection is closing

Initializes a new instance of the ErrClosing class.

Initializes a new instance of the class with serialized data.

ErrOverMaxInFlight is returned from Consumer if over max-in-flight

Initializes a new instance of the ErrOverMaxInFlight class.

Initializes a new instance of the class with serialized data.

ErrIdentify is returned from Conn as part of the IDENTIFY handshake

Initializes a new instance of the ErrIdentify class.

Initializes a new instance of the class with serialized data.

Sets the with information about the exception.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference.

Gets or sets the reason

ErrProtocol is returned from Producer when encountering an NSQ protocol level error

Initializes a new instance of the ErrProtocol class.

Initializes a new instance of the class with serialized data.

Message is the fundamental data type containing the , , and metadata of a message received from an nsqd instance.

Disables the automatic response that would normally be sent when returns or throws. This is useful if you want to batch, buffer, or asynchronously respond to messages.

Sends a FIN command to the nsqd which sent this message, indicating the message processed successfully.

Sends a TOUCH command to the nsqd which sent this message, resetting the default message timeout. The server-default timeout is 60s; see . If FIN or REQ have already been sent for this message, calling has no effect.

Sends a REQ command to the nsqd which sent this message, using the supplied delay. A delay of null will automatically calculate based on the number of attempts and the configured . Using this method to respond triggers a backoff event.

The minimum amount of time the message will be requeued.

Encodes the message frame and body and writes it to the supplied . It is suggested that the target is buffered to avoid performing many system calls.

Thrown when is null. The stream to write this message. The number of bytes written to .

The message body byte array.

The original timestamp when the message was published.

The current attempt count to process this message. The first attempt is 1.

The maximum number of attempts before nsqd will permanently fail this message.

The nsqd address which sent this message.

Indicates whether or not this message will be responded to automatically when returns or throws.

true if automatic response is disabled; otherwise, false.

Indicates whether or not this message has been FIN'd or REQ'd.

true if this message has been FIN'd or REQ'd; otherwise, false.

Indicates whether this message triggered a backoff event, causing the to slow its processing based on .

true if this message triggered a backoff event; otherwise, false.

The minimum date/time the message will be requeued until; null indicates the message has not been requeued.

The message ID as a hexadecimal string. The message ID for a given message will be the same across channels; the message ID is created at the topic level. If the message is requeued or times out it will retain the same message ID on future attempts.

The message ID as a hexadecimal string.

The number of bytes for a Message.ID

Initializes a new instance of the class.

The class is created in response to messages read from the TCP connection with nsqd. Typically you would not need to instantiate this class yourself. Thrown when either or are null. Thrown when the length is not 16. The message ID. The message body.

Disables the automatic response that would normally be sent when returns or throws. This is useful if you want to batch, buffer, or asynchronously respond to messages.

Sends a FIN command to the nsqd which sent this message, indicating the message processed successfully.

The minimum amount of time the message will be requeued.

Encodes the message frame and body and writes it to the supplied . It is suggested that the target is buffered to avoid performing many system calls.

Thrown when is null. The stream to write this message. The number of bytes written to .

Decodes and creates a new .

Thrown is null. The fully encoded message. The decoded message.

The message body byte array.

The original timestamp when the message was published.

The current attempt count to process this message. The first attempt is 1.

The maximum number of attempts before nsqd will permanently fail this message.

The nsqd address which sent this message.

Indicates whether or not this message will be responded to automatically when returns or throws.

true if automatic response is disabled; otherwise, false.

Indicates whether or not this message has been FIN'd or REQ'd.

true if this message has been FIN'd or REQ'd; otherwise, false.

Indicates whether this message triggered a backoff event, causing the to slow its processing based on .

true if this message triggered a backoff event; otherwise, false.

The minimum date/time the message will be requeued until; null indicates the message has not been requeued.

The message ID as a hexadecimal string.

Protocol

MagicV1 is the initial identifier sent when connecting for V1 clients

MagicV2 is the initial identifier sent when connecting for V2 clients

IsValidTopicName checks a topic name for correctness

The topic name to check true if the topic name is valid; otherwise, false

IsValidChannelName checks a channel name for correctness

The channel name to check true if the channel name is valid; otherwise, false

ReadResponse is a client-side utility function to read from the supplied Reader according to the NSQ protocol spec

The stream to read from The response as a byte array

UnpackResponse is a client-side utility function that unpacks serialized data according to NSQ protocol spec ///

The response to unpack The frame type. The body.

ReadUnpackedResponse reads and parses data from the underlying TCP connection according to the NSQ TCP protocol spec and returns the frameType, data or error

The reader to read from The frame type. The body.

Frame types

Response

Error

Message

States

Init

Disconnected

Connected

Subscribed

Closing means CLOSE has started... (responses are ok, but no new messages will be sent)

NSQ Client Information

Client name

Version

Values that represent HTTP methods.

GET method.

POST method.

Default value attribute.

Initializes a new instance of the DefaultAttribute class.

The default value.

Gets the default value.

Max value attribute.

Initializes a new instance of the MaxAttribute class.

The maximum value.

Gets the maximum value.

Min value attribute.

Initializes a new instance of the MinAttribute class.

The minimum value.

Gets the minimum value.

Option attribute

Initializes a new instance of the OptAttribute class.

The option name to apply to the property.

The option name.

Binary package. https://golang.org/src/encoding/binary/binary.go

BigEndian is the big-endian implementation of ByteOrder.

Read reads structured binary data from . Bytes read from are decoded using the specified byte and written to successive fields of the data.

The reader. The byte order.

Binary.BigEndian

A ByteOrder specifies how to convert byte sequences into 16-, 32-, or 64-bit unsigned integers.

Fills a byte array with a using big endian ordering.

Reads a byte array into a new using big endian ordering.

Fills a byte array with a using big endian ordering.

Writes a using big endian ordering.

Fills a byte array with a using big endian ordering.

Writes a using big endian ordering.

Fills a byte array with a using big endian ordering.

Writes a using big endian ordering.

Fills a byte array with a using big endian ordering.

Reads a byte array into a new using big endian ordering.

Reads a byte array into a new using big endian ordering. Warning: Will reorder byte array if is true.

Reads a a new using big endian ordering.

Reads a byte array into a new using big endian ordering.

Reads a a new using big endian ordering.

Channel for synchronizing communication between threads. Supports foreach to read from the channel until it's closed. See also .

The message type communicated over the channel.

IReceiveOnlyChan interface.

The type of data received on the channel.

IReceiveOnlyChan interface.

IChan interface.

Add a listener which will be notified when a channel is ready to send.

Add a listener which will be notified when a channel is ready to receive.

Remove a listener for send.

Gets a value indicating whether the channel is closed.

Receives a message from the channel. Blocks until a message is ready or channel is closed.

The message received.

Tries to lock the receive method to the current thread.

true if the lock was successful; otherwise, false.

Unlocks the receive method.

Gets a value indicating if the channel is ready to send and waiting for a receiver.

Receives a message from the channel. Blocks until a message is ready or channel is closed.

The message received.

ISendOnlyChan interface.

The type of data sent on the channel

ISendOnlyChan interface.

Tries to lock the send method to the current thread.

true if the lock was successful; otherwise, false.

Unlocks the send method.

Tries to send a message to the channel. Blocks until the message is received or the expires.

The message to send. The timout period. true if the message was sent; otherwise, false.

Sends a message to the channel. Blocks until the message is received.

The message to send.

Initializes a new unbuffered channel.

Initializes a new channel with specified .

The size of the send buffer.

Sends a message to the channel. Blocks until the message is received.

The message to send.

Receives a message from the channel. Blocks until a message is ready or the channel is closed.

The message received; or default(T) if the channel was closed.

Receives a message from the channel. Blocks until a message is ready or the channel is closed.

The message received; or default(T) if the channel was closed. Includes an indicator whether the channel was closed or not.

Returns an enumerator that iterates through the collection.

A that can be used to iterate through the collection.

Closes the channel.

Occurs when attempt to send or receive from a closed channel.

Initializes a new instance of the class.

Initializes a new instance of the class with serialized data.

Control structure to send or receive from the first available channel. Chain Case methods and end with a call to Default or NoDefault.

private static void Main() { var c = new Chan<string>(); var quit = new Chan<bool>(); Task.Factory.StartNew(() => GetNumbers(c, "A", quit)); Task.Factory.StartNew(() => GetNumbers(c, "B", quit)); Task.Factory.StartNew(() => GetNumbers(c, "C", quit)); int count = 0; foreach (var msg in c) { Console.WriteLine(msg); if (count > 100) { quit.Send(true); quit.Send(true); quit.Send(true); } count++; } } private static void GetNumbers(Chan<string> c, string name, Chan<bool> quit) { for (var i = 1; !breakLoop; i++) { Select .CaseSend(c, string.Format("{0} {1}", name, i), () => { if (name == "A") { Thread.Sleep(200); } if (name == "C") { Thread.Sleep(100); } Thread.Sleep(100); }) .CaseReceive(quit, o => { breakLoop = true; }) .NoDefault(); } c.Close(); }

Creates a case for receiving from the specific channel.

The channel to receive from. Can be null. The function to execute with the data received from the channel. Can be null An instance to append another Case, Default, or NoDefault. Select must end with a call to Default or NoDefault.

Creates a case for receiving from the specific channel.

The channel to receive from. Can be null. The function to execute with the data received from the channel. An instance to append another Case, Default, or NoDefault. Select must end with a call to Default or NoDefault.

Creates a case for sending to the specific channel.

The channel to send to. Can be null. The message to send. The callback function to execute once the message has been sent. Can be null. An instance to append another Case, Default, or NoDefault. Select must end with a call to Default or NoDefault.

Control structure to send or receive from the first available channel. Chain Case methods and end with a call to Default or NoDefault.

Creates a case for receiving from the specific channel.

Creates a case for sending to the specific channel.

Executes a default action if no channels are ready.

The callback function to execute if no channels are ready. Can be null.

Specifies that no action should be taken if no channels are ready. Blocks until one channel is ready and its callback function has been executed.

Defers execution to use the same build-up in a loop. Call inside the loop, and wrap in a using or manually call when done.

Executes the select. Only necessary if defer = true was passed to .

Clean up references. Only necessary if defer = true was passed to .

extension methods.

Indicates whether a specified string is null, empty, or consists only of white-space characters.

Console logger

Logger interface.

Writes the output for a logging event.

Flushes the output stream.

Initializes a new instance of the class.

The minimum to output.

Writes the output for a logging event.

Flushes the output stream.

Trace logger

Initializes a new instance of the class.

Output writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Logger. A newline is appended if the last character of s is not already a newline.

Flushes the output stream.

Define handlers for setting config defaults, and setting config values from command line arguments or config files

Read only configuration values related to backoff.

Unit of time for calculating consumer backoff.

defines a strategy for calculating the duration of time a consumer should backoff for a given attempt

Calculates the backoff time.

Read only configuration values related to backoff. The number of times this message has been attempted (first attempt = 1). The to backoff.

implements an exponential backoff strategy (default)

Calculate returns a duration of time: 2 ^ attempt * .

Read only configuration values related to backoff. The number of times this message has been attempted (first attempt = 1). The to backoff.

FullJitterStrategy returns a random duration of time [0, 2 ^ attempt]. Implements http://www.awsarchitectureblog.com/2015/03/backoff.html.

Calculate returns a random duration of time [0, 2 ^ attempt] * .

Read only configuration values related to backoff. The number of times this message has been attempted (first attempt = 1). The to backoff.

Config is a struct of NSQ options The only valid way to create a Config is via NewConfig, using a struct literal will panic. After Config is passed into a high-level type (like Consumer, Producer, etc.) the values are no longer mutable (they are copied). Use Set(string option, object value) as an alternate way to set parameters

Initializes a new instance of Config.

Takes an as a string and a and attempts to set the appropriate configuration option. It attempts to coerce the into the right format depending on the named option and the underlying type of the value passed in. Calls to that take a as an argument can be input as: "1000ms" (a string parsed by ) 1000 (an integer interpreted as milliseconds) (1000) (a literal value) Calls to that take bool can be input as: "true" (a string parsed by ) true (a boolean) 1 (an int where 1 == true and 0 == false)

Thrown when an invalid name is specified. Thrown when an invalid is specified for the given . The option name. See the on properties for valid option names. The value.

Checks that all config values are within specified min/max ranges.

Clones (makes a copy) of this instance.

A copy of this object.

Deadline for establishing TCP connections. Default: 1s

Deadline for network reads. Range: 100ms-5m Default: 60s

Deadline for network writes. Range: 100ms-5m Default: 10s

Duration between polling lookupd for new producers. NOTE: when not using nsqlookupd, LookupdPollInterval represents the duration of time between reconnection attempts. Range: 10ms-5m Default: 60s

Fractional jitter to add to the lookupd pool loop. This helps evenly distribute requests even if multiple consumers restart at the same time. Range: 0-1 Default: 0.3

Maximum duration when REQueueing (for doubling of deferred requeue). Does not limit of manual requeue delays. Range: 0-60m Default: 15m

Default requeue delay. Requeue calculation: * . Range: 0-60m Default: 90s

Backoff strategy, defaults to . Overwrite this to define alternative backoff algorithms. See also . Supported opt values: 'exponential', 'full_jitter'.

Maximum amount of time to backoff when processing fails. Range: 0-60m Default: 2m

Unit of time for calculating consumer backoff. Default backoff calculation: * (2 ^ backoff counter). Will not exceed . See: Range: 0-60m Default: 1s

Maximum number of times this consumer will attempt to process a message before giving up. Range: 0-65535 Default: 5

Duration to wait for a message from a producer when in a state where RDY counts are re-distributed (ie. max_in_flight < num_producers). Range: 1s-5m Default: 10s

Duration between redistributing max-in-flight to connections. Range: 1ms-5s Default: 5s

Redistribute RDY counts to active nsqd instances when others are idle. Default: false

ClientID identifier sent to nsqd representing this client. Default: short hostname.

Hostname identifier sent to nsqd representing this client.

UserAgent identifier sent to nsqd representing this client, in the spirit of HTTP Default: NsqSharp/[version].

Duration of time between heartbeats. This must be less than . Default: 30s

Receive a percentage of messages to sample the channel (requires nsqd 0.2.25+). See: https://github.com/bitly/nsq/pull/223 for discussion. Range: 0-99 Default: 0 (disabled, receive all messages)

TLS configuration. Required to use TLS.

Use Deflate compression

Deflate compression level (1-9, default: 6)

Use Snappy compression

Size of the buffer (in bytes) used by nsqd for buffering writes to this connection. Default: 16384

Timeout used by nsqd before flushing buffered writes (set to 0 to disable). Default: 250ms WARNING: configuring clients with an extremely low (< 25ms) output_buffer_timeout has a significant effect on nsqd CPU usage (particularly with > 50 clients connected).

Maximum number of messages to allow in flight (concurrency knob). Min: 0 Default: 1

The duration the server waits before auto-requeing a message sent to this client. Default = Use server settings (server default = 60s).

Secret for nsqd authentication (requires nsqd 0.2.29+). See: https://github.com/bitly/nsq/pull/356, https://github.com/jehiah/nsqauth-contrib.

Producer is a high-level type to publish to NSQ. A Producer instance is 1:1 with a destination nsqd and will lazily connect to that instance (and re-connect) when Publish commands are executed.

Initializes a new instance of the Producer class.

The nsqd address.

Initializes a new instance of the Producer class.

The nsqd address. The config. After Config is passed in the values are no longer mutable (they are copied).

Initializes a new instance of the Producer class.

The nsqd address. The logger. Default = ().

Initializes a new instance of the Producer class.

The nsqd address. The logger. Default = (). The config. Values are copied, changing the properties on after the constructor is called will have no effect on the .

Returns the address of the Producer.

The address of the Producer.

Stop initiates a graceful stop of the Producer (permanent). NOTE: this blocks until completion

Publishes a message to the specified but does not wait for the response from nsqd. When the Producer eventually receives the response from nsqd, the Task will return a instance with the supplied and the response error if present.

The topic to publish to. The message body. A variable-length parameters list containing arguments. These arguments will be returned on . A Task<ProducerResponse> which can be awaited.

Publishes a string message to the specified but does not wait for the response from nsqd. When the Producer eventually receives the response from nsqd, the Task will return a instance with the supplied and the response error if present.

The topic to publish to. The message body. A variable-length parameters list containing arguments. These arguments will be returned on . A Task<ProducerResponse> which can be awaited.

Publishes a collection of message to the specified but does not wait for the response from nsqd. When the Producer eventually receives the response from nsqd, the Task will return a instance with the supplied and the response error if present.

The topic to publish to. The collection of message bodies. A variable-length parameters list containing arguments. These arguments will be returned on . A Task<ProducerResponse> which can be awaited.

Synchronously publishes a message to the specified , throwing an exception if publish failed.

The topic to publish to. The message body.

Synchronously publishes string message to the specified , throwing an exception if publish failed.

The topic to publish to. The message body.

Synchronously publishes a collection of message to the specified , throwing an exception if publish failed.

The topic to publish to. The collection of message bodies.

Connects to nsqd. Calling this method is optional; otherwise, Connect will be lazy invoked when Publish is called.

Thrown if the Producer has been stopped. Thrown if the Producer is currently waiting to close and reconnect.

ProducerResponse is returned by the async publish methods to retrieve metadata about the command after the response is received.

the error (or nil) of the publish command

the slice of variadic arguments passed to PublishAsync or MultiPublishAsync

extension methods.

UnixNano returns t as a Unix time, the number of nanoseconds elapsed since January 1, 1970 UTC. The result is undefined if the Unix time in nanoseconds cannot be represented by an int64. Note that this means the result of calling UnixNano on the zero Time is undefined.

Unix returns t as a Unix time, the number of seconds elapsed since January 1, 1970 UTC.

extension methods.

Coerce a value to the specified type . Supports Duration and Bool string/int formats.

The target type. The value to coerce. The value as type .

Coerce a value to the specified . Supports Duration and Bool string/int formats.

The value to coerce. The target type. The value as the .

extension methods.

Coerce a value to the specified . Supports Duration and Bool string/int formats.

The to throw in the exception if coerce fails. The value to coerce. The target type. The value as the .

extension methods.

Gets the specified attribute of type .

The attribute type. The . The attribute, or null.

extension methods.

Gets a cryptographically secure double in [0,1).

The . A cryptographically secure double.

Intn returns, as an int, a non-negative cryptographically secure random number in [0,).

The . The exclusive upper bound. Must be > 0. A cryptographically secure integer in [0,).

Int returns a non-negative cryptographically secure random number.

The . A cryptographically secure integer.

extension methods.

Gets the as nanoseconds.

Go routines

Run a new "goroutine".

The method to execute. The name to assign to the thread (optional).

IConn interface. http://golang.org/pkg/net/#Conn

Close closes the connection.

ITcpConn interface. http://golang.org/pkg/net/#TCPConn

Flush writes all buffered data to the underlying TCP connection

Gets or sets the read timeout.

Gets or sets the write timeout.

Net package. http://golang.org/pkg/net

Dial connects to the address on the named network. Known networks are "tcp" only at this time. Addresses have the form host:port. If host is a literal IPv6 address it must be enclosed in square brackets as in "[::1]:80" or "[ipv6-host%zone]:80". The functions JoinHostPort and SplitHostPort manipulate addresses in this form.

DialTimeout acts like Dial but takes a timeout. The timeout includes name resolution, if required.

Once is an object that will perform exactly one action.

Do calls the function f if and only if Do is being called for the first time for this instance of Once.

OS Package. http://golang.org/pkg/os

Returns the host name

Slice

The type of data stored in the slice

Initializes a new Slice from a string

The string

Initializes a new Slice from an array.

Creates a new slice starting at and going to the end.

The start index. A new slice.

Creates a new slice starting at and going to , exclusive.

The start index. The end index + 1. (ex: Slc(2, 5) returns a new slice of length 3 going from index 2 to 4) A new slice.

Returns the string if the slice is of type Slice<char> otherwise, returns a string representing the array.

Returns the slice as an array.

Returns the length of the slice.

Checks if a slice and string are equal.

The first slice. The second slice. true if the slice and string are equal; otherwise, false.

Checks if a slice and string are not equal.

The first slice. The second slice. true if the slice and string are not equal; otherwise, false.

Compares strings and references, otherwise always returns false. This implementation may change.

The object to check equality with. true if the strings or references are equal; otherwise, false.

Default GetHashCode implementation.

Gets the data at the specified index.

The index of the data to return.

A Ticker holds a channel that delivers `ticks' of a clock at intervals. http://golang.org/pkg/time/#Ticker

Initializes a new instance of the Ticker class.

The interval between ticks on the channel.

Stop turns off a ticker. After Stop, no more ticks will be sent. Stop does not close the channel, to prevent a read from the channel succeeding incorrectly. See .

Stops the ticker and closes the channel, exiting the ticker thread. Note: after closing a channel, all reads from the channel will return default(T). See .

The channel on which the ticks are delivered.

Package time provides functionality for measuring and displaying time.

Nanosecond

Microsecond

Millisecond

Second

Minute

Hour

Creates a channel which fires after the specified timeout.

AfterFunc waits for the duration to elapse and then calls f in its own goroutine. It returns a that can be used to cancel the call using its Stop method.

Unix returns the local Time corresponding to the given Unix time, sec seconds and nsec nanoseconds since January 1, 1970 UTC. It is valid to pass nsec outside the range [0, 999999999].

The number of seconds. The number of nanoseconds. The specified in local time.

leadingInt consumes the leading [0-9]* from s.

ParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

The value to parse. The parsed duration.

Converts nanoseconds to .

The type represents a single event. When the expires, the current time will be sent on , unless the was created by .

Creates a new that will send the current time on its channel after at least .

Stop prevents the Timer from firing. It returns true if the call stops the timer, false if the timer has already expired or been stopped. Stop does not close the channel, to prevent a read from the channel succeeding incorrectly.

The channel the Timer will fire on after the duration.

TlsConfig. Minimal implementation of http://golang.org/pkg/crypto/tls/#Config

Initializes a new instance of the TlsConfig class.

Gets the enabled based on .

The enabled .

Minimum TLS version (default = TLS 1.2 for .NET 4.5 and higher, TLS 1.0 for .NET 4.0 and lower).

InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. If InsecureSkipVerify is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man-in-the-middle attacks. This should be used only for testing. Overrides .

Gets or sets a value indicating whether to check certificate revocation (default = true).

true if certificate revocation should be checked, false if not.

A WaitGroup waits for a collection of routines to finish. The main routine calls Add to set the number of routines to wait for. Then each of the routines runs and calls Done when finished. At the same time, Wait can be used to block until all routines have finished. See: http://golang.org/pkg/sync/#WaitGroup

Add adds delta, which may be negative, to the WaitGroup counter. If the counter becomes zero, all goroutines blocked on Wait are released. If the counter goes negative, Add panics. Note that calls with a positive delta that occur when the counter is zero must happen before a Wait. Calls with a negative delta, or calls with a positive delta that start when the counter is greater than zero, may happen at any time. Typically this means the calls to Add should execute before the statement creating the routine or other event to be waited for.

Done decrements the WaitGroup counter.

Wait blocks until the WaitGroup counter is zero.