OnixS C++ FIX Engine 4.14.0
Users' manual and API documentation
Loading...
Searching...
No Matches
Stack Class Reference

#include <OnixS/FIXEngine/FIX/TcpStandardStack.h>

Public Member Functions

 Stack ()
 Stack (const Stack &)=delete
 Stack (Stack &&)=delete
Stack & operator= (const Stack &)=delete
Stack & operator= (Stack &&)=delete
 ~Stack ()
void dispatchEvents () override
bool isQuiescent () const override
Threading::ThreadId threadId () const override
ReactorType::Enum type () const override
Public Member Functions inherited from ISessionReactor
virtual ~ISessionReactor ()=default

Friends

class FIX::ReactorOperator

Detailed Description

A high-level wrapper over the TCP standard stack.

Definition at line 34 of file TcpStandardStack.h.

Constructor & Destructor Documentation

◆ Stack() [1/3]

Stack ( )

Allocates a TCP stack.

◆ Stack() [2/3]

Stack ( const Stack & )
delete

◆ Stack() [3/3]

Stack ( Stack && )
delete

◆ ~Stack()

~Stack ( )

Member Function Documentation

◆ dispatchEvents()

void dispatchEvents ( )
inlineoverridevirtual

Processes events on a stack and performs the necessary handling.

These events include transmit and receive events raised by the hardware, and also software events such as TCP and FIX protocol timers.

Warning
The event dispatching should be performed from the same thread that created the stack.

Implements ISessionReactor.

Definition at line 58 of file TcpStandardStack.h.

◆ isQuiescent()

bool isQuiescent ( ) const
inlineoverridevirtual
Returns
a boolean value indicating whether a stack is quiescent.

This can be used to ensure that all connections have been closed gracefully before the destroying of a stack (or exiting the application). The destroying of a stack while it is not quiescent is permitted by the API, but when doing so there is no guarantee that sent data has been acknowledged by the peer or even transmitted, and there is the possibility that peers' connections will be reset.

Implements ISessionReactor.

Definition at line 75 of file TcpStandardStack.h.

◆ operator=() [1/2]

Stack & operator= ( const Stack & )
delete

◆ operator=() [2/2]

Stack & operator= ( Stack && )
delete

◆ threadId()

Threading::ThreadId threadId ( ) const
inlineoverridevirtual
Returns
the ID of the thread that created the stack.

Implements ISessionReactor.

Definition at line 84 of file TcpStandardStack.h.

◆ type()

ReactorType::Enum type ( ) const
inlineoverridevirtual
Returns
The type of the stack.

Implements ISessionReactor.

Definition at line 88 of file TcpStandardStack.h.

◆ FIX::ReactorOperator

friend class FIX::ReactorOperator
friend

Definition at line 102 of file TcpStandardStack.h.