OnixS CME Drop Copy Handler C++ library 5.7.1
API documentation
Loading...
Searching...
No Matches
Handler Class Reference

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()

Handler ( const HandlerSettings & settings)

Initialize instance.

Parameters
settingsHandler settings.

◆ ~Handler()

~Handler ( )

Finalize instance.

Member Function Documentation

◆ inSeqNum() [1/2]

int inSeqNum ( ) const

Gets an expected sequence number of the next incoming message.

Returns
The expected sequence number of the next incoming message.

◆ inSeqNum() [2/2]

void inSeqNum ( int seqNum)

Sets an expected sequence number of the next incoming message.

Parameters
seqNumThe expected sequence number of the next incoming message.

◆ logDebug()

void logDebug ( const std::string & message)

Log a debug message.

Parameters
messageMessage.

◆ logError()

void logError ( const std::string & message)

Log an error message.

Parameters
messageMessage.

◆ logMessage()

void logMessage ( const std::string & message)

Log an information message.

Parameters
messageMessage.

◆ logon()

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.

◆ logout()

void logout ( )

Logout from CME drop copy session.

◆ logWarning()

void logWarning ( const std::string & message)

Log a warning message.

Parameters
messageMessage.

◆ outSeqNum() [1/2]

int outSeqNum ( ) const

Gets a sequence number of the next outgoing message.

Returns
The sequence number of the next outgoing message.

◆ outSeqNum() [2/2]

void outSeqNum ( int seqNum)

Sets a sequence number of the next outgoing message.

Parameters
seqNumThe sequence number of the next outgoing message.

◆ registerDropCopyServiceListener()

void registerDropCopyServiceListener ( DropCopyServiceListener * listener)

Register the Handler state change listener.

Parameters
listenerDropCopy service listener.

◆ registerErrorListener()

void registerErrorListener ( ErrorListener * listener)

Register the error listener.

Parameters
listenerError listener.

◆ registerHandlerStateChangeListener()

void registerHandlerStateChangeListener ( HandlerStateChangeListener * listener)

Register the Handler state change listener.

Parameters
listenerHandler state change listener.

◆ registerWarningListener()

void registerWarningListener ( WarningListener * listener)

Register the warning listener.

Parameters
listenerWarning listener.

◆ reset()

void reset ( )

Reset session sequence numbers and stored application feed IDs.

◆ version()

const std::string & version ( )
static

Returns Handler's version.