Client (AMPS Java Client (5.3.4.0.14fbce6f.256885))

java.lang.Object
- com.crankuptheamps.client.Client

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

HAClient
```
public class Client
extends java.lang.Object
implements java.lang.AutoCloseable
```
The base AMPS client object used for AMPS applications that do not need a resilient connection to AMPS. Most production applications use the HAClient rather than Client. Each client object manages a single connection to AMPS. Each AMPS connection has a name, a specific transport (such as tcp), a protocol (used for framing messages to AMPS), and a message type (such as FIX or JSON).
The Client object creates and manages background threads. The object provides both a synchronous interface for processing messages on the calling thread and an asynchronous interface suitable for populating a queue to be processed by worker threads.
The Client provides named convenience methods for many AMPS commands. These methods provide control over commonly used parameters and support most programs. For full control over AMPS, you build a Command object and use execute(com.crankuptheamps.client.Command) or executeAsync(com.crankuptheamps.client.Command, com.crankuptheamps.client.MessageHandler) to run the command.
AMPS uses the client name to detect duplicate messages, so the name of each instance of the client application should be unique.
An example of a simple Java program publishing the JSON message { "message" : "Hello, World!"} is listed below.
```
 
    public static void main(String[] args) {
    Client client = new Client("ConsolePublisher");

   try
   {
     client.connect("tcp://127.0.0.1:9007/amps");
     System.out.println("connected..");
     client.logon();
 
     client.publish("messages", "{\"message\" : \"Hello, World!\"}");

     System.exit(0);
    }
   catch (AMPSException e)
   {
     System.err.println(e.getLocalizedMessage());
     e.printStackTrace(System.err);
   }

  }
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Client.Bookmarks` Provides constants for special bookmark values.
`protected class`	`Client.ClientHandler`
`static class`	`Client.GlobalCommandTypeHandlers` Specifies a type of message that is always sent to an associated handler when one is set.
`static class`	`Client.Version` Class that holds supported versions of AMPS, those are: AMPS version 3, AMPS version 4 and AMPS version 5.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_lastFailedConnectionVersion`
`protected java.beans.ExceptionListener`	`exceptionListener`
`protected java.util.concurrent.locks.Lock`	`lock`
`static int`	`MIN_MULTI_BOOKMARK_VERSION`
`static int`	`MIN_PERSISTED_BOOKMARK_VERSION`

Constructor Summary

Constructors
Constructor and Description
`Client()` Default constructor that creates a client without a name.
`Client(java.lang.String name)` Creates a client.
`Client(java.lang.String name, int version)` Creates a client.
`Client(java.lang.String name, Transport transport)` Creates a client with a transport.
`Client(java.lang.String name, Transport transport, int version)` Creates a client with a transport

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`_ack(byte[] topic, int topicPos, int topicLen, byte[] bookmark, int bookmarkPos, int bookmarkLen, byte[] options, int optionsPos, int optionsLen)`
`protected void`	`_ack(Field topic, Field bookmark)` Used internally for autoacking and by Message.
`protected void`	`_ack(Field topic, Field bookmark, Field options)` Used internally for autoacking and by Message.
`void`	`ack(byte[] topic, int topicPos, int topicLen, byte[] bookmark, int bookmarkPos, int bookmarkLen)` ACKs a message from a message queue with a byte-array topic and bookmark
`void`	`ack(byte[] topic, int topicPos, int topicLen, byte[] bookmark, int bookmarkPos, int bookmarkLen, byte[] options, int optionsPos, int optionsLen)` ACKs a message from a message queue with a byte-array topic and bookmark
`void`	`ack(Field topic, Field bookmark)` ACKs a message queue message using `Field` objects from a message.
`void`	`ack(Field topic, Field bookmark, Field options)` ACKs a message queue message using `Field` objects from a message.
`void`	`ack(java.lang.String topic, java.lang.String bookmark)` ACKs a message queue message.
`void`	`ack(java.lang.String topic, java.lang.String bookmark, java.lang.String options)` ACKs a message queue message.
`void`	`addConnectionStateListener(ConnectionStateListener listener_)` Adds a `ConnectionStateListener` instance that will be invoked when this client connects or disconnects.
`void`	`addHttpPreflightHeader(java.lang.String header)` Add a new header to the list of HTTP preflight headers.
`void`	`addHttpPreflightHeader(java.lang.String key, java.lang.String value)` Add a new key/value pair to the list of HTTP preflight headers.
`void`	`addMessageHandler(CommandId commandId_, MessageHandler messageHandler_, int requestedAcks_, boolean isSubscribe_)` Adds a MessageHandler for a given CommandId to self.
`Message`	`allocateMessage()` Creates a new `Message` appropriate for this client.
`CommandId`	`bookmarkSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, CommandId subId, java.lang.String bookmark, java.lang.String options, long timeout)` Places a bookmark subscription with AMPS.
`protected void`	`broadcastConnectionStateChanged(int newState_)` This method is responsible for broadcasting changes in the connection state to all registered ConnectionStateListener objects.
`void`	`clearHttpPreflightHeaders()` Clear the list of HTTP preflight headers.
`void`	`close()` Disconnect from the AMPS server.
`void`	`connect(java.lang.String uri)` Connects to the AMPS instance through the provided URI.
`long`	`deltaPublish(byte[] topic, int topicOffset, int topicLength, byte[] data, int dataOffset, int dataLength)` Delta publish a message to an AMPS topic.
`long`	`deltaPublish(byte[] topic, int topicOffset, int topicLength, byte[] data, int dataOffset, int dataLength, int expiration)` Delta publish a message to an AMPS topic.
`long`	`deltaPublish(java.lang.String topic, java.lang.String data)` Delta publish a message to an AMPS topic.
`long`	`deltaPublish(java.lang.String topic, java.lang.String data, int expiration)` Delta publish a message to an AMPS topic.
`CommandId`	`deltaSubscribe(MessageHandler messageHandler, java.lang.String topic, long timeout)` Places a delta subscription with AMPS.
`CommandId`	`deltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, long timeout)` Places a delta subscription with AMPS.
`CommandId`	`deltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String options, long timeout)` Places a delta subscription with AMPS.
`CommandId`	`deltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String options, long timeout, java.lang.String subId)` Places a delta subscription with AMPS.
`void`	`disconnect()` Disconnect from the AMPS server.
`MessageStream`	`execute(Command command)` Execute the provided command and return messages received in response in a `MessageStream`.
`CommandId`	`executeAsync(Command command, MessageHandler handler)` Execute the provided command and process responses on the client receive thread using the provided handler.
`long`	`flush()` Deprecated. As of 5.3.0.0. Use (@link #publishFlush) instead. Clear the queued messages which may be waiting in the transport. This is a no-op.
`long`	`flush(long timeout)` Deprecated. As of 5.3.0.0. Use (@link #publishFlush) instead. Clear the queued messages which may be waiting in the transport. This is a no-op.
`void`	`flushAcks()` Send the current set of queue acknowledgements ("sow_delete" with the message bookmark) to the AMPS server.
`int`	`getAckBatchSize()` Returns the current ACK batch size.
`long`	`getAckTimeout()` Returns the current queue ack timeout in milliseconds.
`boolean`	`getAutoAck()` Returns the current setting of auto-acking.
`BookmarkStore`	`getBookmarkStore()` Returns the underlying bookmark store for this client.
`ConnectionInfo`	`getConnectionInfo()` Assembles a new ConnectionInfo with the state of this client and associated classes at the point in time this is called.
`int`	`getDefaultMaxDepth()` Gets the currently set default value for the max depth of `MessageStream` instances created by this client.
`ClientDisconnectHandler`	`getDisconnectHandler()` Returns the current `ClientDisconnectHandler` set on self.
`MessageHandler`	`getDuplicateMessageHandler()` Returns the `MessageHandler` instance used for duplicate messages.
`java.beans.ExceptionListener`	`getExceptionListener()` Returns the `ExceptionListener` instance used for communicating absorbed exceptions.
`FailedWriteHandler`	`getFailedWriteHandler()` Returns the `FailedWriteHandler` instance used to report on failed messages that have been written.
`int`	`getHeartbeatInterval()` Returns the heartbeat interval used by the Client.
`java.util.List<java.lang.String>`	`getHttpPreflightHeaders()` Return the list of HTTP preflight headers.
`java.lang.String`	`getLogonCorrelationData()` Gets the uninterpreted logon correlation information currently set.
`java.lang.String`	`getName()` Return the name of the Client.
`java.lang.String`	`getNameHash()` Return the name hash of the Client as returned by the server at logon.
`Store`	`getPublishStore()` Returns the underlying publish store for this client.
`int`	`getReadTimeout()` Returns the time (in seconds) to allow silence on the connection before assuming it is dead.
`boolean`	`getRetryOnDisconnect()` Return whether or not messages being sent to the server will retry if the client is disconnected.
`int`	`getServerVersion()` Return the server version retrieved during logon.
`VersionInfo`	`getServerVersionInfo()` Return the server version retrieved during logon.
`SubscriptionManager`	`getSubscriptionManager()` Returns the `SubscriptionManager` instance used for recording active subscriptions.
`ThreadCreatedHandler`	`getThreadCreatedHandler()` Get the handler that is invoked immediately by any thread created by the transport.
`Transport`	`getTransport()` Return the underlying transport.
`protected TransportDisconnectHandler`	`getTransportDisconnectHandler()`
`TransportFilter`	`getTransportFilter()` Get the filter that is used by the Client's transport for all incoming and outgoing messages.
`protected MessageHandler`	`getTransportMessageHandler()`
`java.net.URI`	`getURI()` Return the URI the Client is connected to.
`static java.lang.String`	`getVersion()` Return the build number for the client that is stored in the Manifest.mf of the jar file.
`static int`	`getVersionAsInt(java.lang.String version)` Deprecated.
`CommandId`	`logon()` Logs into AMPS with the parameters provided in the connect method.
`CommandId`	`logon(long timeout)` Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
`CommandId`	`logon(long timeout, Authenticator authenticator)` Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
`CommandId`	`logon(long timeout, Authenticator authenticator, java.lang.String options)` Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
`CommandId`	`logon(long timeout, java.lang.String options)` Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
`CommandId`	`logon(java.lang.String options)` Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
`long`	`publish(byte[] topic, int topicOffset, int topicLength, byte[] data, int dataOffset, int dataLength)` Publish a message to an AMPS topic.
`long`	`publish(byte[] topic, int topicOffset, int topicLength, byte[] data, int dataOffset, int dataLength, int expiration)` Publish a message to an AMPS topic.
`long`	`publish(java.lang.String topic, java.lang.String data)` Publish a message to an AMPS topic.
`long`	`publish(java.lang.String topic, java.lang.String data, int expiration)` Publish a message to an AMPS topic.
`void`	`publishFlush()` Ensures that AMPS messages are sent and have been processed by the AMPS server.
`void`	`publishFlush(long timeout)` Ensures that AMPS messages are sent and have been processed by the AMPS server.
`void`	`publishFlush(java.lang.String ackType)` Ensures that AMPS messages are sent and have been processed by the AMPS server.
`void`	`publishFlush(java.lang.String ackType, long timeout)` Ensures that AMPS messages are sent and have been processed by the AMPS server.
`void`	`removeConnectionStateListener(ConnectionStateListener listener_)` Removes a `ConnectionStateListener` from being invoked when this client connects or disconnects.
`boolean`	`removeMessageHandler(CommandId commandId_)` Remove a MessageHandler for a given CommandId from self.
`void`	`send(Message message)` Send a `Message` to AMPS via the `Transport` used in the Client.
`CommandId`	`send(MessageHandler messageHandler, Message message, long timeout)` Send a `Message` to AMPS and register the messageHandler for any messages resulting from the command execution.
`void`	`setAckBatchSize(int batchSize)` Sets the current ACK batch size.
`void`	`setAckTimeout(long ackTimeout)` Sets the ack timeout -- the maximum time to let a success ack be cached before sending.
`void`	`setAutoAck(boolean isAutoAckEnabled)` Enables or disables auto-acking.
`void`	`setBookmarkStore(BookmarkStore val)` Sets the underlying bookmark store, which is used to track which messages the client has received and which messages have been processed by the program.
`void`	`setDefaultMaxDepth(int md)` Sets the default value used for the max depth of `MessageStream` instances created by this client.
`void`	`setDisconnectHandler(ClientDisconnectHandler disconnectHandler_)` Sets the `ClientDisconnectHandler`.
`void`	`setDuplicateMessageHandler(MessageHandler messageHandler)` Sets the `MessageHandler` instance used for duplicate messages.
`void`	`setExceptionListener(java.beans.ExceptionListener exceptionListener)` Sets the `ExceptionListener` instance used for communicating absorbed exceptions.
`void`	`setFailedWriteHandler(FailedWriteHandler handler_)` Sets the `FailedWriteHandler` instance used to report on failed messages that have been written.
`void`	`setFailedWriteHandler(FailedWriteHandlerV4 handler_)` Sets the `FailedWriteHandler` instance used to report on failed messages that have been written.
`void`	`setGlobalCommandTypeMessageHandler(Client.GlobalCommandTypeHandlers command, MessageHandler messageHandler)` Sets the `MessageHandler` instance used for all messages of the given command type.
`void`	`setGlobalCommandTypeMessageHandler(int command, MessageHandler messageHandler)` Sets the `MessageHandler` instance used for all messages of the given command type.
`void`	`setGlobalCommandTypeMessageHandler(java.lang.String command, MessageHandler messageHandler)` Sets the `MessageHandler` instance used for all messages of the given command type.
`void`	`setHeartbeat(int intervalSeconds_)` Requests a server heartbeat, and configures the client to close the connection if a heartbeat (or other activity) is not seen on the connection after two heartbeat intervals.
`void`	`setHeartbeat(int intervalSeconds_, int timeoutSeconds_)` Requests a server heartbeat, and configures the client to close the connection if a heartbeat (or other activity) is not seen on the connection.
`void`	`setHttpPreflightHeaders(java.util.List<java.lang.String> headers)` Set the list of HTTP preflight headers replacing any previously set.
`void`	`setLastChanceMessageHandler(MessageHandler messageHandler)` Sets the `MessageHandler` instance used when no other handler matches.
`void`	`setLogonCorrelationData(java.lang.String correlationData)` Sets the uninterpreted logon correlation information a client sends at logon to aid in searching server log files for specific clients.
`void`	`setName(java.lang.String name)` This method MUST be called to assign a unique client name before connecting to an AMPS server when the client was constructed using the default constructor.
`void`	`setPublishStore(Store store)` Sets the underlying publish store, which is used to store published messages until the AMPS instance has acknowledged those messages.
`void`	`setRetryOnDisconnect(boolean isRetryOnDisconnect)` Set whether or not messages being sent to the server should retry if the client is disconnected.
`void`	`setSubscriptionManager(SubscriptionManager subscriptionManager)` Sets the `SubscriptionManager` instance used for recording active subscriptions.
`void`	`setThreadCreatedHandler(ThreadCreatedHandler handler_)` Set a handler that is invoked immediately by any thread created by the transport.
`void`	`setTransportFilter(TransportFilter filter_)` Set a filter that is used by the Client's transport for all incoming and outgoing messages.
`void`	`setUnhandledMessageHandler(MessageHandler messageHandler)` Deprecated. Use `setLastChanceMessageHandler(com.crankuptheamps.client.MessageHandler)` instead.
`CommandId`	`sow(MessageHandler messageHandler, java.lang.String topic, int batchSize, long timeout)` Executes a SOW query.
`CommandId`	`sow(MessageHandler messageHandler, java.lang.String topic, long timeout)` Executes a SOW query.
`CommandId`	`sow(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, long timeout)` Executes a SOW query.
`CommandId`	`sow(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, java.lang.String options, long timeout)` Executes a SOW query.
`CommandId`	`sow(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String orderBy, java.lang.String bookmark, int batchSize, int topN, java.lang.String options, long timeout)` Executes a SOW query.
`MessageStream`	`sow(java.lang.String topic)` Synchronously execute a SOW query.
`MessageStream`	`sow(java.lang.String topic, java.lang.String filter)` Synchronously execute a SOW query.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, int batchSize, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, boolean oofEnabled, boolean sendEmpties, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, boolean oofEnabled, boolean sendEmpties, java.lang.String options, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndDeltaSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String orderBy, int batchSize, int topN, java.lang.String options, long timeout)` Executes a SOW query and places a delta subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, int batchSize, long timeout)` Executes a SOW query and places a subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, long timeout)` Executes a SOW query and places a subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, boolean oofEnabled, long timeout)` Executes a SOW query and places a subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, long timeout)` Executes a SOW query and places a subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, int batchSize, java.lang.String options, long timeout)` Executes a SOW query and places a subscription.
`CommandId`	`sowAndSubscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String orderBy, java.lang.String bookmark, int batchSize, int topN, java.lang.String options, long timeout)` Executes a SOW query and places a subscription.
`MessageStream`	`sowAndSubscribe(java.lang.String topic)` Executes a SOW query and places a subscription.
`MessageStream`	`sowAndSubscribe(java.lang.String topic, java.lang.String filter)` Executes a SOW query and places a subscription.
`CommandId`	`sowDelete(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, long timeout)` Executes a SOW delete with filter.
`CommandId`	`sowDelete(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String options, long timeout)` Executes a SOW delete with filter.
`Message`	`sowDelete(java.lang.String topic, java.lang.String filter, long timeout)` Executes a SOW delete with filter.
`CommandId`	`sowDeleteByData(MessageHandler messageHandler, java.lang.String topic, java.lang.String data, long timeout)` Executes a SOW delete by data.
`CommandId`	`sowDeleteByKeys(MessageHandler messageHandler, java.lang.String topic, java.lang.String keys, long timeout)` Executes a SOW delete using the SowKey assigned by AMPS to specify the messages to delete.
`void`	`startTimer()` Deprecated. No longer supported by the AMPS server. Sends a start timer command to AMPS, which can be later stopped with a stop timer command.
`CommandId`	`stopTimer(MessageHandler handler_)` Deprecated. No longer supported by the AMPS server. Sends a stop timer command to AMPS
`CommandId`	`subscribe(MessageHandler messageHandler, java.lang.String topic, long timeout)` Places a subscription with AMPS.
`CommandId`	`subscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, long timeout)` Places a subscription with AMPS.
`CommandId`	`subscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String options, long timeout)` Places a subscription with AMPS.
`CommandId`	`subscribe(MessageHandler messageHandler, java.lang.String topic, java.lang.String filter, java.lang.String options, long timeout, java.lang.String subId)` Places a subscription with AMPS.
`MessageStream`	`subscribe(java.lang.String topic)` Places a subscription with AMPS.
`MessageStream`	`subscribe(java.lang.String topic, java.lang.String filter)` Places a subscription with AMPS.
`void`	`unsubscribe()` Remove all of the client's subscriptions from AMPS.
`void`	`unsubscribe(CommandId subscriptionId)` Remove a subscription from AMPS.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - exceptionListener
```
protected volatile java.beans.ExceptionListener exceptionListener
```
  - lock
```
protected final java.util.concurrent.locks.Lock lock
```
  - _lastFailedConnectionVersion
```
protected volatile int _lastFailedConnectionVersion
```
  - MIN_PERSISTED_BOOKMARK_VERSION
```
public static final int MIN_PERSISTED_BOOKMARK_VERSION
```
    See Also:
    
    Constant Field Values
  - MIN_MULTI_BOOKMARK_VERSION
```
public static final int MIN_MULTI_BOOKMARK_VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Client
```
public Client()
```
    Default constructor that creates a client without a name. This constructor exists for use with frameworks that require managed objects to have a default constructor. The client MUST still be assigned a name using setName(String) before connecting.
    
    See Also:
    
    Client(String), setName(String)
  - Client
