TcpStandardStack Class Reference

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

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

Friends
class	SessionImpl

Detailed Description

A high-level wrapper over the TCP standard stack.

Definition at line 31 of file TcpStandardStack.h.

Constructor & Destructor Documentation

TcpStandardStack() [1/3]

TcpStandardStack

(

)

Allocates a TCP stack.

TcpStandardStack() [2/3]

TcpStandardStack ( const TcpStandardStack & )

delete

TcpStandardStack() [3/3]

TcpStandardStack ( TcpStandardStack && )

delete

~TcpStandardStack()

~TcpStandardStack ( )

override

Member Function Documentation

dispatchEvents()

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.

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 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.

operator=() [1/2]

TcpStandardStack & operator= ( const TcpStandardStack & )

delete

operator=() [2/2]

TcpStandardStack & operator= ( TcpStandardStack && )

delete

type()

ReactorType::Enum type ( ) const

inlineoverridevirtualnoexcept

Returns

the type of the stack.

Implements SessionReactor.

Definition at line 79 of file TcpStandardStack.h.

workingThreadId()

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 Symbol Documentation

SessionImpl

friend class SessionImpl

friend

Definition at line 98 of file TcpStandardStack.h.