Superclass for Client and Server, which 'learns' its know-how in the derived classes. More...

#include <TcpMain.h>

Inheritance diagram for tcp::TcpMain:

[legend]

Collaboration diagram for tcp::TcpMain:

[legend]

Public Member Functions
	TcpMain (unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, int iSecTimeOut)

	TcpMain (unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, unsigned int uiDataSize, int iSecTimeOut)

virtual	~TcpMain ()

unsigned int	getPortNum () const

virtual void	setDataSize (unsigned int uiDataSize)

unsigned int	getDataSize () const

SOCKET	getMainSocket () const

virtual int	send (Message *pTcpMessage)=0

void	setTimeOutSec (int iSecTimeOut)

int	TimeOutSec ()

Public Member Functions inherited from eut::RepeatingThread
	RepeatingThread ()

virtual	~RepeatingThread ()

virtual int	start ()

virtual void	cancel ()

bool	testCancel ()

RepeatingThread::STATUS	status () const

bool	isInExclusiveAccess () const

void	setExclusiveAccess ()

void	unsetExclusiveAccess ()

int	getBreakCounter ()

virtual void	takeABreak ()

virtual void	finishBreak ()

void	waitForInput ()

void	signalInput ()

Protected Member Functions
	TcpMain ()

void	setWSACleanup () const

int	startWinsock () const

Protected Member Functions inherited from eut::RepeatingThread
void	threadWork ()

void	setStatus (STATUS eStatus)

STATUS	getStatus ()

void	toOrder (ORDER eOrder)

ORDER	getOrder ()

virtual void	work ()=0

Protected Attributes
int	m_iSecTimeOut

unsigned int	m_uiServerPort

unsigned int	m_uiDataSize

int	m_iAdressFamily

int	m_iSocketType

int	m_iProtocol

SOCKET	m_MainSocket

Private Member Functions
	TcpMain (const TcpMain &)

TcpMain &	operator= (const TcpMain &)

Static Private Attributes
static unsigned int	m_uiTcpMainCounter

Additional Inherited Members
Public Types inherited from eut::RepeatingThread
enum	EuTHREADERROR { EuTHREAD_ERR_NO_THREAD = -10301 , EuTHREAD_ERR_THREAD_ALREADY_WORKING = -10302 , EuTHREAD_ERR_THREAD_BREAK_COUNT_LESS_THAN_ZERO = -10303 , EuTHREAD_ERR_UNKNOWN = -10400 }
	Error range = -10301 to -10400 More...

enum	STATUS { eAT_THE_START , eWORKING , ePAUSING , eENDING , eCOMPLETED }

enum	ORDER { eUNDEFINED , eDO_WORK , eEXIT }

Detailed Description

Superclass for Client and Server, which 'learns' its know-how in the derived classes.

Copyright: © 2010 Helmut Jakoby

Author: Helmut Jakoby

Constructor & Destructor Documentation

◆ TcpMain() [1/4]

tcp::TcpMain::TcpMain ( )

protected

This constructor is not available.

◆ TcpMain() [2/4]

tcp::TcpMain::TcpMain	(	unsigned int	uiPort,
		int	iAdressFamily,
		int	iSocketType,
		int	iProtocol,
		int	iSecTimeOut )

Constructor with parameter passing.

Parameters

[in]	uiPort	The port of the server.
[in]	iAdressFamily	The socket address family to instantiate a socket (usually AF_INET).
[in]	iSocketType	The socket type (usually SOCK_STREAM).
[in]	iProtocol	The socket protocol (usually 0).
[in]	iSecTimeOut	The time until waiting for a connection or waiting for data is aborted.

It is started under Windows WSA.

Exceptions

eut::ErrorNException An exception is thrown if an error occurs.

◆ TcpMain() [3/4]

tcp::TcpMain::TcpMain	(	unsigned int	uiPort,
		int	iAdressFamily,
		int	iSocketType,
		int	iProtocol,
		unsigned int	uiDataSize,
		int	iSecTimeOut )

Constructor with parameter passing.

Parameters

[in]	uiPort	The port of the server.
[in]	iAdressFamily	The socket address family to instantiate a socket (usually AF_INET).
[in]	iSocketType	The socket type (usually SOCK_STREAM).
[in]	iProtocol	The socket protocol (usually 0).
[in]	uiDataSize	The packet size.
[in]	iSecTimeOut	The time until waiting for a connection or waiting for data is aborted.

It is started under Windows WSA.

Exceptions