```
public Client(java.lang.String name)
```
    Creates a client.
    
    Parameters:
    
    name - Name for the client. This name is used for duplicate message detection and should be unique. AMPS does not enforce specific restrictions on the character set used, however some protocols (for example, XML) may not allow specific characters. 60East recommends that the client name be meaningful, short, human readable, and avoids using control characters, newline characters, or square brackets.
  - Client
```
public Client(java.lang.String name,
              int version)
```
    Creates a client.
    
    Parameters:
    
    name - Name for the client. This name is used for duplicate message detection and should be unique.AMPS does not enforce specific restrictions on the character set used, however some protocols (for example, XML) may not allow specific characters. 60East recommends that the client name be meaningful, short, human readable, and avoids using control characters, newline characters, or square brackets.
    
    version - Server version connecting to
  - Client
```
public Client(java.lang.String name,
              Transport transport)
```
    Creates a client with a transport.
    
    Parameters:
    
    name - Name for the client. This name is used for duplicate message detection and should be unique.
    
    transport - Transport to use for this client
  - Client
```
public Client(java.lang.String name,
              Transport transport,
              int version)
```
    Creates a client with a transport
    
    Parameters:
    
    name - Name for the client. This name is used for duplicate message detection and should be unique.
    
    transport - Transport to use with the client
    
    version - Server version connecting to. Only AMPS_3 and greater are supported.
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
    This method MUST be called to assign a unique client name before connecting to an AMPS server when the client was constructed using the default constructor. This is a write-once property. If the client already has a non-empty client name, this method will throw IllegalStateException. This method and the default constructor exist to better support frameworks that require managed objects to have a default constructor.
    
    Parameters:
    
    name - The client name, passed to the server to uniquely identify this client across sessions. AMPS does not enforce specific restrictions on the character set used, however some protocols (for example, XML) may not allow specific characters. 60East recommends that the client name be meaningful, short, human readable, and avoids using control characters, newline characters, or square brackets.
    
    Throws:
    
    java.lang.IllegalStateException - If this is called when the client already has a non-empty name.
    
    See Also:
    
    Client(), Client(String)
  - getName
