OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
TcpStandardStack Class Referencefinal

#include <OnixS/B3/BOE/TcpStandardStack.h>

Public Member Functions

 TcpStandardStack ()
 
 TcpStandardStack (const TcpStandardStack &)=delete
 
 TcpStandardStack (TcpStandardStack &&)=delete
 
TcpStandardStackoperator= (const TcpStandardStack &)=delete
 
TcpStandardStackoperator= (TcpStandardStack &&)=delete
 
 ~TcpStandardStack () override
 
void dispatchEvents () override
 
bool isQuiescent () const override
 
Threading::ThreadId workingThreadId () const noexceptoverride
 
ReactorType::Enum type () const noexceptoverride
 
- Public Member Functions inherited from SessionReactor
virtual ~SessionReactor ()=default
 

Friends

class SessionImpl
 

Detailed Description

Definition at line 31 of file TcpStandardStack.h.

Constructor & Destructor Documentation

Allocates a TCP stack.

TcpStandardStack ( const TcpStandardStack )
delete
~TcpStandardStack ( )
override

Member Function Documentation

void dispatchEvents ( )
inlineoverridevirtual

Processes events on a stack and performs the necessary handling.

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

Implements SessionReactor.

Definition at line 56 of file TcpStandardStack.h.

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 destroying a stack (or exiting the application). Destroying 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 SessionReactor.

Definition at line 68 of file TcpStandardStack.h.

TcpStandardStack& operator= ( const TcpStandardStack )
delete
TcpStandardStack& operator= ( TcpStandardStack &&  )
delete
ReactorType::Enum type ( ) const
inlineoverridevirtualnoexcept
Returns
the type of the stack.

Implements SessionReactor.

Definition at line 79 of file TcpStandardStack.h.

Threading::ThreadId workingThreadId ( ) const
inlineoverridevirtualnoexcept
Returns
the ID of the thread that created the stack.

Implements SessionReactor.

Definition at line 75 of file TcpStandardStack.h.

Friends And Related Function Documentation

friend class SessionImpl
friend

Definition at line 98 of file TcpStandardStack.h.


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