Represents the possible values for message options in an AMPS command. Options in a message are combined in to a comma-delimited list. Each of these option values is comma-terminated, so they can be easily combined by simple string concatenation. More...

Static Public Member Functions
static string	Conflation (String conflation)
	Formats the More...

static string	ConflationKey (String conflationKey)
	Formats the More...

static string	MaxBacklog (int maxBacklog)
	Formats the More...

static string	TopN (int topN)
	Formats the More...

static string	Rate (String rate)
	Formats the More...

static string	RateMaxGap (String rateMaxGap)
	Formats the More...

static string	Select (String selectList)
	Formats the More...

static string	Select (IEnumerable< String > selectList)
	Formats the More...

static string	SkipN (int skipN)
	Formats the More...

static string	Projection (String projection)
	Formats the More...

static string	Projection (IEnumerable< String > projections)
	Formats the More...

static string	Grouping (String grouping)
	Formats the More...

static string	Grouping (IEnumerable< String > groupings)
	Formats the More...

static string	AckConflationInterval (String interval)
	Formats the More...

static string	BookmarkNotFound (String action)
	Formats the More...

Static Public Attributes
const string	None = null

const string	Live = "live,"
	Constant string for the More...

const string	OOF = "oof,"
	Constant string for the More...

const string	Replace = "replace,"
	Constant string for the More...

const string	NoEmpties = "no_empties,"
	Constant string for the More...

const string	SendKeys = "send_keys,"
	Constant string for the More...

const string	Timestamp = "timestamp,"
	Constant string for the More...

const string	NoSowKey = "no_sowkey,"
	Constant string for the More...