```
public java.lang.String getName()
```
    Return the name of the Client.
    
    Returns:
    
    String Client name
  - getNameHash
```
public java.lang.String getNameHash()
```
    Return the name hash of the Client as returned by the server at logon.
    
    Returns:
    
    String Client name
  - getURI
```
public java.net.URI getURI()
```
    Return the URI the Client is connected to.
    
    Returns:
    
    URI
  - getServerVersion
```
public int getServerVersion()
```
    Return the server version retrieved during logon. If the client has not logged on or is connected to a server whose version is less than 3.8.0.0 this function will return 0. The version uses 2 digits each for major minor maintenance and hotfix i.e., 3.8.1.5 will return 3080105 Versions of AMPS prior to 3.8.0.0 did not return the server version to the client in the logon ack. Version parts with more than 2 digits will be set to 99. This function will be deprecated in a future version of the client.
    
    Returns:
    
    The version of the server as a long.
  - getServerVersionInfo
```
public VersionInfo getServerVersionInfo()
```
    Return the server version retrieved during logon. If the client has not logged on or is connected to a server whose version is less than 3.8.0.0 this function will return a version "default". Versions of AMPS prior to 3.8.0.0 did not return the server version to the client in the logon ack.
    
    Returns:
    
    The version of the server as a VersionInfo.
  - getVersionAsInt
```
@Deprecated
public static int getVersionAsInt(java.lang.String version)
                                       throws CommandException
```
    Deprecated.
    
    WARNING: @deprecated Use VersionInfo.getVersion() Return the numeric value for the given version string with the pattern: Major.Minor.Maintenance.Hotfix The version uses 2 digits each for major minor maintenance and hotfix i.e., 3.8.1.5 will return 3080105 Version strings passed in can be shortened to not include all levels so 3.8 will return 3080000. Version parts with more than 2 digits will be set to 99. This function will be deprecated in a future version of the client.
    
    Parameters:
    
    version - The version string to convert.
    
    Returns:
    
    The version as a int.
    
    Throws:
    
    CommandException - The string doesn't represent a valid version.
  - getTransport
```
public Transport getTransport()
```
    Return the underlying transport. For advanced users, this method provides direct access to the transport. Care needs to be taken to not modify the underlying transport in ways that are incompatible with the Client.
    
    Returns:
    
    Transport Underlying transport instance
  - setBookmarkStore
```
public void setBookmarkStore(BookmarkStore val)
                      throws AlreadyConnectedException
```
    Sets the underlying bookmark store, which is used to track which messages the client has received and which messages have been processed by the program. This method replaces any existing bookmark store for the client, without transferring the state of that store.
    
    Parameters:
    
    val - The new bookmark store.
    
    Throws:
    
    AlreadyConnectedException - The store cannot be set while the client is connected.
  - getBookmarkStore
```
public BookmarkStore getBookmarkStore()
```
    Returns the underlying bookmark store for this client. The bookmark store is used to track which messages the client has received and which messages have been processed by the program.
    
    Returns:
    
    BookmarkStore The bookmark store for this client.
  - setPublishStore
```
public void setPublishStore(Store store)
                     throws AlreadyConnectedException
```
    Sets the underlying publish store, which is used to store published messages until the AMPS instance has acknowledged those messages. This method replaces any existing publish store for the client, without transferring the state of that store.
    
    Parameters:
    
    store - The new publish store.
    
    Throws:
    
    AlreadyConnectedException - The store cannot be set while the client is connected.
  - getPublishStore
```
public Store getPublishStore()
```
    Returns the underlying publish store for this client. The publish store is used to store published messages until the AMPS instance has acknowledged those messages.
    
    Returns:
    
    Store The publish store for this client.
  - connect
```
public void connect(java.lang.String uri)
             throws ConnectionException
```
    Connects to the AMPS instance through the provided URI.
    The URI is a String with the format: transport://user:password@host:port/protocol
    - transport -- the network transport used for the connection
    - user -- the userId used to authenticate the connection
    - password -- the password used to authenticate the connection
    - host -- the hostname or IP address of the host where AMPS is running
    - port -- the port to connect to
    - protocol -- the protocol used for the connection
    Notice that the protocol can be independent of the message type. 60East recommends using the amps protocol, although some installations use one of the legacy protocols such as fix, nvfix or xml. Contact your server administrator for the correct URI for the instance.
    
    Authentication is optional if the system is using the default authentication provided with AMPS. This default authentication allows all users to authenticate, regardless of the user or password provided. If your AMPS installation uses custom authentication, use the Authenticator appropriate for that authentication mechanism.
    Parameters:
    
    uri - The URI string to connect to
    
    Throws:
    
    ConnectionRefusedException - The connection could not be established
    
    AlreadyConnectedException - The connection is already connected
    
    InvalidURIException - The specified URI is invalid
    
    ProtocolException - The protocol is invalid
    
    TransportTypeException - The transport type is invalid
    
    ConnectionException
  - setDisconnectHandler
```
public void setDisconnectHandler(ClientDisconnectHandler disconnectHandler_)
```
    Sets the ClientDisconnectHandler. In the event that the Client is unintentionally disconnected from AMPS, the invoke method from the ClientDisconnectHandler will be invoked.
    
    Parameters:
    
    disconnectHandler_ - The disconnect handler
  - getDisconnectHandler
```
public ClientDisconnectHandler getDisconnectHandler()
```
    Returns the current ClientDisconnectHandler set on self.
    
    Returns:
    
    The current disconnect handler.
  - setUnhandledMessageHandler
