TcpDirectStack Class Reference

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

Public Member Functions
	TcpDirectStack (const TcpDirectAttr &attr)
	TcpDirectStack (const TcpDirectStack &)=delete
TcpDirectStack &	operator= (const TcpDirectStack &)=delete
	TcpDirectStack (TcpDirectStack &&)=delete
TcpDirectStack &	operator= (TcpDirectStack &&)=delete
	~TcpDirectStack () override
void	dispatchEvents () noexcept override
bool	isQuiescent () const noexcept 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 TCPDirect network stack.

Definition at line 35 of file TcpDirectStack.h.

Constructor & Destructor Documentation

TcpDirectStack() [1/3]

TcpDirectStack ( const TcpDirectAttr & attr )

explicit

Allocates a stack with the supplied attributes.

Parameters

attr	A set of properties to apply to the stack.

A stack binds to a single network interface, specified by the interface attribute in attr.

Relevant attributes to set in attr are those in the zf_stack, zf_pool and zf_vi categories described in the attributes documentation.

Exceptions

std::bad_alloc	Out of memory. N.B. TCPDirect API requires huge pages.
std::runtime_error	the TCPDirect library reported an error, see the error text.
std::exception	System call reported an error, see the error text.

TcpDirectStack() [2/3]

TcpDirectStack ( const TcpDirectStack & )

delete

TcpDirectStack() [3/3]

TcpDirectStack ( TcpDirectStack && )

delete

~TcpDirectStack()

~TcpDirectStack ( )

override

Member Function Documentation

dispatchEvents()

void dispatchEvents ( )

inlineoverridevirtualnoexcept

This function 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 timers.

Please see the "Stack polling" section in the TCPDirect User Guide for further information.

Implements SessionReactor.

Definition at line 70 of file TcpDirectStack.h.

isQuiescent()

bool isQuiescent ( ) const

inlineoverridevirtualnoexcept

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.

Note

When using the Windows TCPDirect emulator, destroying a stack while it is not quiescent may cause a memory leak.

Implements SessionReactor.

Definition at line 84 of file TcpDirectStack.h.

operator=() [1/2]

TcpDirectStack & operator= ( const TcpDirectStack & )

delete

operator=() [2/2]

TcpDirectStack & operator= ( TcpDirectStack && )

delete

type()

ReactorType::Enum type ( ) const

inlineoverridevirtualnoexcept

Returns

the type of the stack.

Implements SessionReactor.

Definition at line 94 of file TcpDirectStack.h.

workingThreadId()

Threading::ThreadId workingThreadId ( ) const

inlineoverridevirtualnoexcept

Returns

The Id of the thread that created the stack.

Implements SessionReactor.

Definition at line 90 of file TcpDirectStack.h.

Friends And Related Symbol Documentation

SessionImpl

friend class SessionImpl

friend

Definition at line 113 of file TcpDirectStack.h.