Package com.crankuptheamps.client

This package contains the AMPS Java client.

See: Description

Interface Summary

Interface	Description
AMPSRunnable	An interface that can be implemented to create background tasks that execute when a TCPTransport is idle.
Authenticator	Interface used to authenticate an AMPS Java Client user.
BlockPublishStore.Buffer	Interface which is used to hold the BlockPublishStore buffer data.
BookmarkStore	Defines the interface for bookmark stores, which are used by the Client to provide resumable subscriptions and client-side duplicate message handling.
BookmarkStoreResizeHandler	Interface used to indicate whether a BookmarkStore implementation is allowed to grow (or shrink) to the requested size.
ClientDisconnectHandler	Called in Client when the Client unintentionally disconnects from AMPS.
ClientDisconnectHandler2	60East recommends using the HAClient, which includes a robust implementation of disconnect handling and reconnection, unless your application has needs that cannot be met by the HAClient behavior.
ConnectionStateListener	An interface that allows an application to be notified when the client state changes.
FailedResubscribeHandler	Interface for handling failed resubscription events in the AMPS client.
FailedWriteHandler	An interface for receiving information about messages that you've published, but for which the server indicates were not persisted.
FailedWriteHandlerV4	An interface for receiving information on messages that you've written, but for which the server indicates were not persisted.
MessageHandler	Interface for all classes that handle AMPS messages.
Protocol	Interface representing an AMPS wire protocol.
ProtocolParser	Interface that parses an AMPS wire transport protocol.
PublishStoreResizeHandler	Interface used to indicate whether a Store implementation is allowed to grow (or shrink) to the requested size.
ReconnectDelayStrategy	ReconnectDelayStrategy implementations are called by HAClient to determine how long to wait between attempts to connect or reconnect to a server.
RecoveryPoint	Interface used by RecoveryPointAdapter's to represent a bookmark subscription's recovery state, to allow that subscription to be resumed in a reasonable place when the subscriber application exits and restarts.
RecoveryPointAdapter	An instance of this interface that can optionally be provided to MemoryBookmarkStore when it's constructed to persist recovery bookmark state for each bookmark replay subscription.
RecoveryPointFactory	An interface for creating instances of the `RecoveryPoint`.
ServerChooser	Interface for choosing amongst multiple instances for both initial connection and reconnection.
Store	Represents a message store.
Store.StoreReplayer	Replay the messages saved in a store.
Subscription	Interface that represents a single subscription within a bookmark store implementation.
SubscriptionManager	Interface used to manage all subscriptions in AMPS.
ThreadCreatedHandler
Transport	Interface that is used to manage and configure connections to AMPS.
TransportDisconnectHandler	This class is used internally.
TransportFilter	Interface used to filter raw incoming and outgoing data on a Transport.

Class Summary