```
@Deprecated
public void setUnhandledMessageHandler(MessageHandler messageHandler)
```
    Deprecated. Use setLastChanceMessageHandler(com.crankuptheamps.client.MessageHandler) instead.
    
    Sets the MessageHandler instance used when no other handler matches.
    
    Parameters:
    
    messageHandler - The message handler used when no other handler matches.
  - setLastChanceMessageHandler
```
public void setLastChanceMessageHandler(MessageHandler messageHandler)
```
    Sets the MessageHandler instance used when no other handler matches.
    
    Parameters:
    
    messageHandler - The message handler used when no other handler matches.
  - setExceptionListener
```
public void setExceptionListener(java.beans.ExceptionListener exceptionListener)
```
    Sets the ExceptionListener instance used for communicating absorbed exceptions.
    
    Parameters:
    
    exceptionListener - The exception listener instance to invoke for exceptions.
  - getExceptionListener
```
public java.beans.ExceptionListener getExceptionListener()
```
    Returns the ExceptionListener instance used for communicating absorbed exceptions.
    
    Returns:
    
    The current exception listener.
  - setSubscriptionManager
```
public void setSubscriptionManager(SubscriptionManager subscriptionManager)
```
    Sets the SubscriptionManager instance used for recording active subscriptions.
    
    Parameters:
    
    subscriptionManager - The subscription manager invoked when the subscriptions change.
  - getSubscriptionManager
```
public SubscriptionManager getSubscriptionManager()
```
    Returns the SubscriptionManager instance used for recording active subscriptions.
    
    Returns:
    
    The current subscription manager.
  - setGlobalCommandTypeMessageHandler
```
public void setGlobalCommandTypeMessageHandler(java.lang.String command,
                                               MessageHandler messageHandler)
                                        throws CommandException
```
    Sets the MessageHandler instance used for all messages of the given command type.
    
    Parameters:
    
    command - The type of command to send to this handler
    
    messageHandler - The message handler to invoke for duplicate messages
    
    Throws:
    
    CommandException - If the command is not a supported command.
  - setGlobalCommandTypeMessageHandler
```
public void setGlobalCommandTypeMessageHandler(int command,
                                               MessageHandler messageHandler)
                                        throws CommandException
```
    Sets the MessageHandler instance used for all messages of the given command type.
    
    Parameters:
    
    command - The Message.Command value of the desired command to send to this handler.
    
    messageHandler - The message handler to invoke for duplicate messages
    
    Throws:
    
    CommandException - If the command is not a supported command.
  - setGlobalCommandTypeMessageHandler
```
public void setGlobalCommandTypeMessageHandler(Client.GlobalCommandTypeHandlers command,
                                               MessageHandler messageHandler)
                                        throws CommandException
```
    Sets the MessageHandler instance used for all messages of the given command type.
    
    Parameters:
    
    command - The GlobalCommandTypeHandlers value of the desired command to send to this handler.
    
    messageHandler - The message handler to invoke for duplicate messages
    
    Throws:
    
    CommandException - If the command is not a supported command.
  - setDuplicateMessageHandler
```
public void setDuplicateMessageHandler(MessageHandler messageHandler)
```
    Sets the MessageHandler instance used for duplicate messages.
    
    Parameters:
    
    messageHandler - The message handler to invoke for duplicate messages
  - getDuplicateMessageHandler
```
public MessageHandler getDuplicateMessageHandler()
```
    Returns the MessageHandler instance used for duplicate messages.
    
    Returns:
    
    The message handler to invoke for duplicate messages
  - setFailedWriteHandler
```
public void setFailedWriteHandler(FailedWriteHandlerV4 handler_)
```
    Sets the FailedWriteHandler instance used to report on failed messages that have been written.
    
    Parameters:
    
    handler_ - The handler to invoke for published duplicates.
  - setFailedWriteHandler
```
public void setFailedWriteHandler(FailedWriteHandler handler_)
```
    Sets the FailedWriteHandler instance used to report on failed messages that have been written.
    
    Parameters:
    
    handler_ - The handler to invoke for published duplicates.
  - getFailedWriteHandler
```
public FailedWriteHandler getFailedWriteHandler()
```
    Returns the FailedWriteHandler instance used to report on failed messages that have been written.
    
    Returns:
    
    The handler to invoke for published duplicates.
  - addConnectionStateListener
```
public void addConnectionStateListener(ConnectionStateListener listener_)
```
    Adds a ConnectionStateListener instance that will be invoked when this client connects or disconnects.
    
    Parameters:
    
    listener_ - The instance to invoke.
    
    Since:
    
    4.0.0.0
  - removeConnectionStateListener
```
public void removeConnectionStateListener(ConnectionStateListener listener_)
```
    Removes a ConnectionStateListener from being invoked when this client connects or disconnects.
    
    Parameters:
    
    listener_ - The instance to remove.
    
    Since:
    
    4.0.0.0
  - broadcastConnectionStateChanged
```
protected void broadcastConnectionStateChanged(int newState_)
```
    This method is responsible for broadcasting changes in the connection state to all registered ConnectionStateListener objects. It is used to notify listeners when the connection state changes. The method obtains a copy of the listeners under lock to ensure thread safety and then broadcasts the connection state change to each listener. This approach allows listeners to remove themselves from the list during the iteration.
    
    Parameters:
    
    newState_ - An integer representing the new connection state. This value is provided to listeners through the connectionStateChanged method of the ConnectionStateListener interface.
  - disconnect
```
public void disconnect()
```
    Disconnect from the AMPS server.
  - close
```
public void close()
```
    Disconnect from the AMPS server.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - allocateMessage
```
public Message allocateMessage()
                        throws DisconnectedException
```
    Creates a new Message appropriate for this client. This function should be called rarely, since it does allocate a handful of small objects. Users sensitive to garbage collection delays should cache the message object for later usage.
    
    Returns:
    
    A new Message instance
    
    Throws:
    
    DisconnectedException - When the client has been closed or has never been connected.
  - send
```
public void send(Message message)
          throws DisconnectedException
```
    Send a Message to AMPS via the Transport used in the Client. This method is provided for special cases. In general, you can get the same results with additional error checking by using a Command object with the execute or executeAsync methods.
    
    Parameters:
    
    message - The message to send
    
    Throws:
    
    DisconnectedException - The connection was disconnected at time of send
  - addMessageHandler
```
public void addMessageHandler(CommandId commandId_,
                              MessageHandler messageHandler_,
                              int requestedAcks_,
                              boolean isSubscribe_)
```
    Adds a MessageHandler for a given CommandId to self.
    
    Parameters:
    
    commandId_ - The command, query, or subid used to invoke the handler.
    
    messageHandler_ - The message handler to route to
    
    requestedAcks_ - The acks requested to be sent to the handler
    
    isSubscribe_ - True if this route is for an ongoing subscription
  - removeMessageHandler
```
public boolean removeMessageHandler(CommandId commandId_)
```
    Remove a MessageHandler for a given CommandId from self.
    
    Parameters:
    
    commandId_ - The commandId for the handler to remove
    
    Returns:
    
    true if the handler was removed.
  - setRetryOnDisconnect
```
public void setRetryOnDisconnect(boolean isRetryOnDisconnect)
```
    Set whether or not messages being sent to the server should retry if the client is disconnected. This is most useful if you are publishing data that has a very short lifetime and so is no longer relevant after the time it takes to reconnect.
    
    Parameters:
    
    isRetryOnDisconnect - False to disable default behavior of automatic retry.
  - getRetryOnDisconnect
```
public boolean getRetryOnDisconnect()
```
    Return whether or not messages being sent to the server will retry if the client is disconnected.
    
    Returns:
    
    true if it will retry, false if not.
  - setDefaultMaxDepth
```
public void setDefaultMaxDepth(int md)
```
    Sets the default value used for the max depth of MessageStream instances created by this client. This value defaults to Integer.MAX_VALUE. Note: changing this value will not affect any message stream instances that have already been created by this client; instead use MessageStream.maxDepth(int).
    
    WARNING: Before setting this, be sure to read important limitations and restrictions of this feature discussed here: MessageStream.maxDepth(int)
    
    Parameters:
    
    md - The default max depth of all message stream instances created by this client instance.
    
    See Also:
    
    MessageStream.maxDepth(int)
  - getDefaultMaxDepth
```
public int getDefaultMaxDepth()
```
    Gets the currently set default value for the max depth of MessageStream instances created by this client.
    
    Returns:
    
    The current default max depth.
    
    See Also:
    
    setDefaultMaxDepth(int)
  - send
```
public CommandId send(MessageHandler messageHandler,
                      Message message,
                      long timeout)
               throws AMPSException
```
    Send a Message to AMPS and register the messageHandler for any messages resulting from the command execution. This method is provided for special cases. In general, you can get the same results with additional error checking by using a Command object with the execute or executeAsync methods.
    
    Parameters:
    
    messageHandler - The message handler that'll receive messages for this command
    
    message - The message to send
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command, or null if none is assigned.
    
    Throws:
    
    AMPSException - An exception occurred while sending or waiting for a response to this Message.
  - execute
