OnixS C++ CBOE CFE Binary Order Entry (BOE) Handler  1.11.0
API documentation
Handler Class Reference

#include <OnixS/CboeCFE/Trading/BOE/Handler.h>

Public Member Functions

 Handler (const HandlerSettings &settings)
 
virtual ~Handler ()
 
void connect (const LogonSettings &logonSettings, const std::string &hostName, Port port, const std::string &localNetworkInterface="", const PortRange &localPortRange=PortRange(0, 0))
 
void disconnect ()
 
void disconnectAsync ()
 
Port localPort ()
 
void registerErrorListener (ErrorListener *listener)
 
void registerWarningListener (WarningListener *listener)
 
void registerHandlerStateListener (HandlerStateListener *listener)
 
void registerSessionListener (SessionListener *listener)
 
void registerMessageListener (MessageListener *listener)
 
void registerReplayListener (ReplayListener *listener)
 
UInt32 send (const OutgoingMessage &)
 
void warmup (OutgoingMessage &, int warmupFlags=0)
 
void nextSendingSeqNum (SeqNumber value)
 
SeqNumber nextSendingSeqNum ()
 
HandlerState::Enum state () const
 
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 CBOE CFE Binary Order Entry (BOE) Handler

Definition at line 50 of file Handler.h.

Constructor & Destructor Documentation

Handler ( const HandlerSettings settings)
explicit

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

void connect ( const LogonSettings logonSettings,
const std::string &  hostName,
Port  port,
const std::string &  localNetworkInterface = "",
const PortRange localPortRange = PortRange(0, 0) 
)

Establishes the connection.

Note
Blocks until the logon reply is received.
Should be called only when Handler is disconnected.
Parameters
logonSettingsInitial logon message parameters.
hostNameHostname to connect to.
portPort number to connect to.
localNetworkInterfaceLocal network interface.
localPortRangeRange to choose local port from.
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.

Port localPort ( )
Returns
the local network port number.
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.

void nextSendingSeqNum ( SeqNumber  value)

Sets the next sequence number for sending messages.

SeqNumber nextSendingSeqNum ( )

Gets the next sequence number for sending messages.

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 registerMessageListener ( MessageListener listener)

Assigns listener for message 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 registerReplayListener ( ReplayListener listener)

Assigns listener for message 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 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 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
UInt32 send ( const OutgoingMessage )
HandlerState::Enum state ( ) const

Returns handler state.

static const std::string version ( )
static

Returns Handler's version.

void warmup ( OutgoingMessage ,
int  warmupFlags = 0 
)

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