NATS Streaming .NET Client  0.1.5
The nats.io .NET Streaming C# Client
Public Member Functions | Static Public Member Functions | Properties | List of all members
STAN.Client.StanSubscriptionOptions Class Reference

Public Member Functions

void StartAt (ulong sequence)
 
void StartAt (DateTime time)
 
void StartAt (TimeSpan duration)
 
void StartWithLastReceived ()
 
void DeliverAllAvailable ()
 

Static Public Member Functions

static StanSubscriptionOptions GetDefaultOptions ()
 

Properties

string DurableName [get, set]
 
int MaxInflight [get, set]
 
int AckWait [get, set]
 
bool ManualAcks [get, set]
 
bool LeaveOpen [get, set]
 

Detailed Description

The StanSubsciption options class represents various options available to configure a subscription to a subject on the NATS streaming server.

Member Function Documentation

◆ DeliverAllAvailable()

void STAN.Client.StanSubscriptionOptions.DeliverAllAvailable ( )

Deliver all messages available.

◆ GetDefaultOptions()

static StanSubscriptionOptions STAN.Client.StanSubscriptionOptions.GetDefaultOptions ( )
static

Returns a copy of the default subscription options.

Returns

◆ StartAt() [1/3]

void STAN.Client.StanSubscriptionOptions.StartAt ( ulong  sequence)

Optional start sequence number.

Parameters
sequence

◆ StartAt() [2/3]

void STAN.Client.StanSubscriptionOptions.StartAt ( DateTime  time)

Optional start time. UTC is recommended although a local time will be converted to UTC.

Parameters
time

◆ StartAt() [3/3]

void STAN.Client.StanSubscriptionOptions.StartAt ( TimeSpan  duration)

Optional start at time delta.

Parameters
duration

◆ StartWithLastReceived()

void STAN.Client.StanSubscriptionOptions.StartWithLastReceived ( )

Start with the last received message.

Property Documentation

◆ AckWait

int STAN.Client.StanSubscriptionOptions.AckWait
getset

Controls the time the cluster will wait for an ACK for a given message in milliseconds.

The value must be at least one second.

◆ DurableName

string STAN.Client.StanSubscriptionOptions.DurableName
getset

DurableName, if set will survive client restarts.

◆ LeaveOpen

bool STAN.Client.StanSubscriptionOptions.LeaveOpen
getset

Do Close() on Disposing subscription if true, or Unsubscribe(). If you want to resume subscription with durable name, set true.

If Close() or Unsubscribe() is called before Disposing, this flag has no effect

◆ ManualAcks

bool STAN.Client.StanSubscriptionOptions.ManualAcks
getset

Controls the time the cluster will wait for an ACK for a given message.

◆ MaxInflight

int STAN.Client.StanSubscriptionOptions.MaxInflight
getset

Controls the number of messages the cluster will have inflight without an ACK.

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