```
public MessageStream execute(Command command)
                      throws AMPSException
```
    Execute the provided command and return messages received in response in a MessageStream. This method creates a message based on the provided Command, sends the message to AMPS, and receives the results. AMPS sends the message and receives the results on a background thread. That thread populates the MessageStream returned by this method.
    
    Parameters:
    
    command - The Command object containing the command to send to AMPS
    
    Returns:
    
    A MessageStream that provides messages received in response to the command
    
    Throws:
    
    AMPSException - Thrown when the command fails.
    
    Since:
    
    4.0.0.0
  - executeAsync
```
public CommandId executeAsync(Command command,
                              MessageHandler handler)
                       throws AMPSException
```
    Execute the provided command and process responses on the client receive thread using the provided handler. This method creates a message based on the provided Command, sends the message to AMPS, and invokes the provided MessageHandler to process messages returned in response to the command. Rather than providing messages on the calling thread, AMPS runs the MessageHandler directly on the client receive thread. When the provided MessageHandler is not null, this method blocks until AMPS acknowledges that the command has been processed. The results of the command after that acknowledgement are provided to the MessageHandler.
    
    Parameters:
    
    command - The Command object containing the command to send to AMPS
    
    handler - The MessageHandler to invoke to process messages received
    
    Returns:
    
    the CommandId for the command
    
    Throws:
    
    AMPSException - Thrown when the command fails.
    
    Since:
    
    4.0.0.0
  - setHeartbeat
```
public void setHeartbeat(int intervalSeconds_,
                         int timeoutSeconds_)
                  throws DisconnectedException
```
    Requests a server heartbeat, and configures the client to close the connection if a heartbeat (or other activity) is not seen on the connection.
    
    Parameters:
    
    intervalSeconds_ - The time (seconds) between beats from the server.
    
    timeoutSeconds_ - The time (seconds) to allow silence on the connection before assuming it is dead.
    
    Throws:
    
    DisconnectedException - The client became disconnected while attempting to send the heartbeat request.
  - setHeartbeat
```
public void setHeartbeat(int intervalSeconds_)
                  throws DisconnectedException
```
    Requests a server heartbeat, and configures the client to close the connection if a heartbeat (or other activity) is not seen on the connection after two heartbeat intervals.
    
    Parameters:
    
    intervalSeconds_ - The time (seconds) between beats from the server.
    
    Throws:
    
    DisconnectedException - The client became disconnected while attempting to send the heartbeat request.
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
    Returns the heartbeat interval used by the Client. A value of 0 means heartbeats are disabled.
    
    Returns:
    
    The heartbeat interval in seconds.
  - getReadTimeout
```
public int getReadTimeout()
```
    Returns the time (in seconds) to allow silence on the connection before assuming it is dead.
    
    Returns:
    
    The read timeout in seconds.
  - publish
```
public long publish(byte[] topic,
                    int topicOffset,
                    int topicLength,
                    byte[] data,
                    int dataOffset,
                    int dataLength)
             throws AMPSException
```
    Publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - the topic to publish to
    
    topicOffset - the offset in topic where the topic begins
    
    topicLength - the length of the topic in the topic array
    
    data - the data to publish
    
    dataOffset - the offset in data where data begins
    
    dataLength - the length of the data
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - the client is not connected; the program needs to call connect()
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - publish
```
public long publish(java.lang.String topic,
                    java.lang.String data)
             throws AMPSException
```
    Publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - the topic to publish the data to
    
    data - the data to publish to the topic
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - the client is not connected; the program needs to call connect()
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - publish
```
public long publish(byte[] topic,
                    int topicOffset,
                    int topicLength,
                    byte[] data,
                    int dataOffset,
                    int dataLength,
                    int expiration)
             throws AMPSException
```
    Publish a message to an AMPS topic. If the client was created with a persistent store on construction, then the client will store before forwarding the message to AMPS. In this store-and-forward case, the persistent store will notify the user, when requested via callback, of the successful persistence of the record within AMPS. If a DisconnectedException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - the topic to publish to
    
    topicOffset - the offset in topic where the topic begins
    
    topicLength - the length of the topic in the topic array
    
    data - the data to publish
    
    dataOffset - the offset in data where data begins
    
    dataLength - the length of the data
    
    expiration - the number of seconds until the message expires
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - the client is not connected; the program needs to call connect()
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - publish
```
public long publish(java.lang.String topic,
                    java.lang.String data,
                    int expiration)
             throws AMPSException
```
    Publish a message to an AMPS topic. If the client was created with a persistent store on construction, then the client will store before forwarding the message to AMPS. In this store-and-forward case, the persistent store will notify the user, when requested via callback, of the successful persistence of the record within AMPS. If a DisconnectedException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - Topic to publish the data to
    
    data - Data to publish to the topic
    
    expiration - The number of seconds until the message expires
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - The client is not connected; the program needs to call connect()
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - deltaPublish
```
public long deltaPublish(byte[] topic,
                         int topicOffset,
                         int topicLength,
                         byte[] data,
                         int dataOffset,
                         int dataLength)
                  throws AMPSException
```
    Delta publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - Topic to publish the data to
    
    topicOffset - offset into topic array where the topic name begins
    
    topicLength - length of topic array
    
    data - Data to publish to the topic
    
    dataOffset - offset into data array where the data begins
    
    dataLength - length of data array
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - The client was disconnected at time of publish
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - deltaPublish
```
public long deltaPublish(java.lang.String topic,
                         java.lang.String data)
                  throws AMPSException
```
    Delta publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - Topic to publish the data to
    
    data - Data to publish to the topic
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - The client was disconnected at time of publish
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - deltaPublish
```
public long deltaPublish(byte[] topic,
                         int topicOffset,
                         int topicLength,
                         byte[] data,
                         int dataOffset,
                         int dataLength,
                         int expiration)
                  throws AMPSException
```
    Delta publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - Topic to publish the data to
    
    topicOffset - offset into topic array where the topic name begins
    
    topicLength - length of topic array
    
    data - Data to publish to the topic
    
    dataOffset - offset into data array where the data begins
    
    dataLength - length of data array
    
    expiration - the number of seconds until the message expires
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - The client was disconnected at time of publish
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - deltaPublish
```
public long deltaPublish(java.lang.String topic,
                         java.lang.String data,
                         int expiration)
                  throws AMPSException
```
    Delta publish a message to an AMPS topic. If the client has a publish store set, then the client will store the message before forwarding the message to AMPS. This method does not wait for a response from the AMPS server. To detect failure, install a failed write handler. If a DisconnectException occurs, the message is still stored in the publish store.
    
    Parameters:
    
    topic - Topic to publish the data to
    
    data - Data to publish to the topic
    
    expiration - the number of seconds until the message expires
    
    Returns:
    
    the sequence number for the message when a persistent store is configured for the client, 0 if no store is configured
    
    Throws:
    
    DisconnectedException - The client was disconnected at time of publish
    
    StoreException - An error occurred writing to the local HA store.
    
    AMPSException
  - startTimer
```
@Deprecated
public void startTimer()
                            throws AMPSException
```
    Deprecated. No longer supported by the AMPS server. Sends a start timer command to AMPS, which can be later stopped with a stop timer command.
    
    Throws:
    
    ConnectionException - A connection error occurred while sending.
    
    AMPSException
  - stopTimer
```
@Deprecated
public CommandId stopTimer(MessageHandler handler_)
                                throws AMPSException
```
    Deprecated. No longer supported by the AMPS server. Sends a stop timer command to AMPS
    
    Parameters:
    
    handler_ - A MessageHandler to process the acknowledgement returned by AMPS.
    
    Returns:
    
    The command identifier.
    
    Throws:
    
    ConnectionException - A connection error occurred while sending.
    
    AMPSException
  - setLogonCorrelationData
```
public void setLogonCorrelationData(java.lang.String correlationData)
```
    Sets the uninterpreted logon correlation information a client sends at logon to aid in searching server log files for specific clients.
    
    Parameters:
    
    correlationData - The base64 data to be used for logon correlation.
  - getLogonCorrelationData
```
public java.lang.String getLogonCorrelationData()
```
    Gets the uninterpreted logon correlation information currently set.
    
    Returns:
    
    The base64 data to be used for logon correlation.
  - logon
```
public CommandId logon(long timeout)
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
    
    Parameters:
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier.
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - logon
```
public CommandId logon(long timeout,
                       java.lang.String options)
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
    
    Parameters:
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    options - The options string to pass with the logon command
    
    Returns:
    
    The command identifier.
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - logon
```
public CommandId logon(java.lang.String options)
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
    
    Parameters:
    
    options - The options string to pass with the logon command
    
    Returns:
    
    The command identifier.
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - logon
```
public CommandId logon(long timeout,
                       Authenticator authenticator)
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
    
    Parameters:
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    authenticator - The custom authenticator object to authenticate against
    
    Returns:
    
    The command identifier
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - logon
```
public CommandId logon(long timeout,
                       Authenticator authenticator,
                       java.lang.String options)
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method and the logon correlation id, if any, that is set.
    
    Parameters:
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    authenticator - The custom authenticator object to authenticate against
    
    options - The options string to pass with the logon command
    
    Returns:
    
    The command identifier
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - logon
```
public CommandId logon()
                throws ConnectionException
