net.quedex.api.user

Interface UserStream

All Known Implementing Classes:

WebsocketUserStream

public interface UserStream

Represents the stream of realtime private data streamed from and trading commands which may be sent to Quedex. Allows registering and subscribing for particular data types. The registered listeners will be called (in a single thread) for every event that arrives. Trading commands include placing, canceling and modifying orders - batching of these commands is possible via batch() methods and should be used whenever possible. The data exchanged on the stream has the form of PGP-encrypted messages - all the encryption/decryption and serialization/deserialization is handled by the implementations and the interaction with the stream is based on Java objects.

The stream gives some guarantees about the order of received events useful for state initialisation - see documentation of subscribeListeners().

To handle all errors properly, always registerStreamFailureListener(net.quedex.api.common.StreamFailureListener) before start()ing the stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserStream.Batch

Method Summary

Modifier and Type	Method and Description
UserStream.Batch	batch() Returns an object (not thread-safe) which may be used fluently to send a batch of OrderSpecs to the exchange.
void	batch(java.util.List<? extends OrderSpec> batch) Sends the given list of OrderSpecs to the exchange.
void	cancelOrder(OrderCancelSpec orderCancelSpec) Sends the given OrderCancelSpec to the exchange.
void	executeInternalTransfer(InternalTransfer internalTransfer)
void	modifyOrder(OrderModificationSpec orderModificationSpec) Sends the given OrderModificationSpec to the exchange.
void	placeOrder(LimitOrderSpec limitOrderSpec) Sends the given LimitOrderSpec to the exchange.
void	registerAccountStateListener(AccountStateListener accountStateListener)
void	registerInternalTransferListener(InternalTransferListener listener)
void	registerOpenPositionListener(OpenPositionListener openPositionListener)
void	registerOrderListener(OrderListener orderListener)
void	registerStreamFailureListener(StreamFailureListener streamFailureListener)
void	start()
void	stop()
void	subscribeListeners() Subscribes previously registered listeners.

Method Detail

registerStreamFailureListener

void registerStreamFailureListener(StreamFailureListener streamFailureListener)

start

void start()
    throws CommunicationException

Throws:

CommunicationException

registerOrderListener

void registerOrderListener(OrderListener orderListener)

registerOpenPositionListener

void registerOpenPositionListener(OpenPositionListener openPositionListener)

registerAccountStateListener

void registerAccountStateListener(AccountStateListener accountStateListener)

registerInternalTransferListener

void registerInternalTransferListener(InternalTransferListener listener)

subscribeListeners

void subscribeListeners()

Subscribes previously registered listeners. Causes a welcome package to be sent to the listeners. The welcome package includes:

• an OrderPlaced item for each pending order
• an OpenPosition item for each opened position
• an initial AccountState

The welcome package constitutes an initial state that will be modified by the subsequent events received by the listeners.

The first received AccountState marks the end of the welcome package and may be used to detect the end of initialisation.

placeOrder

void placeOrder(LimitOrderSpec limitOrderSpec)

Sends the given LimitOrderSpec to the exchange. This method is asynchronous - the fact that it returned does not guarantee that the command has been received nor processed by the exchange.

cancelOrder

void cancelOrder(OrderCancelSpec orderCancelSpec)

Sends the given OrderCancelSpec to the exchange. This method is asynchronous - the fact that it returned does not guarantee that the command has been received nor processed by the exchange.

modifyOrder

void modifyOrder(OrderModificationSpec orderModificationSpec)

Sends the given OrderModificationSpec to the exchange. This method is asynchronous - the fact that it returned does not guarantee that the command has been received nor processed by the exchange.

batch

UserStream.Batch batch()

Returns an object (not thread-safe) which may be used fluently to send a batch of OrderSpecs to the exchange. Calling UserStream.Batch.send() sends batched OrderSpecs to the exchange. This method is asynchronous - the fact that it returned does not guarantee that the commands have been received nor processed by the exchange.

batch

void batch(java.util.List<? extends OrderSpec> batch)

Sends the given list of OrderSpecs to the exchange. This method is asynchronous - the fact that it returned does not guarantee that the commands have been received nor processed by the exchange.

executeInternalTransfer

void executeInternalTransfer(InternalTransfer internalTransfer)

stop

void stop()
   throws CommunicationException

Throws:

CommunicationException