Command is an encapsulation of a single AMPS command sent by the client. Using Command you can build valid commands to be executed either synchronously or asynchronously via the Client execute() and executeAsync() methods. Command is designed to be used as a "builder" enabling AMPS commands to be built easily, for example: More...

Public Member Functions

string getSOWKeys ()

Returns: the SOW Keys

string getSowKeys ()

Returns: the SOW Keys

Command setSOWKeys (string sowKeys)

The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKeys method on a message. More...

Command setSowKeys (string sowKeys)

The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKeys method on a message. More...

string getSOWKey ()

Returns: the SOW Key

string getSowKey ()

Returns: the SOW Key

Command setSOWKey (string sowKey)

The SowKey for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKey method on a message. More...

Command setSowKey (string sowKey)

The SowKey for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKey method on a message. More...

bool isSubscribe ()

Returns: true if this command is a subscription

bool isSow ()

Returns: true if this command is a sow query

bool needsSequenceNumber ()

Returns: true if this command can be associated with a client sequence number.

Command ()

Create a new Command with no command type or arguments set. More...

Command (Message.Commands command_)

Create a Command with the Command field set. More...

Command (string command_)

Create a Command with the Command field set. More...

Command reset (Message.Commands command_)

Resets this command with a new Command type and re-initializes all other fields. More...

Command reset (string command_)

Resets this command with a new Command type and re-initializes all other fields. More...

CommandId getCommandId ()

Returns: the commandId, which is automatically generated for some command types.

Command setCommandId (CommandId commandId)

Parameters

commandId the commandId to set

CommandId getQueryId ()

Returns: the queryId

Command setQueryId (CommandId queryId)

Parameters

queryId the queryId to set

Message.Commands getCommand ()

Returns: the command

Command setCommand (Message.Commands command)

Parameters

command the command to set

string getTopic ()

Returns: the topic

Command setTopic (string topic)

Parameters

topic the topic to set

Command setTopic (byte[] topic, int offset, int length)

string getFilter ()

Returns: the filter

Command setFilter (string filter)

Parameters

filter the filter to set

string getOrderBy ()

Returns: the orderBy

Command setOrderBy (string orderBy)

Parameters

orderBy the orderBy to set

CommandId getSubId ()

Returns: the subId

Command setSubId (CommandId subId)

Parameters

subId the subId to set

Command setSubId (string subId)

Parameters

subId the subId to set

string getBookmark ()

Returns: the bookmark

Command setBookmark (string bookmark)

Parameters

bookmark the bookmark to set

string getOptions ()

Returns: the options

Command setOptions (string options)

Parameters

options the options to set

Message.AckTypes getAckType ()

Returns: the ackType

Command setAckType (Message.AckTypes ackType)

Parameters

ackType the ackType to set

Command addAckType (Message.AckTypes ackType)

Adds an additional ackType to the ackTypes already set for this Command. More...

string getData ()

Returns: the data

Command setData (string data)

Parameters

data	the data to set

Command setData (byte[] data, int offset, int length)

Command setData (CompositeMessageBuilder builder)

Set the data for this command. More...

long getTimeout ()

Returns: the timeout

Command setTimeout (long timeout)

Parameters

timeout the timeout to set

int getTopN ()

Returns: the topN

Command setTopN (int topN)

Parameters

topN	the topN to set

int getBatchSize ()

Returns: the batchSize

Command setBatchSize (int batchSize)

Parameters

batchSize the batchSize to set

int getExpiration ()

Returns: the expiration. Use hasExpiration() to check if an expiration is set.

bool hasExpiration ()

Returns: true if an expiration is set.

Command setExpiration (int expiration)

Parameters

expiration the expiration to set

void unsetExpiration ()

Clears any expiration value set on self.

Command setClientSequenceNumber (ulong seqNumber)

ulong getClientSequenceNumber ()

Returns: the client sequence number generated for this command, or 0 if none was generated.

Command setCorrelationId (String correlationId_)

String getCorrelationId ()

Detailed Description

Command is an encapsulation of a single AMPS command sent by the client. Using Command you can build valid commands to be executed either synchronously or asynchronously via the Client execute() and executeAsync() methods. Command is designed to be used as a "builder" enabling AMPS commands to be built easily, for example:


Client client = new Client(...);
for(Message m : client.execute(new Command("sow").setTopic("topic"))) { ... }

Constructor & Destructor Documentation

◆ Command() [1/3]

AMPS.Client.Command.Command ( )

inline

Create a new Command with no command type or arguments set.

◆ Command() [2/3]

AMPS.Client.Command.Command ( Message.Commands command_ )

inline

Create a Command with the Command field set.

Parameters

command_ A Message.Commands value indicating the AMPS command.

◆ Command() [3/3]

AMPS.Client.Command.Command ( string command_ )

inline

Create a Command with the Command field set.

Parameters

command_ A string indicating the AMPS command.

Member Function Documentation

◆ addAckType()

Command AMPS.Client.Command.addAckType ( Message.AckTypes ackType )

inline

Adds an additional ackType to the ackTypes already set for this Command.

Parameters

ackType the ackType to add

◆ reset() [1/2]

Command AMPS.Client.Command.reset ( Message.Commands command_ )

inline

Resets this command with a new Command type and re-initializes all other fields.

Parameters

command_ A Message.Commands value indicating the AMPS command.

◆ reset() [2/2]

Command AMPS.Client.Command.reset ( string command_ )

inline

Resets this command with a new Command type and re-initializes all other fields.

Parameters

command_ A string value indicating the AMPS command.

◆ setData() [1/2]

Command AMPS.Client.Command.setData	(	byte[]	data,
		int	offset,
		int	length
	)

inline

Parameters

data	The raw bytes to be used for the data.
offset	The offset into data where the data begins.
length	The length of the data.

◆ setData() [2/2]

Command AMPS.Client.Command.setData ( CompositeMessageBuilder builder )

inline

Set the data for this command.

Parameters

builder A CompositeMessageBuilder to set self's data from.

◆ setSOWKey()

Command AMPS.Client.Command.setSOWKey ( string sowKey )

inline

The SowKey for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKey method on a message.

Parameters

sowKey the sow keys to set

◆ setSowKey()

Command AMPS.Client.Command.setSowKey ( string sowKey )

inline

The SowKey for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKey method on a message.

Parameters

sowKey the sow keys to set

◆ setSOWKeys()

Command AMPS.Client.Command.setSOWKeys ( string sowKeys )

inline

The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKeys method on a message.

Parameters

sowKeys the sow keys to set

◆ setSowKeys()

Command AMPS.Client.Command.setSowKeys ( string sowKeys )

inline

The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message#getSowKeys method on a message.

Parameters

sowKeys the sow keys to set

◆ setTopic()

Command AMPS.Client.Command.setTopic	(	byte[]	topic,
		int	offset,
		int	length
	)

inline

Parameters

topic	The raw bytes to be used for the topic.
offset	The offset into topic where the topic data begins
length	The length of the topic.

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

AMPS.Client/Command.cs