```
    Logs into AMPS with the parameters provided in the connect method.
    
    Returns:
    
    The command identifier
    
    Throws:
    
    ConnectionException - A connection error occurred while logging on.
  - bookmarkSubscribe
```
public CommandId bookmarkSubscribe(MessageHandler messageHandler,
                                   java.lang.String topic,
                                   java.lang.String filter,
                                   CommandId subId,
                                   java.lang.String bookmark,
                                   java.lang.String options,
                                   long timeout)
                            throws AMPSException
```
    Places a bookmark subscription with AMPS. Starts replay at the most recent message reported by the BookmarkStore. Whenever a disconnection or failover occurs for subscriptions created with this method, your application will automatically resubsribe to the message after the last message it processed.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    subId - The subscription ID. You may optionally provide a subscription ID to ease recovery scenarios, instead of having the system automatically generate one for you. When used with the 'replace' option, this is the subscription to be replaced. With a bookmark store, this is the subscription ID used for recovery. So, when using a persistent bookmark store, provide an explicit subscription ID that is consistent across application restarts.
    
    bookmark - The timestamp or bookmark location at which to start the subscription. This parameter can be the bookmark assigned by AMPS to a message, one of the special values in Client.Bookmarks, or a string of the format YYYYmmddTHHMMSS, as described in the AMPS User's guide.
    
    options - A Message.Options value indicating desired options for this subscription. Use Message.Options.None if no options are desired.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public CommandId subscribe(MessageHandler messageHandler,
                           java.lang.String topic,
                           java.lang.String filter,
                           long timeout)
                    throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public CommandId subscribe(MessageHandler messageHandler,
                           java.lang.String topic,
                           java.lang.String filter,
                           java.lang.String options,
                           long timeout)
                    throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public CommandId subscribe(MessageHandler messageHandler,
                           java.lang.String topic,
                           java.lang.String filter,
                           java.lang.String options,
                           long timeout,
                           java.lang.String subId)
                    throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    subId - The subscription id to use for the subscription.
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public MessageStream subscribe(java.lang.String topic)
                        throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    topic - The topic to subscribe to
    
    Returns:
    
    a MessageStream to iterate over.
    
    Throws:
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public MessageStream subscribe(java.lang.String topic,
                               java.lang.String filter)
                        throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    Returns:
    
    a MessageStream to iterate over.
    
    Throws:
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - subscribe
```
public CommandId subscribe(MessageHandler messageHandler,
                           java.lang.String topic,
                           long timeout)
                    throws AMPSException
```
    Places a subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - deltaSubscribe
```
public CommandId deltaSubscribe(MessageHandler messageHandler,
                                java.lang.String topic,
                                java.lang.String filter,
                                java.lang.String options,
                                long timeout)
                         throws AMPSException
```
    Places a delta subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - deltaSubscribe
```
public CommandId deltaSubscribe(MessageHandler messageHandler,
                                java.lang.String topic,
                                java.lang.String filter,
                                java.lang.String options,
                                long timeout,
                                java.lang.String subId)
                         throws AMPSException
```
    Places a delta subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    subId - The subscription id to use for the subscription.
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - deltaSubscribe
```
public CommandId deltaSubscribe(MessageHandler messageHandler,
                                java.lang.String topic,
                                java.lang.String filter,
                                long timeout)
                         throws AMPSException
```
    Places a delta subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - deltaSubscribe
```
public CommandId deltaSubscribe(MessageHandler messageHandler,
                                java.lang.String topic,
                                long timeout)
                         throws AMPSException
```
    Places a delta subscription with AMPS.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - unsubscribe
```
public void unsubscribe(CommandId subscriptionId)
                 throws DisconnectedException
```
    Remove a subscription from AMPS.
    
    Parameters:
    
    subscriptionId - The subscription identifier to remove
    
    Throws:
    
    DisconnectedException - The client was disconnected at the time of execution. This can still be considered a success because the subscription was still removed from the client's subscription manager (if any) and since the client is disconnected, it is unsubscribed on the server-side.
  - unsubscribe
```
public void unsubscribe()
                 throws DisconnectedException
```
    Remove all of the client's subscriptions from AMPS.
    
    Throws:
    
    DisconnectedException - The client was disconnected at the time of execution. This can still be considered a success because any subscriptions were still removed from the client's subscription manager (if any) and since the client is disconnected, it is unsubscribed on the server-side.
  - sow
```
public MessageStream sow(java.lang.String topic,
                         java.lang.String filter)
                  throws AMPSException
```
    Synchronously execute a SOW query.
    
    Parameters:
    
    topic - The topic to query
    
    filter - The filter
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public MessageStream sow(java.lang.String topic)
                  throws AMPSException
```
    Synchronously execute a SOW query.
    
    Parameters:
    
    topic - The topic to query
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public CommandId sow(MessageHandler messageHandler,
                     java.lang.String topic,
                     java.lang.String filter,
                     java.lang.String orderBy,
                     java.lang.String bookmark,
                     int batchSize,
                     int topN,
                     java.lang.String options,
                     long timeout)
              throws AMPSException
```
    Executes a SOW query.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    orderBy - The ordering property
    
    bookmark - The timestamp or bookmark location for a historical query. This parameter can be the bookmark assigned by AMPS to a message, one of the special values in Client.Bookmarks, or a string of the format YYYYmmddTHHMMSS, as described in the AMPS User's guide.
    
    batchSize - The batching parameter to use for the results
    
    topN - The maximum number of records the server will return (default is all that match)
    
    options - The options string for the command, or an empty string for no options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public CommandId sow(MessageHandler messageHandler,
                     java.lang.String topic,
                     java.lang.String filter,
                     int batchSize,
                     java.lang.String options,
                     long timeout)
              throws AMPSException
```
    Executes a SOW query.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the results
    
    options - The options string for the command, or an empty string for no options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public CommandId sow(MessageHandler messageHandler,
                     java.lang.String topic,
                     java.lang.String filter,
                     int batchSize,
                     long timeout)
              throws AMPSException
```
    Executes a SOW query.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public CommandId sow(MessageHandler messageHandler,
                     java.lang.String topic,
                     int batchSize,
                     long timeout)
              throws AMPSException
```
    Executes a SOW query.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    batchSize - The batching parameter to use for the results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sow
```
public CommandId sow(MessageHandler messageHandler,
                     java.lang.String topic,
                     long timeout)
              throws AMPSException
```
    Executes a SOW query.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public MessageStream sowAndSubscribe(java.lang.String topic,
                                     java.lang.String filter)
                              throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    Returns:
    
    A MessageStream to iterate over.
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public MessageStream sowAndSubscribe(java.lang.String topic)
                              throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    topic - The topic to subscribe to
    
    Returns:
    
    A MessageStream to iterate over.
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String filter,
                                 java.lang.String orderBy,
                                 java.lang.String bookmark,
                                 int batchSize,
                                 int topN,
                                 java.lang.String options,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    orderBy - The ordering property
    
    bookmark - The timestamp or bookmark location for a historical query. This parameter can be the bookmark assigned by AMPS to a message, one of the special values in Client.Bookmarks, or a string of the format YYYYmmddTHHMMSS, as described in the AMPS User's guide.
    
    batchSize - The batching parameter to use for the SOW query results
    
    topN - The maximum number of records the server will return (default is all that match)
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String filter,
                                 int batchSize,
                                 java.lang.String options,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String filter,
                                 int batchSize,
                                 boolean oofEnabled,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    oofEnabled - Specifies whether or not Out-of-Focus processing is enabled
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String filter,
                                 int batchSize,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 int batchSize,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    batchSize - The batching parameter to use for the SOW query results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndSubscribe
```
public CommandId sowAndSubscribe(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW query and places a subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      java.lang.String filter,
                                      java.lang.String orderBy,
                                      int batchSize,
                                      int topN,
                                      java.lang.String options,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    orderBy - The ordering property
    
    batchSize - The batching parameter to use for the SOW query results
    
    topN - The maximum number of records the server will return (default is all that match)
    
    options - A value from Message.Options indicating additional processing options
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      java.lang.String filter,
                                      int batchSize,
                                      boolean oofEnabled,
                                      boolean sendEmpties,
                                      java.lang.String options,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    oofEnabled - Specifies whether or not Out-of-Focus processing is enabled
    
    sendEmpties - Specifies whether or not unchanged records are received on the delta subscription
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      java.lang.String filter,
                                      int batchSize,
                                      boolean oofEnabled,
                                      boolean sendEmpties,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    oofEnabled - Specifies whether or not Out-of-Focus processing is enabled
    
    sendEmpties - Specifies whether or not unchanged records are received on the delta subscription
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      java.lang.String filter,
                                      int batchSize,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    filter - The filter
    
    batchSize - The batching parameter to use for the SOW query results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      int batchSize,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    batchSize - The batching parameter to use for the SOW query results
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowAndDeltaSubscribe
```
public CommandId sowAndDeltaSubscribe(MessageHandler messageHandler,
                                      java.lang.String topic,
                                      long timeout)
                               throws AMPSException
