AMPS.Client Namespace Reference

A simple ServerChooser that keeps a list of AMPS instances and Authenticators, and advances to the next one when failure occurs. More...

Classes
interface	Authenticator
class	BlockPublishStore
class	BookmarkRingBuffer
interface	BookmarkStore
interface	BookmarkStoreResizeHandler
class	Client
interface	ClientDisconnectHandler
class	ActionDisconnectHandler
	Allows the use of an Action (i.e. lambda function with no return value) in any context where a ClientDisconnectHandler may be used. More...
class	Command
	Command is an encapsulation of a single AMPS command sent by the client. Using Command you can build valid commands to be executed either synchronously or asynchronously via the Client execute() and executeAsync() methods. Command is designed to be used as a "builder" enabling AMPS commands to be built easily, for example: More...
class	CommandId
	Used to give a unique identifier to a Command. This Id can be used to reference the command later, such as when unsubscribing a subscription command. More...
interface	CompletionListener
class	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. For example, a composite message type of "composite-json-binary" may be declared on the server that combines a set of JSON headers with an opaque binary payload. CompositeMessageBuilder makes it easy to assemble this payload. More...
class	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. For example, a composite message type of "composite-json-binary" may be declared on the server that combines a set of JSON headers with an opaque binary payload. CompositeMessageParser makes it easy to retrieve the parts of a composite message from the composite message payload. More...
class	ConflatingRecoveryPointAdapter
class	ConnectionInfo
class	DefaultAuthenticator
class	DefaultBookmarkStore
	A no-op default implementation of the BookmarkStore interface that does nothing. More...
class	DefaultCompletionListener
class	DefaultDisconnectHandler
	A default no-op implementation of the ClientDisconnectHandler and TransportDisconnectHandler interfaces that does nothing. More...
class	DefaultMessageHandler
	A defualy no-op implementation of the MessageHandler interface that does nothing. More...
class	DefaultServerChooser
class	DefaultSubscriptionManager
	A no-op implementation of the SubscriptionManager interface that does nothing. More...
class	DynamicRecoveryPoint
class	DynamicRecoveryPointFactory
class	ExponentialDelayStrategy
	ExponentialDelayStrategy is an implementation that exponentially "backs off" when reconnecting to the same server, including optional jitter when backing off and a maximum amount of time to attempt reconnection before giving up entirely. More...
class	Integer
class	Long
class	ExtensionMethods
interface	FailedWriteHandler
	An interface for receiving information on messages that you've written, but for which the server indicates are not persisted because of a failure. More...
interface	FailedWriteHandlerV4
	An interface for receiving information on messages that you've written, but for which the server indicates are not persisted because of a failure. More...
class	FIXBuilder
	Used to build up message strings for FIX. More...
class	FixedDelayStrategy
class	FixedRecoveryPoint
class	FixedRecoveryPointFactory
class	FIXMessage
class	FIXProtocol
	Implements the Protocol interface. Used to parse a byte stream as a series of messages. The byte stream must use the AMPS FIX protocol. More...
class	FIXProtocolParser
	Implements the ProtocolParser interface. Parses a byte stream using FIX protocol. More...
class	FIXShredder
	A parser class which converts a FIX message into a dictionary. More...
class	HAClient
	A highly-available AMPS Client object that automatically reconnects and re-subscribes to AMPS instances upon disconnect. More...
class	HandleTimeoutStream
class	HybridPublishStore
class	JSONMessage
class	JSONProtocol
	Implements the Protocol interface. Used to parse a byte stream as a series of messgaes. The byte stream must used AMPS FIX protocol. More...
class	JSONProtocolParser
	Implements the ProtocolParser interface. Parses a byte stream using JSON Protocol (AMPS Protocol). More...
class	LoggedBookmarkStore
class	MemoryBookmarkStore
class	MemoryPublishStore
class	MemoryStoreBuffer
	MemoryStoreBuffer is a wrapper for a list that maintains positon. In order to do this, MemoryStoreBuffer uses a ByteBuffer. More...
class	MemorySubscriptionManager
	An in-memory implementation of SubscriptionManager. Used by HAClient. More...
class	Message
	All communication with AMPS occurs through passing Messages. The AMPS clients provide named convenience methods for core AMPS functionality. These named methods work by creating and sending Messages to AMPS. More...
interface	MessageHandler
	Interface for classes that handle AMPS messages. More...
class	ActionMessageHandler
	Allows usage of an Action (i.e. a lambda function with no return value) in the place of a MessageHandler throughout the AMPS api. More...
