OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.13.1
API documentation
MessageInfo Struct Reference

#include <MessageInfo.h>

Public Member Functions

 MessageInfo ()
std::string toString () const

Public Attributes

FeedId feedId
short sessionNumber
int blockSequenceNumber
int numberOfMessages
int sequenceNumber
DateTime rawSentTime
Timestamp receiveTime
bool isMessageReceivedDuringSnapshot
bool isBundled

Detailed Description

Definition at line 31 of file MessageInfo.h.

Constructor & Destructor Documentation

Initialize default instance.

Member Function Documentation

std::string toString ( ) const

Returns string representation.

Member Data Documentation

int blockSequenceNumber

Sequence number of message block.

Definition at line 47 of file MessageInfo.h.

FeedId feedId

Feed identifier.

Definition at line 37 of file MessageInfo.h.

bool isBundled

Bundle marker.

This field is true if messages has been received within bundle (see BundleMarker)

Definition at line 79 of file MessageInfo.h.

bool isMessageReceivedDuringSnapshot

Is message received during snapshot?

Definition at line 74 of file MessageInfo.h.

int numberOfMessages

Number of messages in message block.

Definition at line 50 of file MessageInfo.h.

DateTime rawSentTime

Raw timestamp of when the message block is sent.

It is the number of nanoseconds since Jan 1st, 1970, 00:00:00 GMT.

Definition at line 63 of file MessageInfo.h.

Timestamp receiveTime

Time when the UDP packet was received by the Handler.

When market data is being replayed, this member contains time of corresponding log file entry. That's the value returned represents the original time when market data message was obtained from the network.

Definition at line 71 of file MessageInfo.h.

int sequenceNumber

Each message is assigned a sequence number that increases monotonically on the server side. To save bandwidth, the sequence number is a field in the block header, instead of every message. The sequence number for the first message is used in the header, and the client is expected to derive the sequence numbers for subsequent messages in the block. In the case of a heartbeat which includes only header in the block, the expected next sequence number is used.

Definition at line 58 of file MessageInfo.h.

short sessionNumber

The session number is used so that a client can easily detect when a new session has started after the daily maintenance window or failure on the server side. It should stay the same for a given multicast channel until a new session has started. It should be noted that the same number can be used by different multicast channels.

Definition at line 44 of file MessageInfo.h.

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