STAN.Client.StanOptions Class Reference

Static Public Member Functions
static StanOptions	GetDefaultOptions ()

Properties
string	NatsURL [get, set]
IConnection	NatsConn [set]
int	ConnectTimeout [get, set]
long	PubAckWait [get, set]
string	DiscoverPrefix [get, set]
long	MaxPubAcksInFlight [get, set]
int	PingMaxOutstanding [get, set]
int	PingInterval [get, set]
EventHandler< StanConnLostHandlerArgs >	ConnectionLostEventHandler [get, set]

Detailed Description

Options available to configure a connection to the NATS streaming server.

Member Function Documentation

GetDefaultOptions()

static StanOptions STAN.Client.StanOptions.GetDefaultOptions ( )

static

Returns the default connection options.

Returns

Property Documentation

ConnectionLostEventHandler

EventHandler<StanConnLostHandlerArgs> STAN.Client.StanOptions.ConnectionLostEventHandler

getset

Represents the method that will handle an event raised when a connection has been disconnected from a streaming server.

ConnectTimeout

int STAN.Client.StanOptions.ConnectTimeout

getset

ConnectTimeout is an Option to set the timeout for establishing a connection in milliseconds.

DiscoverPrefix

string STAN.Client.StanOptions.DiscoverPrefix

getset

Sets the discover prefix used in connecting to the NATS streaming server. This must match the settings on the NATS streaming sever.

MaxPubAcksInFlight

long STAN.Client.StanOptions.MaxPubAcksInFlight

getset

MaxPubAcksInflight is an Option to set the maximum number of published messages without outstanding ACKs from the server.

NatsConn

IConnection STAN.Client.StanOptions.NatsConn

set

Sets the underlying NATS connection to be used by a NATS Streaming connection object.

NatsURL

string STAN.Client.StanOptions.NatsURL

getset

Gets or sets the url to connect to a NATS server.

PingInterval

int STAN.Client.StanOptions.PingInterval

getset

PingInterval is an option to set the interval of pings in milliseconds. See StanConsts.DefaultPingInterval.

PingMaxOutstanding

int STAN.Client.StanOptions.PingMaxOutstanding

getset

PingMaxOutstanding is an option to set the maximum number of outstanding pings with the streaming server. See StanConsts.DefaultPingMaxOut.

PubAckWait

long STAN.Client.StanOptions.PubAckWait

getset

PubAckWait is an option to set the timeout for waiting for an ACK for a published message in milliseconds. The value must be greater than zero.

---

The documentation for this class was generated from the following file:

• Options.cs