```
    Executes a SOW query and places a delta subscription.
    
    Parameters:
    
    messageHandler - The message handler to invoke with matching messages
    
    topic - The topic to subscribe to
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    SubscriptionAlreadyExistsException - A subscription with this identifier is already registered
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowDelete
```
public CommandId sowDelete(MessageHandler messageHandler,
                           java.lang.String topic,
                           java.lang.String filter,
                           java.lang.String options,
                           long timeout)
                    throws AMPSException
```
    Executes a SOW delete with filter.
    
    Parameters:
    
    messageHandler - The message handler to invoke with stats and completed acknowledgements
    
    topic - The topic to subscribe to
    
    filter - The filter. To delete all records, set a filter that is always true ('1=1')
    
    options - A value from Message.Options indicating additional processing options.
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowDelete
```
public CommandId sowDelete(MessageHandler messageHandler,
                           java.lang.String topic,
                           java.lang.String filter,
                           long timeout)
                    throws AMPSException
```
    Executes a SOW delete with filter.
    
    Parameters:
    
    messageHandler - The message handler to invoke with stats and completed acknowledgements
    
    topic - The topic to subscribe to
    
    filter - The filter. To delete all records, set a filter that is always true ('1=1')
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowDelete
```
public Message sowDelete(java.lang.String topic,
                         java.lang.String filter,
                         long timeout)
                  throws AMPSException
