PackedMsg class provides API to pack messages. More...
Public Member Functions | |
Constructor | |
PackedMsg (OmmProvider &ommProvider) | |
More... | |
Destructor | |
class | OmmNiProviderImpl |
class | OmmIProviderImpl |
virtual | ~PackedMsg () |
More... | |
PackedMsg & | initBuffer () |
More... | |
PackedMsg & | initBuffer (UInt32 maxSize) |
More... | |
PackedMsg & | initBuffer (UInt64 clientHandle) |
More... | |
PackedMsg & | initBuffer (UInt64 clientHandle, UInt32 maxSize) |
More... | |
PackedMsg & | addMsg (const Msg &msg, UInt64 itemHandle) |
More... | |
UInt64 | remainingSize () const |
More... | |
UInt64 | packedMsgCount () const |
More... | |
UInt64 | maxSize () const |
More... | |
PackedMsg & | clear () |
More... | |
PackedMsg contains a list of messages packed to be sent across the wire together.
Definition at line 67 of file PackedMsg.h.
refinitiv::ema::access::PackedMsg::PackedMsg | ( | OmmProvider & | ommProvider | ) |
Create an PackedMsg with OmmProvider. Set up default values for packed data variables.
[in] | OmmProvider | instance. |
OmmMemoryExhaustionException | if the application runs out of memory. |
|
virtual |
Destructor.
Adds a Msg to the packed message buffer if there is enough space in the buffer to add the Msg.
[in] | Msg | msg message to add to this packed message. |
[in] | long | itemHandle which is related to the packed message. |
OmmInvalidUsageException | if the connection is not established. |
OmmInvalidUsageException | if item handle is not set. |
OmmInvalidUsageException | if incoming message is empty. |
OmmInvalidUsageException | if not possible to allocate memory for StreamInfo Non-Interactive Provider. |
OmmInvalidUsageException | if fail to encode incoming message. |
OmmInvalidUsageException | if not possible to add messages to packed buffer. |
PackedMsg& refinitiv::ema::access::PackedMsg::clear | ( | ) |
Clears the entries in the PackedMessage.
PackedMsg& refinitiv::ema::access::PackedMsg::initBuffer | ( | ) |
For Non-Interactive Provider applications, initialize a new write buffer. The size of the new packed messages write buffer will be set to its default size.
OmmInvalidUsageException | if the user tries to call this method with Interactive Provider. |
OmmInvalidUsageException | if connection is not established. |
OmmInvalidUsageException | if not possible to allocate buffer for packed message. |
For Non-Interactive Provider applications, initialize a new write buffer. Also sets the maximum size of the new packed messages write buffer.
[in] | UInt32 | maxSize maximum size of the packed message buffer. |
OmmInvalidUsageException | if the user tries to call this method with Interactive Provider. |
OmmInvalidUsageException | if connection is not established. |
OmmInvalidUsageException | if not possible to allocate buffer for packed messages. |
For Interactive Provider applications, initialize a new write buffer and sets the client handle for this PackedMsg to submit messages to. The size of the new packed messages write buffer will be set to its default size. The handle is required to be set before adding messages or submitting the packedMsg. The size of the packed message buffer will be set to its default size.
[in] | UInt64 | clientHandle unique client identifier associated by EMA with a connected client. |
OmmInvalidUsageException | if the user tries to call this method with Non-Interactive Provider. |
OmmInvalidUsageException | if client handle is not valid. |
OmmInvalidUsageException | if not possible to allocate buffer for packed message. |
For Interactive Provider applications, initialize a new write buffer and sets the client handle for this PackedMsg to submit messages to. Also sets the maximum size of the new packed messages write buffer. The handle is required to be set before adding messages or submitting the packedMsg. Also sets the maximum size of the packed message buffer.
[in] | UInt64 | clientHandle unique client identifier associated by EMA with a connected client. |
[in] | UInt32 | maxSize maximum size of the packed message buffer. |
OmmInvalidUsageException | if the user tries to call this method with Non-Interactive Provider. |
OmmInvalidUsageException | if client handle is not valid. |
OmmInvalidUsageException | if not possible to allocate buffer for packed message. |
UInt64 refinitiv::ema::access::PackedMsg::maxSize | ( | ) | const |
Return int value of maximum size of the packed message buffer.
UInt64 refinitiv::ema::access::PackedMsg::packedMsgCount | ( | ) | const |
Returns int value of amount of currently packed messages in this PackedMsg object.
UInt64 refinitiv::ema::access::PackedMsg::remainingSize | ( | ) | const |
Returns int value of remaining size in the buffer available for message packing.
![]() |
![]() |
|