const string	Cancel = "cancel,"
	Constant string for the <codecancel option, used when acknowledging ( More...

const string	Expire = "expire,"
	Constant string for the More...

const string	Resume = "resume,"
	Constant string for the More...

const string	Pause = "pause,"
	Constant string for the More...

const string	FullyDurable = "fully_durable,"
	Constant string for the More...

static string	BookmarkNotFoundNow = "bookmark_not_found=now,"

static string	BookmarkNotFoundEpoch = "bookmark_not_found=epoch,"

static string	BookmarkNotFoundFail = "bookmark_not_found=fail,"

Detailed Description

Represents the possible values for message options in an AMPS command. Options in a message are combined in to a comma-delimited list. Each of these option values is comma-terminated, so they can be easily combined by simple string concatenation.

For options that take a list of parameters, this class provides convenience constructors to format the list. AMPS.Client.Command::getOptions() AMPS.Client.Command::setOptions(string) AMPS.Client.Message::getOptions() AMPS.Client.Message::setOptions(string)

Member Function Documentation

◆ AckConflationInterval()

static string AMPS.Client.Message.Options.AckConflationInterval ( String interval )

inlinestatic

Formats the

ack_conflation interval for a logon command. This option can be used to request that, for this connection, the server return persisted acknowledgements for publishes more frequently than the default 1s interval. Notice that, if the server replicates messages to other destinations, the effective conflation interval may depend on the replication configuration of this server and the replication configuration of the destinations that this server replicates to: AMPS will not provide a persisted acknowledgment for a message that has not been properly acknowledged by the applicable replication destinations. This option is only valid on a logon command.

Parameters

interval The interval at which to conflate persisted publish acknowledgements for this connection.

Returns

The formatted value.

Returns

◆ BookmarkNotFound()

static string AMPS.Client.Message.Options.BookmarkNotFound ( String action )

inlinestatic

Formats the

bookmark_not_found option for a bookmark subscription. This option is used to tell the server what to do if the requested start bookmark is not found in the transaction log. Allowed values for action parameter: now: This is the default behavior which starts the subscription with no replay. epoch: Start the subscription at the oldest message in the transaction log. fail: Return a failure ack to the client and don't start a subscription.

Parameters

action One of the above strings.

Returns

The formatted value.

Returns

◆ Conflation()

static string AMPS.Client.Message.Options.Conflation ( String conflation )

inlinestatic

Formats the

conflation option for a command. This option can be used with subscriptions to topics in the State-of-the-World to request that AMPS conflate publishes to the same record. This can reduce bandwidth and processing requirements for the the subscriber. If a large number of subscribers will use the same conflation setting for the same topic, consider configuring a ConflatedTopic on the server. See the AMPS User Guide for details.

Parameters

conflation The conflation interval.

Returns: The formatted value.

◆ ConflationKey()

static string AMPS.Client.Message.Options.ConflationKey ( String conflationKey )

inlinestatic

Formats the

conflation_key option for a command

that uses the conflation option. This option can be used with subscriptions to topics in the State-of-the-World to request that AMPS conflate po messages with a common value for a field or set of fields that is not the key for the topic. This option must be used with the conflation option.

Parameters

conflationKey The field or fields to use as a conflation key.

Returns: The formatted value.

◆ Grouping() [1/2]

static string AMPS.Client.Message.Options.Grouping ( IEnumerable< String > groupings )

inlinestatic

Formats the

grouping option for an aggregated subscription, which specifies how to determine which records to aggregate together. When this option is provided, a projection option must also be provided. This overload of the method expects a System.Collections.Generic.IEnumerable<T> that contains individual fields. This method formats the contents of the Iterable into a comma-delimited list. See the AMPS User Guide for details.

Parameters

groupings The list of fields to group by.

Returns: The formatted value.

◆ Grouping() [2/2]

static string AMPS.Client.Message.Options.Grouping ( String grouping )

inlinestatic

Formats the

grouping option for an aggregated subscription, which specifies how to determine which records to aggregate together. When this option is provided, a projection option must also be provided. This overload of the method expects a String that contains a comma-delimited list of fields to group by. See the AMPS User Guide for details.

Parameters

grouping The fields to group by.

Returns: The formatted value.

◆ MaxBacklog()

static string AMPS.Client.Message.Options.MaxBacklog ( int maxBacklog )

inlinestatic

Formats the

max_backlog option for a command, used when subscribing to a queue. When consuming from a queue, this option sets the maximum number of messages the client is willing to have outstanding at a given time. (The actual number of messages provided is determined by both this parameter and the server configuration.) See the AMPS User Guide and the AMPS Command Reference for details.

Parameters

maxBacklog The maximum number of messages to provide to this subscription at a given time.

Returns: The formatted value.

◆ Projection() [1/2]

static string AMPS.Client.Message.Options.Projection ( IEnumerable< String > projections )

inlinestatic

Formats the

projection option for an aggregated subscription, which specifies the fields produced by the aggregation. When this option is provided, a grouping option must also be provided. This overload of the method expects a System.Collections.Generic.IEnumerable<T> that contains individual field projections. The method formats the field projections into a comma-delimited list. See the AMPS User Guide for details.

Parameters

projections A list of fields to produce

Returns: The formatted value.

◆ Projection() [2/2]

static string AMPS.Client.Message.Options.Projection ( String projection )

inlinestatic

Formats the

projection option for an aggregated subscription, which specifies the fields produced by the aggregation. When this option is provided, a grouping option must also be provided. This overload of the method expects a string that contains a comma-delimited list of projections. See the AMPS User Guide for details.

Parameters

projection The fields to produce.

Returns: The formatted value.

◆ Rate()

static string AMPS.Client.Message.Options.Rate ( String rate )

inlinestatic

Formats the

rate option for a command, used to slow down the rate of a bookmark replay. When used with a bookmark replay, this option directs AMPS to slow down the replay to approximately the rate specified. See the AMPS Command Reference for details.

Parameters

rate	The requested rate limit for the bookmark replay.

Returns: The formatted value.

◆ RateMaxGap()

static string AMPS.Client.Message.Options.RateMaxGap ( String rateMaxGap )

inlinestatic

Formats the

rate_max_gap option for a command, which can be used when a bookmark replay specifies a relative rate. When used with a bookmark replay that specifies a relative rate (for example, that the replay should be slowed down to no more than 2X the original publish rate), this option sets the maximum amount of time for the replay to go without producing a message. See the AMPS User Guide for details.

Parameters

rateMaxGap The maximum amount of time without producing a message.

Returns: The formatted value.

◆ Select() [1/2]

static string AMPS.Client.Message.Options.Select ( IEnumerable< String > selectList )

inlinestatic

Formats the

select

option for a subscription or SOW query, which specifies the fields produced in the delivered messages. This overload of the method expects a System.Collections.Generic.IEnumerable<T> that contains individual field directives. The method formats the field directives into a comma-delimited list. See the AMPS User Guide for details.

Parameters

selectList A list of fields to produce.

Returns: The formatted value.

◆ Select() [2/2]

static string AMPS.Client.Message.Options.Select ( String selectList )

inlinestatic

Formats the

select option for a subscription or SOW query, which specifies the fields produced in the delivered messages. This overload of the method expects a string that contains a comma-delimited list of field directives. See the AMPS User Guide for details.

Parameters

selectList The list of fields to produce.

Returns: The formatted value.

◆ SkipN()

static string AMPS.Client.Message.Options.SkipN ( int skipN )

inlinestatic

Formats the

skip_n

option for a sow or sow_and_subscribe command. When this option is provided, AMPS will skip the specified number of messages before returning the top_n records specified. See the AMPS Command Reference and the Developer Guide for details.

Parameters

skipN The number of results to skip before beginning to return results

Returns: The formatted value.

◆ TopN()

static string AMPS.Client.Message.Options.TopN ( int topN )

inlinestatic

Formats the

top_n option for a command. When this option is specified, AMPS will return thespecified number of messages from the results See the AMPS Command Reference for details.

Parameters

topN	The number of messages to return from the result set.

Returns: The formatted value.

Member Data Documentation

◆ Cancel

const string AMPS.Client.Message.Options.Cancel = "cancel,"

static

Constant string for the <codecancel option, used when acknowledging (

sow_delete ) a leased message to return the message to the queue rather than acknowledgin the messsage as processed. </summary

◆ Expire

const string AMPS.Client.Message.Options.Expire = "expire,"

static

Constant string for the

expire option, used when acknowledging (sow_delete) a leased message to immediately expire the message from the queue rather than acknowledging the message as processed.

◆ FullyDurable

const string AMPS.Client.Message.Options.FullyDurable = "fully_durable,"

static

Constant string for the

fully_durable option. This option specifies that a message will not be provided to a bookmark replay until it has been acknowledged as persisted by all synchronous replication destinations. The option is used to provide increased repeatability of bookmark subscriptions, although it may increase the latency for current publishes to be delivered to the subscriber.

◆ Live

const string AMPS.Client.Message.Options.Live = "live,"

static

Constant string for the

Live option. Requests that a bookmark subscription should receive messages before they are written to the transaction log once replay is complete. This could potentially slightly reduce latency in some configurations, although subscriptions using this option increase the risk of inconsistent data in failover situations.

◆ NoEmpties

const string AMPS.Client.Message.Options.NoEmpties = "no_empties,"

static

Constant string for the

no_empties option. When used with a delta subscription, this option specifies that AMPS will not create a message to this subscription when a publish happens that does not change the value of any field in the message.

◆ NoSowKey

const string AMPS.Client.Message.Options.NoSowKey = "no_sowkey,"

static

Constant string for the

no_sow_key option. When specified on a command, AMPS will not provide the SOW key field on messages provided in response to the command.

◆ OOF

const string AMPS.Client.Message.Options.OOF = "oof,"

static

Constant string for the

oof (out of focus) option. When used with a subscription, the oof option requests notification messages when a message that previously matched the subscription no longer matches the subscription.

◆ Pause

const string AMPS.Client.Message.Options.Pause = "pause,"

static

Constant string for the

pause option. This option is used to group bookmark subscriptions so that a set of independent subscriptions can be started simultaneously and proceed through replay together, typically used for testing or auditing purposes. See the AMPS User Guide for details.

◆ Replace

const string AMPS.Client.Message.Options.Replace = "replace,"

static

Constant string for the

replace option. When this option is provided on a command, AMPS updates the existing subscription specified in the

SubId

for the command rather than creating a new subscription. See the AMPS User Guide for details.

◆ Resume

const string AMPS.Client.Message.Options.Resume = "resume,"

static

Constant string for the

resume option. This option is to start a set of bookmark subscriptions that have been entered in a paused state. See the AMPS User Guide for details.

◆ SendKeys

const string AMPS.Client.Message.Options.SendKeys = "send_keys,"

static

Constant string for the

send_keys option. This option is the current server default, and does not need to be specified. When set, AMPS provides the key fields for a message along with changed fields in messages to a delta subscription.

◆ Timestamp

const string AMPS.Client.Message.Options.Timestamp = "timestamp,"

static

Constant string for the

timestamp option. When specified on a command, AMPS will include the timestamp header on data messages sent in response to that command.

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

AMPS.Client/Message.cs

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ AckConflationInterval()

◆ BookmarkNotFound()

◆ Conflation()

◆ ConflationKey()

◆ Grouping() [1/2]

◆ Grouping() [2/2]

◆ MaxBacklog()

◆ Projection() [1/2]

◆ Projection() [2/2]

◆ Rate()

◆ RateMaxGap()

◆ Select() [1/2]

◆ Select() [2/2]

◆ SkipN()

◆ TopN()

Member Data Documentation

◆ Cancel

◆ Expire

◆ FullyDurable

◆ Live

◆ NoEmpties

◆ NoSowKey

◆ OOF

◆ Pause

◆ Replace

◆ Resume

◆ SendKeys

◆ Timestamp