OnixS C++ MTS Cash SDP Handler  1.6.1.20
API documentation
Handler Class Reference

#include <Handler.h>

Public Member Functions

 Handler (const HandlerSettings &settings)
 
virtual ~Handler ()
 
void connect (const ConnectionSettings &connectionSettings, const LogonSettings &logonSettings, const std::string &hostName, UInt16 port, const std::string &localNetworkInterface="")
 
void disconnect ()
 
void disconnectAsync ()
 
void replay (const ReplayOptions &options)
 
void requestAddressServiceInformation ()
 
void subscribe (ClassId::Enum classId, SubscribeType::Enum subscribeType=SubscribeType::All)
 
void subscribeFiltered (ClassId::Enum classId, UInt32 filterKey, SubscribeType::Enum subscribeType=SubscribeType::All)
 
void unsubscribe (ClassId::Enum classId)
 
UInt32 act (ActionType::Enum actionType, Class *msg, bool dataInResponse=false)
 
UInt32 addFilter (UInt32 filterId, const std::string &value)
 
void registerErrorListener (ErrorListener *listener)
 
void registerWarningListener (WarningListener *listener)
 
void registerHandlerStateListener (HandlerStateListener *listener)
 
void registerSessionListener (SessionListener *listener)
 
void registerServiceAddressInformationListener (ServiceAddressInformationListener *listener)
 
void registerAdminMessageListener (AdminMessageListener *listener)
 
void registerClassListener (ClassListener *listener)
 
void registerActResultListener (ActResultListener *listener)
 
void registerSubscriptionListener (SubscriptionListener *listener)
 
HandlerState::Enum state () const
 
UInt32 outboundQueueBytes ()
 
void log (LogLevel::Enum logLevel, const char *logMessage, size_t length)
 
void log (LogLevel::Enum logLevel, const char *logMessage)
 
void log (LogLevel::Enum logLevel, const std::string &str)
 
const std::string & licenseExpirationDate () const
 

Static Public Member Functions

static const std::string version ()
 

Detailed Description

OnixS MTS Cash/SDP Handler

Definition at line 38 of file Handler.h.

Constructor & Destructor Documentation

Handler ( const HandlerSettings settings)

Performs instance initialization.

Parameters
settingsdefines values for various options which affect handler behavior like enabling logging during execution of the handler.
virtual ~Handler ( )
virtual

Member Function Documentation

UInt32 act ( ActionType::Enum  actionType,
Class msg,
bool  dataInResponse = false 
)

perform action

Parameters
UInt32 addFilter ( UInt32  filterId,
const std::string &  value 
)

add filter return filter key

void connect ( const ConnectionSettings connectionSettings,
const LogonSettings logonSettings,
const std::string &  hostName,
UInt16  port,
const std::string &  localNetworkInterface = "" 
)

Establishes the connection.

Note
Blocks until the logon reply is received.
Should be called only when Handler is disconnected.
Parameters
hostNameHostname to connect to.
portPort number to connect to.
logonInitial logon message parameters.
localNetworkInterfaceLocal network interface.
Exceptions
std::exceptionCannot set the local network interface.
std::exceptionCannot connect to hostname on port.
std::exceptionCannot configure size of receive buffer for the socket.
std::exceptionCannot configure size of send buffer for the socket.
OperationExceptionInvalid argument is given.
void disconnect ( )

Force session disconnect.

Note
Blocks until the Session Logout procedure is finished.
void disconnectAsync ( )

Async force session disconnect.

const std::string& licenseExpirationDate ( ) const

Returns the license expiration date.

void log ( LogLevel::Enum  logLevel,
const char *  logMessage,
size_t  length 
)

Logs the given user-level message to the handler log.

void log ( LogLevel::Enum  logLevel,
const char *  logMessage 
)

Logs the given user-level message to the handler log

void log ( LogLevel::Enum  logLevel,
const std::string &  str 
)

Logs the given user-level message to the handler log.

UInt32 outboundQueueBytes ( )

return outbound queue size

void registerActResultListener ( ActResultListener listener)

Assigns listener for action result events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerAdminMessageListener ( AdminMessageListener listener)

Assigns listener for administrative events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerClassListener ( ClassListener listener)

Assigns listener for exchange events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerErrorListener ( ErrorListener listener)

Assigns listener for errors occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected
void registerHandlerStateListener ( HandlerStateListener listener)

Assigns listener for state change events occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerServiceAddressInformationListener ( ServiceAddressInformationListener listener)

Assigns listener for notification abaout address service information. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerSessionListener ( SessionListener listener)

Assigns listener for session events occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerSubscriptionListener ( SubscriptionListener listener)

Assigns listener for action result events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected.
void registerWarningListener ( WarningListener listener)

Assigns listener for warnings occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions
OperationExceptionif handler not disconnected
void replay ( const ReplayOptions options)

Replays previously logged data.

void requestAddressServiceInformation ( )

Request address service information

Note
The requested information will be provided by ServiceAddressInformationListener::onServiceAddressInformation callback.
Exceptions
OperationExceptionAttempt to send data before connection creation
std::exceptionwith system dependent message if requesting has been failed
HandlerState::Enum state ( ) const

Returns handler state.

void subscribe ( ClassId::Enum  classId,
SubscribeType::Enum  subscribeType = SubscribeType::All 
)

subscribe to market information

Parameters
classIdClassId to subscribe to.
Note
The subscribed information will be provided by corresponding callbacks.
Exceptions
OperationExceptionAttempt to send data before connection creation
std::exceptionwith system dependent message if requesting has been failed
void subscribeFiltered ( ClassId::Enum  classId,
UInt32  filterKey,
SubscribeType::Enum  subscribeType = SubscribeType::All 
)

subscribe to market information with filter

void unsubscribe ( ClassId::Enum  classId)

unsubscribe from market information

Parameters
classIdClassId to unsubscribe from.
Exceptions
OperationExceptionAttempt to send data before connection creation
std::exceptionwith system dependent message if requesting has been failed
static const std::string version ( )
static

Returns Handler's version.


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