Class	Description
AMPSTimestamp	Provides an easy way to extract the date/time parts from an AMPS timestamp.
ArrayStoreBuffer	ArrayStoreBuffer is a simple wrapper for a java array that maintains position.
BlockPublishStore	BlockPublishStore is a base class for publish Store implementations.
BlockPublishStore.ByteSequence	A simple wrapper object around a byte array that allows a sub-range to be specified using its offset and length properties.
BookmarkRingBuffer	A ring buffer of bookmarks and activation status Used by all of the bookmark stores to track state of bookmarks we need to hold on to, either because they're active or because they're after an active one.
BookmarkRingBuffer.Entry	Represents a single entry in an array of bookmarks
Client	The base AMPS client object used for AMPS applications that do not need a resilient connection to AMPS.
Client.Bookmarks	Provides constants for special bookmark values.
Client.Version	Class that holds supported versions of AMPS, those are: AMPS version 3, AMPS version 4 and AMPS version 5.
ClientVersion	Used to indicate the version of this client build outside of JAR manifest files (which can be lost due to repackaging in cases such as "fat JARs").
Command	Command is an encapsulation of a single AMPS command sent by the client.
CommandId	Used to give a unique identifier to a Command.
CompositeMessageBuilder	Used to create payloads for AMPS composite messages, which are messages with a number of parts where each part is a complete message of a specific message type.
CompositeMessageParser	Used to retrieve individual message parts from AMPS composite messages, which are messages where the data contains a number of parts and each part is a complete message of a specific message type.
ConflatingRecoveryPointAdapter	An implementation of the RecoveryPointAdapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts).
ConnectionInfo	A Key, Value mapping for metadata about the state of an AMPS connection.
DefaultAuthenticator	A default implementation of the Authenticator interface that is used for basic username/password authentication.
DefaultBookmarkStore	A no-op default implementation of the BookmarkStore interface that does nothing.
DefaultDisconnectHandler	A default no-op implementation of the ClientDisconnectHandler and TransportDisconnectHandler interfaces that does nothing.
DefaultMessageHandler	A default no-op implementation of the MessageHandler interface that does nothing.
DefaultServerChooser	A simple ServerChooser that keeps a list of AMPS instances and Authenticators, and advances to the next one when failure occurs.
DefaultSubscriptionManager	A no-op implementation of the SubscriptionManager interface that does nothing.
DefaultTransportFilter	A default no-op filter from the TransportFilter class that does nothing.
ExponentialDelayStrategy	ExponentialDelayStrategy is an implementation that exponentially "backs off" when reconnecting to the same server, with a maximum number of retries before it gives up entirely.
FIXBuilder	Used to build up message strings for FIX.
FixedDelayStrategy	FixedDelayStrategy is an implementation that delays for a fixed time period, as specified in the constructor, when reconnecting to the same server as we were previously connected to, or if we are invoked again for the first server we ever tried.
FIXMessage	A message subclass used by FIXProtocolParser to aid in building Message instances parsed from the FIXProtocol.
FIXProtocol	Implements the Protocol interface.
FIXProtocolParser	Implements the ProtocolParser interface.
FIXShredder	A parser class which converts a FIX message into a Java Map.
HAClient	A highly-available AMPS Client object that automatically reconnects and re-subscribes to AMPS instances upon disconnect.
HAClient.HADisconnectHandler	Class used to handle disconnects for highly-available AMPS Clients.
HashBox	A helper class, used as a HashMap key, that can hash strings, byte array regions, or integers.
HybridPublishStore	PublishStore that stores first in memory, and swaps excess out to disk.
JSONMessage	A message subclass used by JSONProtocolParser to aid in building Message instances parsed from the JSONProtocol (i.e.
JSONProtocol	Implements the Protocol interface.
JSONProtocolParser	Implements the ProtocolParser interface.
LoggedBookmarkStore	LoggedBookmarkStore implements a sequentially written log of incoming and discarded messages.
LoggedBookmarkStore.Subscription	The Subscription object is used to represent internal bookmark state for the messages received and discarded on a specific subscription within the bookmark store.
MemoryBookmarkStore	Implements a bookmark store useful for handling server failover scenarios, but without a backing store to recover from subscriber failure.
MemoryBookmarkStore.Subscription	The Subscription object is used to represent internal bookmark state for the messages received and discarded on a specific subscription within the bookmark store.
MemoryPublishStore	An in-memory publish store, used to provide republish capability when a server fails over.
MemoryStoreBuffer	MemoryStoreBuffer is a wrapper for a java array that maintains position.
MemorySubscriptionManager	An in-memory implementation of SubscriptionManager.
Message	All communication with AMPS occurs through passing Messages.
Message.AckType	Container class of maskable ints that represent the available types of Message acknowledgement.
Message.Command	Tells AMPS how to interpret a message.
Message.Options	Represents the possible values for message options in an AMPS command.
Message.Reason	Container class of ints that represent the possible values for Message reason.
Message.Status	Container class of ints that represent the possible values for Message status.
MessageRouter	MessageRouter is used to register and manage a list of handler objects for messages, as well as routing messages to those handlers as messages arrive.
MessageStream	MessageStream provides an iteration abstraction over the results of an AMPS command such as a subscribe, a SOW query, or SOW delete.
NVFIXBuilder	Used to build up message strings for NVFIX.
NVFIXMessage	A message subclass used by NVFIXProtocolParser to aid in building Message instances parsed from the NVFIXProtocol.
NVFIXProtocol	Implements the Protocol interface.
NVFIXProtocolParser	Implements the ProtocolParser interface and extends FIXProtocolParser class.
NVFIXShredder	A parser class that converts a NVFIX message into a Java Map.
Pool<T>	A simple generic instance pool for objects that take a while to construct.
ProtocolFactory	Class which creates Protocols as well as registering and unregistering them from a Java Map.
PublishStore	PublishStore is a memory-mapped file-backed store for storing outgoing messages.
RingBookmarkStore	RingBookmarkStore is an implementation of BookmarkStore that stores state on disk and in memory.
RingBookmarkStore.Subscription	The Subscription object is used to represent internal bookmark state for the messages received and discarded on a specific subscription within the bookmark store.
SOWRecoveryPointAdapter	An implementation of the recovery point adapter interface that uses an AMPS SOW (State of the World) topic as an external store to persist recovery point state for bookmark replay subscriptions.
TCPSTransport	Implements an AMPS transport over SSL.
TCPSTransportImpl	The SSL Socket implementation of TCPSTransport.
TCPTransport	Implements an AMPS transport over standard TCP/IP.
TCPTransportImpl	Socket implementation for TCPTransport.
TransportFactory	Factory class that allows you to register and unregister handler classes for various connection URI prefixes.
TransportTraceFilter	An implementation of TransportFilter for tracing message bytes to an OutputStream such as System.err.
URIProperties	Provides a Properties-style interface to the parameters in a Uniform Resource Identifier (URI).
VersionInfo	A representation of an AMPS version that can be compared.
XMLMessage	A message subclass used by XMLProtocolParser to aid in building Message instances parsed from the XMLProtocol.
XMLProtocol	Implements the Protocol interface.
XMLProtocolParser	Implements the ProtocolParser interface.

Enum Summary

Enum	Description
Client.GlobalCommandTypeHandlers	Specifies a type of message that is always sent to an associated handler when one is set.
Message.SerializationResult	Returned by calls to Message.serialize(ByteBuffer)

Exception Summary

Exception	Description
ExponentialDelayStrategy.MaximumRetryExceeded	A specialized exception type thrown by ExponentialDelayStrategy to indicate that the client should "give up" on attempting to reconnect to a server.
FixedDelayStrategy.MaximumRetryExceeded	A specialized exception type thrown by ExponentialDelayStrategy to indicate that the client should "give up" on attempting to reconnect to a server.

Package com.crankuptheamps.client Description

This package contains the AMPS Java client.