eut::ErrorNException An exception is thrown if an error occurs.

◆ ~TcpMain()

virtual tcp::TcpMain::~TcpMain ( )

virtual

Destructor. It is terminated under Windows WSA.

◆ TcpMain() [4/4]

tcp::TcpMain::TcpMain ( const TcpMain & )

private

The copy constructor is not available.

Member Function Documentation

◆ getDataSize()

unsigned int tcp::TcpMain::getDataSize ( ) const

Returns the packet size.

◆ getMainSocket()

SOCKET tcp::TcpMain::getMainSocket ( ) const

Returns the socket.

◆ getPortNum()

unsigned int tcp::TcpMain::getPortNum ( ) const

Returns the port number.

◆ operator=()

TcpMain & tcp::TcpMain::operator= ( const TcpMain & )

private

The assignment operator is not available.

◆ send()

virtual int tcp::TcpMain::send ( Message * pTcpMessage )

pure virtual

Sends transferred Message to the counterpart.

If This is a client, the counterpart is the server. If This is a server, the counterpart is the server. Sends transferred message to the counterpart socket referenced there.

The implementation is executed in the subclass.

Parameters

[in] pTcpMessage The message to be sent.

Returns: A return < 0 indicates an error.

Implemented in tcp::Client, and tcp::Server.

◆ setDataSize()

virtual void tcp::TcpMain::setDataSize ( unsigned int uiDataSize )

virtual

Sets the packet size.

Parameters

[in] uiDataSize The package size must be greater than 0.

Exceptions

eut::ErrorNException An exception is thrown if an error occurs.

Reimplemented in tcp::Client.

◆ setTimeOutSec()

void tcp::TcpMain::setTimeOutSec ( int iSecTimeOut )

Sets the seconds to wait for responses.

Parameters

[in] iSecTimeOut The maximum waiting time.

◆ setWSACleanup()

void tcp::TcpMain::setWSACleanup ( ) const

protected

It decrements m_uiTcpMainCounter and on Windows if 0, calls WSACleanup() (closes ALL connections)

◆ startWinsock()

int tcp::TcpMain::startWinsock ( ) const

protected

It is started under Windows WSA using WSAStartup().

Returns: A return value < 0 indicates an error.

◆ TimeOutSec()

int tcp::TcpMain::TimeOutSec ( )

Returns the seconds how long the system waits for answers.

Returns: The maximum waiting time.

Member Data Documentation

◆ m_iAdressFamily

int tcp::TcpMain::m_iAdressFamily

protected

The Socket AddressFamily (usually AF_INET) to instantiate a socket.

◆ m_iProtocol

int tcp::TcpMain::m_iProtocol

protected

The socket protocol (usually 0) to instantiate a socket.

◆ m_iSecTimeOut

int tcp::TcpMain::m_iSecTimeOut

protected

Waiting time for connection responses. if not set, the wait may be eternal!

◆ m_iSocketType

int tcp::TcpMain::m_iSocketType

protected

The socket type (usually SOCK_STREAM) to instantiate a socket.

◆ m_MainSocket

SOCKET tcp::TcpMain::m_MainSocket

protected

The socket.

◆ m_uiDataSize

unsigned int tcp::TcpMain::m_uiDataSize

protected

Packets are made from the data stream; here the packet size (default is DEFAULT_DATASIZE).

◆ m_uiServerPort

unsigned int tcp::TcpMain::m_uiServerPort

protected

The port of the socket.
Further information under en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers

◆ m_uiTcpMainCounter

unsigned int tcp::TcpMain::m_uiTcpMainCounter

staticprivate

This counter is incremented each time an object of this class or subclass is instantiated. With each call to setWSACleanup() it is decremented again.

See also: setWSACleanup()

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

TcpMain.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpMain() [1/4]

◆ TcpMain() [2/4]

◆ TcpMain() [3/4]

◆ ~TcpMain()

◆ TcpMain() [4/4]

Member Function Documentation

◆ getDataSize()

◆ getMainSocket()

◆ getPortNum()

◆ operator=()

◆ send()

◆ setDataSize()

◆ setTimeOutSec()

◆ setWSACleanup()

◆ startWinsock()

◆ TimeOutSec()

Member Data Documentation

◆ m_iAdressFamily

◆ m_iProtocol

◆ m_iSecTimeOut

◆ m_iSocketType

◆ m_MainSocket

◆ m_uiDataSize

◆ m_uiServerPort

◆ m_uiTcpMainCounter