OnixS CME Drop Copy Handler C++ library  5.4.1
API documentation
Handler Class Reference

#include <OnixS/CME/DropCopy/Handler.h>

Public Member Functions

 Handler (const HandlerSettings &settings)
 
 ~Handler ()
 
void logDebug (const std::string &message)
 
void logError (const std::string &message)
 
void logMessage (const std::string &message)
 
void logWarning (const std::string &message)
 
void registerErrorListener (ErrorListener *listener)
 
void registerWarningListener (WarningListener *listener)
 
void registerHandlerStateChangeListener (HandlerStateChangeListener *listener)
 
void registerDropCopyServiceListener (DropCopyServiceListener *listener)
 
void logon (const std::string &host, int port, const std::string &accessKeyId, const std::string &secretKey)
 
void logout ()
 
void reset ()
 
int inSeqNum () const
 
void inSeqNum (int seqNum)
 
int outSeqNum () const
 
void outSeqNum (int seqNum)
 

Static Public Member Functions

static const std::string & version ()
 

Detailed Description

Definition at line 34 of file Handler.h.

Constructor & Destructor Documentation

Handler ( const HandlerSettings settings)

Initialize instance.

Parameters
settingsHandler settings.
~Handler ( )

Finalize instance.

Member Function Documentation

int inSeqNum ( ) const

Gets an expected sequence number of the next incoming message.

Returns
The expected sequence number of the next incoming message.
void inSeqNum ( int  seqNum)

Sets an expected sequence number of the next incoming message.

Parameters
seqNumThe expected sequence number of the next incoming message.
void logDebug ( const std::string &  message)

Log a debug message.

Parameters
messageMessage.
void logError ( const std::string &  message)

Log an error message.

Parameters
messageMessage.
void logMessage ( const std::string &  message)

Log an information message.

Parameters
messageMessage.
void logon ( const std::string &  host,
int  port,
const std::string &  accessKeyId,
const std::string &  secretKey 
)

Logon to CME DropCopy session.

Parameters
hostCME Session host.
portCME Session port.
accessKeyIdCME access key ID.
secretKeyCME secret key.
void logout ( )

Logout from CME drop copy session.

void logWarning ( const std::string &  message)

Log a warning message.

Parameters
messageMessage.
int outSeqNum ( ) const

Gets a sequence number of the next outgoing message.

Returns
The sequence number of the next outgoing message.
void outSeqNum ( int  seqNum)

Sets a sequence number of the next outgoing message.

Parameters
seqNumThe sequence number of the next outgoing message.
void registerDropCopyServiceListener ( DropCopyServiceListener listener)

Register the Handler state change listener.

Parameters
listenerDropCopy service listener.
void registerErrorListener ( ErrorListener listener)

Register the error listener.

Parameters
listenerError listener.
void registerHandlerStateChangeListener ( HandlerStateChangeListener listener)

Register the Handler state change listener.

Parameters
listenerHandler state change listener.
void registerWarningListener ( WarningListener listener)

Register the warning listener.

Parameters
listenerWarning listener.
void reset ( )

Reset session sequence numbers and stored application feed IDs.

static const std::string& version ( )
static

Returns Handler's version.


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