class	MessageRouter
class	MessageStream
	Allows iteration over the messages in an AMPS SOW cache, or over the stream of messages on a subscription, or both. More...
class	NVFIXBuilder
	Used to build up message strings for NVFIX. More...
class	NVFIXMessage
	A message subclass used by NVFIXProtocolParser to aid in building Message instances parsed from the NVFIXProtocol. Generally not used directly by end user. More...
class	NVFIXProtocol
class	NVFIXProtocolParser
	Implements the ProtocolParser interface and extends FIXProtocolParser class. Parses a byte stream using NVFIX protocol. More...
class	NVFIXShredder
	A parser class that converts an NVFIX message into a Dictionary. More...
class	Pool
class	Properties
interface	Protocol
	Interface representing an AMPS wire protocol. Classes that implement this interface aid in parsing a byte stream as a series of messages, formatted using one of the AMPS-supported protocols. More...
class	ProtocolFactory
	Class which creates Protocols as well as registering and unregistering them from a Dictionary. More...
interface	ProtocolParser
class	PublishStore
interface	PublishStoreResizeHandler
interface	ReconnectDelayStrategy
	Reconnect delay strategy implementations are called by HAClient to determine how long to wait between attempts to connect or reconnect to a server. AMPS provides two predefined implementations: See also ExponentialDelayStrategy ExponentialDelayStrategy and See also FixedDelayStrategy FixedDelayStrategy</seelaso> More...
interface	RecoveryPoint
interface	RecoveryPointFactory
interface	RecoveryPointAdapter
class	RingBookmarkStore
interface	ServerChooser
class	SimpleReadBuffer
class	SOWRecoveryPointAdapter
interface	StoreReplayer
class	SOWDeleteTypes
interface	Store
class	Subscription
interface	SubscriptionManager
class	TCPSTransport
	Implements a secure transport for communicating with AMPS over a SslStream. More...
class	TCPSTransportImpl
class	TCPTransport
class	TCPTransportImpl
interface	ThreadCreatedHandler
	Interface for classes that handle AMPS messages. More...
class	ActionThreadCreatedHandler
	Allows usage of an Action (i.e. a lambda function with no return value) in the place of a MessageHandler throughout the AMPS api. More...
interface	Transport
interface	TransportDisconnectHandler
class	TransportFactory
class	TransportTraceFilter
	An implementation of TransportFilter that traces to a System.IO.TextWriter. To use, instantiate and hen pass to Transport's setTransportFilter, for example: Client client = new Client(...); client.connect(...); client.getTransport.setTransportFilter( new TransportTraceFilter(Console.out) ); More...
class	URIProperties
	Provides a Properties interface to the parameters passed in a URI without depending on System.Web. More...
class	Utilities
class	VersionInfo
	An IComparable representation of the server's version. More...
class	XMLMessage
class	XMLProtocol
class	XMLProtocolParser
class	ZlibIOStream
	A System.IO.Stream wrapper around the ComponentAce zlib implementation which works bidirectionally and eliminates a data copy. More...

Detailed Description

A simple ServerChooser that keeps a list of AMPS instances and Authenticators, and advances to the next one when failure occurs.

Interface to provide a recovery point for a bookmark subscription. Used in the RecoveryPointAdapter interface for updates and recovery.

A Key, Value mapping for metadata about the state of an AMPS connection.

Valid keys include:

     client.uri                      The URI this client is connected to, NULL if no connection has been attempted.
     client.name                     The name of this client.
     client.username                 The most recently-used username for this client.  NULL if no username is supplied.
     publishStore.unpersistedCount   The count of unpersisted messages in the local store.  NULL if no PublishStore has been set on the client.
     haClient.reconnectDelay         The delay between reconnect attempts.  NULL for non-HA clients.
     haClient.timeout                The default timeout used when re-logging on.  NULL for non-HA clients.

PublishStore that stores first in memory, and swaps excess out to disk.

Implements a bookmark store useful for handling server failover scenarios, but without a backing store to recover from subscriber failure.

A PublishStore used to remember things you've published, in case of failover to an AMPS secondary. Use this PublishStore when you are concerned about server failover, only: MemoryPublishStore does not protect you in case of subscriber failure, because it has no on-disk backing store.

RingBookmarkStore is an implementation of BookmarkStore that stores state on disk and in memory. For each subscription, RingBookmarkStore keeps the most recent bookmark B for which all messages prior to B have been discard()ed by the subscriber. As messages are logged and discarded, an in-memory array is used to track when a new bookmark can be logged.

Interface for choosing amongst multiple instances for both initial connection and reconnection. Used by HAClient to pick an initial server, and then pick a new one on failure.