```
    Executes a SOW delete with filter.
    
    Parameters:
    
    topic - The topic to subscribe to
    
    filter - The filter. To delete all records, set a filter that is always true ('1=1')
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The stats message returned by this delete.
    
    Throws:
    
    BadFilterException - The provided filter is invalid
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowDeleteByKeys
```
public CommandId sowDeleteByKeys(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String keys,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW delete using the SowKey assigned by AMPS to specify the messages to delete. When you have the SowKeys for the messages, this method is more efficient than using a filter to delete messages from the SOW. For example, to efficiently delete a message that your program has received from AMPS:
```
 
  // DeleteMessageHandler receives a message containing
  // the results of the delete.
  DeleteMessageHandler dmh = new DeleteMessageHandler();

  client.sowDeleteByKeys(dmh, message.getTopic(), message.getSowKey(), 1000); 
 
 
```
    Parameters:
    
    messageHandler - The message handler to invoke with stats and completed acknowledgements
    
    topic - The topic to execute the SOW delete against
    
    keys - A comma separated list of SOW keys to be deleted
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    BadRegexTopicException - The topic specified was an invalid regular expression
    
    TimedOutException - The operation took longer than the timeout to execute
    
    DisconnectedException - The client wasn't connected when the operation was executed
    
    AMPSException
  - sowDeleteByData
```
public CommandId sowDeleteByData(MessageHandler messageHandler,
                                 java.lang.String topic,
                                 java.lang.String data,
                                 long timeout)
                          throws AMPSException
```
    Executes a SOW delete by data. AMPS uses key fields in the data to find and delete a message with the same keys.
    
    Parameters:
    
    messageHandler - The message handler to invoke with stats and completed acknowledgements
    
    topic - The topic to execute the SOW delete against
    
    data - The message to match and delete in the SOW cache
    
    timeout - The number of milliseconds to wait for the client to receive and consume a processed ack for this command, where 0 indicates to wait indefinitely
    
    Returns:
    
    The command identifier assigned to this command
    
    Throws:
    
    AMPSException - An error occurred while waiting for this command to be processed.
  - publishFlush
```
public void publishFlush()
                  throws DisconnectedException,
                         TimedOutException
```
    Ensures that AMPS messages are sent and have been processed by the AMPS server. When a publish store is present, waits until all of the messages in the publish store at the time the command is called have been acknowledged as persisted.
    Otherwise, the client issues a flush command and waits for a processed acknowledgement. This method blocks until messages have been processed or until the client is disconnected, and is most useful when the application reaches a point at which it is acceptable to block to ensure that messages have been delivered to the AMPS server. For example, an application might call publishFlush before exiting. One thing to note is that if AMPS is unavailable (HA Client), publishFlush needs to wait for a connection to come back up which may look like it's hanging.
    
    Throws:
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
    
    TimedOutException - Not thrown from this overload: the method blocks until the operation completes.
  - publishFlush
```
public void publishFlush(java.lang.String ackType)
                  throws CommandException,
                         DisconnectedException,
                         TimedOutException
```
    Ensures that AMPS messages are sent and have been processed by the AMPS server. When a publish store is present, waits until all of the messages in the publish store at the time the command is called have been acknowledged as persisted.
    In addition, the behavior depends on the server version. the client issues a flush command. If the server supports waiting for a persisted acknowledgement indicating that all prior messages are also persisted and that was requested, it will do that. Otherwise, it waits for a processed acknowledgement. This method blocks until messages have been processed or until a disconnect occurs, and is most useful when the application reaches a point at which it is acceptable to block to ensure that messages have been delivered to the AMPS server. For example, an application might call publishFlush before exiting. One thing to note is that if AMPS is unavailable (HA Client), publishFlush needs to wait for a connection to come back up which may look like it's hanging.
    
    Parameters:
    
    ackType - The acknowledgement type that the flush command should wait to receive, see Message.AckType. `processed` matches the no arguments version of this function. `persisted` ensures all previous messages have been persisted.
    
    Throws:
    
    CommandException - Thrown if an invalid ack type is requested.
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
    
    TimedOutException - Not thrown from this overload: the method blocks until the operation completes.
  - publishFlush
```
public void publishFlush(long timeout)
                  throws DisconnectedException,
                         TimedOutException
```
    Ensures that AMPS messages are sent and have been processed by the AMPS server. When a publish store is present, waits until all of the messages in the publish store at the time the command is called have been acknowledged as persisted.
    Otherwise, the client issues a flush command and waits for a processed acknowledgement. This method blocks until messages have been processed, until the timeout occurs, or until the client is disconnected, and is most useful when the application reaches a point at which it is acceptable to block to ensure that messages have been delivered to the AMPS server. For example, an application might call publishFlush before exiting. One thing to note is that if AMPS is unavailable (HA Client), publishFlush needs to wait for a connection to come back up which may look like it's hanging.
    
    Parameters:
    
    timeout - Number of milliseconds to wait for flush, where 0 indicates to wait indefinitely
    
    Throws:
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
    
    TimedOutException - Thrown if the timeout period expires before the method returns
  - publishFlush
```
public void publishFlush(java.lang.String ackType,
                         long timeout)
                  throws CommandException,
                         DisconnectedException,
                         TimedOutException
```
    Ensures that AMPS messages are sent and have been processed by the AMPS server. When a publish store is present, waits until all of the messages in the publish store at the time the command is called have been acknowledged as persisted.
    In addition, the behavior depends on the server version. the client issues a flush command. If the server supports waiting for a persisted acknowledgement indicating that all prior messages are also persisted and that was requested, it will do that. Otherwise, it waits for a processed acknowledgement. This method blocks until messages have been processed, until the timeout has expired, or until a disconnect occurs, and is most useful when the application reaches a point at which it is acceptable to block to ensure that messages have been delivered to the AMPS server. For example, an application might call publishFlush before exiting. One thing to note is that if AMPS is unavailable (HA Client), publishFlush needs to wait for a connection to come back up which may look like it's hanging.
    
    Parameters:
    
    ackType - The acknowledgement type that the flush command should wait to receive, see Message.AckType. `processed` matches the timeout only version of this function. `persisted` ensures all previous messages have been persisted.
    
    timeout - Number of milliseconds to wait for flush, where 0 indicates to wait indefinitely
    
    Throws:
    
    CommandException - Thrown if an invalid ack type is requested.
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
    
    TimedOutException - Not thrown from this overload: the method blocks until the operation completes.
  - flush
```
@Deprecated
public long flush()
                       throws DisconnectedException
```
    Deprecated. As of 5.3.0.0. Use (@link #publishFlush) instead. Clear the queued messages which may be waiting in the transport. This is a no-op.
    
    Returns:
    
    long Number of messages or bytes queued after flush is completed or timed out
    
    Throws:
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
  - flush
```
@Deprecated
public long flush(long timeout)
                       throws DisconnectedException
```
    Deprecated. As of 5.3.0.0. Use (@link #publishFlush) instead. Clear the queued messages which may be waiting in the transport. This is a no-op.
    
    Parameters:
    
    timeout - Number of milliseconds to wait for flush, where 0 indicates to wait indefinitely
    
    Returns:
    
    long Number of messages or bytes queued after flush is completed or timed out
    
    Throws:
    
    DisconnectedException - Thrown if the client is shut down or has never been connected
  - getVersion
```
public static java.lang.String getVersion()
```
    Return the build number for the client that is stored in the Manifest.mf of the jar file.
    
    Returns:
    
    String Build version number.
  - getThreadCreatedHandler
```
public ThreadCreatedHandler getThreadCreatedHandler()
```
    Get the handler that is invoked immediately by any thread created by the transport.
    
    Returns:
    
    The ThreadCreatedHandler invoked by new transport threads.
  - setThreadCreatedHandler
```
public void setThreadCreatedHandler(ThreadCreatedHandler handler_)
```
    Set a handler that is invoked immediately by any thread created by the transport.
    
    Parameters:
    
    handler_ - A ThreadCreatedHandler to be invoked by new transport threads.
  - getTransportFilter
```
public TransportFilter getTransportFilter()
```
    Get the filter that is used by the Client's transport for all incoming and outgoing messages.
    
    Returns:
    
    A TransportFilter invoked by the transport.
  - setTransportFilter
```
public void setTransportFilter(TransportFilter filter_)
```
    Set a filter that is used by the Client's transport for all incoming and outgoing messages.
    
    Parameters:
    
    filter_ - A TransportFilter to be invoked by the transport.
  - getConnectionInfo
```
public ConnectionInfo getConnectionInfo()
```
    Assembles a new ConnectionInfo with the state of this client and associated classes at the point in time this is called. This object is not updated once it is returned.
    
    Returns:
    
    A new ConnectionInfo object.
  - ack
```
public void ack(byte[] topic,
                int topicPos,
                int topicLen,
                byte[] bookmark,
                int bookmarkPos,
                int bookmarkLen)
         throws AMPSException
```
    ACKs a message from a message queue with a byte-array topic and bookmark
    
    Parameters:
    
    topic - The bytes of the topic to ack
    
    topicPos - The starting position in topic
    
    topicLen - The length of the topic in bytes
    
    bookmark - The bytes of the bookmark to ack
    
    bookmarkPos - The starting position in bookmark
    
    bookmarkLen - The length of the bookmark
    
    Throws:
    
    AMPSException - An exception occurred while sending a sow_delete message.
  - ack
```
public void ack(Field topic,
                Field bookmark)
         throws AMPSException
```
    ACKs a message queue message using Field objects from a message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark to ack
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - ack
```
public void ack(java.lang.String topic,
                java.lang.String bookmark)
         throws AMPSException
```
    ACKs a message queue message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark or comma-delimited bookmark list to ack.
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - ack
```
public void ack(byte[] topic,
                int topicPos,
                int topicLen,
                byte[] bookmark,
                int bookmarkPos,
                int bookmarkLen,
                byte[] options,
                int optionsPos,
                int optionsLen)
         throws AMPSException
```
    ACKs a message from a message queue with a byte-array topic and bookmark
    
    Parameters:
    
    topic - The bytes of the topic to ack
    
    topicPos - The starting position in topic
    
    topicLen - The length of the topic in bytes
    
    bookmark - The bytes of the bookmark to ack
    
    bookmarkPos - The starting position in bookmark
    
    bookmarkLen - The length of the bookmark
    
    options - The bytes of the options for the ack
    
    optionsPos - The starting position in options
    
    optionsLen - The length of the options
    
    Throws:
    
    AMPSException - An exception occurred while sending a sow_delete message.
  - _ack
```
protected void _ack(byte[] topic,
                    int topicPos,
                    int topicLen,
                    byte[] bookmark,
                    int bookmarkPos,
                    int bookmarkLen,
                    byte[] options,
                    int optionsPos,
                    int optionsLen)
             throws AMPSException
```
    Throws:
    
    AMPSException
  - ack
```
public void ack(Field topic,
                Field bookmark,
                Field options)
         throws AMPSException
```
    ACKs a message queue message using Field objects from a message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark to ack
    
    options - The options for the ack
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - ack
```
public void ack(java.lang.String topic,
                java.lang.String bookmark,
                java.lang.String options)
         throws AMPSException
```
    ACKs a message queue message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark or comma-delimited bookmark list to ack.
    
    options - The options for the ack
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - _ack
```
protected void _ack(Field topic,
                    Field bookmark)
             throws AMPSException
```
    Used internally for autoacking and by Message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark to ack
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - _ack
```
protected void _ack(Field topic,
                    Field bookmark,
                    Field options)
             throws AMPSException
```
    Used internally for autoacking and by Message.
    
    Parameters:
    
    topic - The topic to ack
    
    bookmark - The bookmark to ack
    
    options - The options for the ack
    
    Throws:
    
    AMPSException - An error occurred while sending a sow_delete message.
  - setAutoAck
```
public void setAutoAck(boolean isAutoAckEnabled)
```
    Enables or disables auto-acking. When auto-acking is enabled any successful return from a message handler function will result in an ACK (sow_delete) message sent to the server. Any thrown exception will result in a "cancel" ACK sent to the server.
    
    Parameters:
    
    isAutoAckEnabled - true to enable auto-acking; false to disable. (default: disabled).
  - getAutoAck
```
public boolean getAutoAck()
```
    Returns the current setting of auto-acking.
    
    Returns:
    
    true if auto-acking is enabled, false if auto-acking is disabled.
  - setAckBatchSize
```
public void setAckBatchSize(int batchSize)
```
    Sets the current ACK batch size. The ACK batch size controls how many successful ACKs (which are sow_delete messages) are batched together before sending to the server. When combined with the "max_backlog" and MaxPerSubscriptionBacklog server configuration parameter, greater network efficiency can be achieved when using message queues. Setting this parameter causes calls to "ack" and successful auto-acks to be batched; unsuccessful/cancel acks are sent immediately.
    
    Parameters:
    
    batchSize - The batch size to use (default: 1)
  - getAckBatchSize
```
public int getAckBatchSize()
```
    Returns the current ACK batch size. See the documentation for setAckBatchSize(int) for more information on this setting.
    
    Returns:
    
    The current ACK batch size
  - setAckTimeout
```
public void setAckTimeout(long ackTimeout)
```
    Sets the ack timeout -- the maximum time to let a success ack be cached before sending.
    
    Parameters:
    
    ackTimeout - The maximum time in milliseconds to wait to acknowledge messages, which must be greater than 0 if the ack batch size is greater than 1.
  - getAckTimeout
```
public long getAckTimeout()
```
    Returns the current queue ack timeout in milliseconds.
    
    Returns:
    
    The current queue ack timeout, in milliseconds.
  - flushAcks
```
public void flushAcks()
               throws AMPSException
```
    Send the current set of queue acknowledgements ("sow_delete" with the message bookmark) to the AMPS server. This method sends acknowledgements for messages that have been received and acknowledged: it does not acknowledge messages that the application has not yet processed.
    
    Throws:
    
    AMPSException - Thrown when the client is unable to flush acknowledgements.
  - getHttpPreflightHeaders
```
public java.util.List<java.lang.String> getHttpPreflightHeaders()
```
    Return the list of HTTP preflight headers.
    
    Returns:
    
    The list of headers used int he HTTP connect request.
  - addHttpPreflightHeader
```
public void addHttpPreflightHeader(java.lang.String header)
```
    Add a new header to the list of HTTP preflight headers.
    
    Parameters:
    
    header - The header string, e.g. Cookie: a=1; b=2
  - addHttpPreflightHeader
```
public void addHttpPreflightHeader(java.lang.String key,
                                   java.lang.String value)
```
    Add a new key/value pair to the list of HTTP preflight headers. It will be added as key: value
    
    Parameters:
    
    key - The key to add to the list of key/value headers used int he HTTP connect request.
    
    value - The value to add to the list of key/value headers used int he HTTP connect request.
  - setHttpPreflightHeaders
```
public void setHttpPreflightHeaders(java.util.List<java.lang.String> headers)
```
    Set the list of HTTP preflight headers replacing any previously set.
    
    Parameters:
    
    headers - The new list of key/value headers for HTTP connect request.
  - clearHttpPreflightHeaders
```
public void clearHttpPreflightHeaders()
```
    Clear the list of HTTP preflight headers.
  - getTransportMessageHandler
```
protected MessageHandler getTransportMessageHandler()
```
  - getTransportDisconnectHandler
```
protected TransportDisconnectHandler getTransportDisconnectHandler()
```

Class Client

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

exceptionListener

lock

_lastFailedConnectionVersion

MIN_PERSISTED_BOOKMARK_VERSION

MIN_MULTI_BOOKMARK_VERSION

Constructor Detail

Client

Client

Client

Client

Client

Method Detail

setName

getName

getNameHash

getURI

getServerVersion

getServerVersionInfo

getVersionAsInt

getTransport

setBookmarkStore

getBookmarkStore

setPublishStore

getPublishStore

connect

setDisconnectHandler

getDisconnectHandler

setUnhandledMessageHandler

setLastChanceMessageHandler

setExceptionListener

getExceptionListener

setSubscriptionManager

getSubscriptionManager

setGlobalCommandTypeMessageHandler

setGlobalCommandTypeMessageHandler

setGlobalCommandTypeMessageHandler

setDuplicateMessageHandler

getDuplicateMessageHandler

setFailedWriteHandler

setFailedWriteHandler

getFailedWriteHandler

addConnectionStateListener

removeConnectionStateListener

broadcastConnectionStateChanged

disconnect

close

allocateMessage

send

addMessageHandler

removeMessageHandler

setRetryOnDisconnect

getRetryOnDisconnect

setDefaultMaxDepth

getDefaultMaxDepth

send

execute

executeAsync

setHeartbeat

setHeartbeat

getHeartbeatInterval

getReadTimeout

publish

publish

publish

publish

deltaPublish

deltaPublish

deltaPublish

deltaPublish

startTimer

stopTimer

setLogonCorrelationData

getLogonCorrelationData