OnixS C++ CME iLink 3 Binary Order Entry Handler  1.14.0
API Documentation
TerminateErrorCode Struct Reference

#include <OnixS/CME/iLink3/ValuesEnums.h>

Public Types

enum  Enum {
  NotSet = 255, Finished = 0, Unnegotiated = 2, NotEstablished = 3,
  AlreadyNegotiated = 4, NegotiationInProgress = 5, AlreadyEstablished = 6, EstablishInProgress = 7,
  CMEAdministeredPortClosure = 8, VolumeControls = 9, InvalidNextSeqNo = 10, InvalidMsgSeqNo = 11,
  InvalidLastSeqNo = 12, InvalidUUID = 13, InvalidTimestamp = 14, RequiredUUIDMisssing = 15,
  RequiredRequestTimestampMissing = 16, RequiredCodeMisssing = 17, InvalidSOFH = 18, DecodingError = 19,
  KeepAliveIntervalLapsed = 20, RequiredNextSeqNoMissing = 21, RequiredKeepAliveIntervalLapsedMissing = 22, NonNegotiate = 23,
  TerminateInProgress = 24, Other = 25, DisconnectFromPrimary = 26
}
 

Static Public Member Functions

static const char * toString (Enum value) noexcept
 
static TerminateErrorCode::Enum toErrorCode (unsigned short value) noexcept
 

Detailed Description

Definition at line 183 of file ValuesEnums.h.

Member Enumeration Documentation

enum Enum
Enumerator
NotSet 

The value is not set.

Finished 

session is being terminated without finalization

Unnegotiated 

Sending any message when session has not been Negotiated.

NotEstablished 

Sending any message (except Negotiate) when session has not been established.

AlreadyNegotiated 

NegotiationResponse was already sent; Negotiate was redundant.

NegotiationInProgress 

Previous Negotiate still being processed; Wait for NegotiationResponse or timeout.

AlreadyEstablished 

EstablishmentAck was already sent; Establish was redundant.

EstablishInProgress 

Previous Establish still being processed; Wait for EstablishmentAck or timeout.

CMEAdministeredPortClosure 

due to invalid number of Negotiate: Establish attempts being exceeded

VolumeControls 

exceeding TPS limit as defined for volume controls (logout action)

InvalidNextSeqNo 

value is not greater than the one last used for same UUID or value sent by the client is out of acceptable range (MIN, MAX)

InvalidMsgSeqNo 

value is lower than the last one used for the same UUID or value is not initialized to 1 at the beginning of the week or value sent by the client is out of acceptable range (MIN, MAX)

InvalidLastSeqNo 

value is lower than the last one used for the same UUID or value sent by the client is out of acceptable range (MIN, MAX)

InvalidUUID 

UUID value does not match current UUID or value sent by the client is out of acceptable range (MIN, MAX)

InvalidTimestamp 

Timestamp value does not match with RequestTimestamp sent by CME or value sent by the client is out of acceptable range (MIN, MAX)

RequiredUUIDMisssing 

null value in UUID field

RequiredRequestTimestampMissing 

null value in RequestTimestamp field

RequiredCodeMisssing 

null value in Code field

InvalidSOFH 

Invalid message length or invalid encoding type specified.

DecodingError 

Incoming message could not be decoded.

KeepAliveIntervalLapsed 

KeepAliveInterval has lapsed without any response so terminating session.

RequiredNextSeqNoMissing 

null value in NextSeqNo field

RequiredKeepAliveIntervalLapsedMissing 

null value in KeepAliveIntervalLapsed field

NonNegotiate 

Establish message received when not Negotiated: Established.

TerminateInProgress 

Previous Terminate still being processed; Wait for Terminate or timeout.

Other 

any other error condition not mentioned above

DisconnectFromPrimary 

Backup session will be terminated as well.

Definition at line 185 of file ValuesEnums.h.

Member Function Documentation

static TerminateErrorCode::Enum toErrorCode ( unsigned short  value)
inlinestaticnoexcept
Returns
The TerminateErrorCode::Enum value that corresponds to the given integer value.

Definition at line 220 of file ValuesEnums.h.

static const char* toString ( Enum  value)
staticnoexcept
Returns
a string that represents the given value.

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