ComDeviceNetwork Class Reference

#include <ComDeviceNetwork.h>

Inheritance diagram for ComDeviceNetwork:

Classes
struct	ClientConnection_t
	client-connection More...

Public Types
enum	ConnectionMode_t { CM_SERVER , CM_CLIENT }
	connection-mode More...
enum	ConnectionState_t { CS_DISCONNECTED , CS_LISTENING , CS_WAIT_FOR_CONNECT , CS_CONNECTED }
	state of the connection More...

Public Member Functions
	ComDeviceNetwork (const eC_String &kIPAddress, const eC_UShort &uiPort)
	ComDeviceNetwork (const eC_UShort &uiPort)
virtual	~ComDeviceNetwork ()
virtual void	Close ()
virtual eC_Bool	Open ()
virtual eC_Bool	Process ()
virtual eC_Bool	Send (char *pkBuffer, const eC_UInt &uiBufferSize)
Public Member Functions inherited from ComDevice
virtual void	Close ()=0
virtual eC_Bool	DataReceived (char *pkData, const eC_UInt &uiDataSize)=0
virtual eC_Bool	Open ()=0
virtual eC_Bool	Process ()=0
virtual eC_Bool	Send (char *pkBuffer, const eC_UInt &uiBufferSize)=0

Protected Member Functions
eC_Bool	ClientConnect ()
eC_Bool	IsConnected () const

Detailed Description

this class is used for sending and receiving data via a network

Member Enumeration Documentation

ConnectionMode_t

enum ComDeviceNetwork::ConnectionMode_t

connection-mode

Enumerator
CM_SERVER	server
CM_CLIENT	client

ConnectionState_t

enum ComDeviceNetwork::ConnectionState_t

state of the connection

Enumerator
CS_DISCONNECTED	disconnected
CS_LISTENING	listening
CS_WAIT_FOR_CONNECT	created, waiting for connect
CS_CONNECTED	connected

Constructor & Destructor Documentation

ComDeviceNetwork() [1/2]

ComDeviceNetwork::ComDeviceNetwork	(	const eC_String &	kIPAddress,
		const eC_UShort &	uiPort
	)

constructor

Parameters

kIPAddress	targetip
uiPort	target port-number

ComDeviceNetwork() [2/2]

ComDeviceNetwork::ComDeviceNetwork

(

const eC_UShort &

uiPort

)

constructor

Parameters

uiPort

target port-number

~ComDeviceNetwork()

virtual ComDeviceNetwork::~ComDeviceNetwork ( )

virtual

destructor

Member Function Documentation

ClientConnect()

eC_Bool ComDeviceNetwork::ClientConnect ( )

protected

establish client-connection

Returns

true if connected

Close()

virtual void ComDeviceNetwork::Close ( )

virtual

close the device

Implements ComDevice.

IsConnected()

eC_Bool ComDeviceNetwork::IsConnected ( ) const

protected

check if connected

Returns

true if connected

Open()

virtual eC_Bool ComDeviceNetwork::Open ( )

virtual

open the device

Returns

true if successful

Implements ComDevice.

Process()

virtual eC_Bool ComDeviceNetwork::Process ( )

virtual

process the device

Returns

true if successful

Implements ComDevice.

Send()

virtual eC_Bool ComDeviceNetwork::Send ( char *  pkBuffer, const eC_UInt &  uiBufferSize  )

virtual

send data via device

Parameters

pkBuffer	buffer of data
uiBufferSize	length of buffer in bytes

Returns

true if successful

Implements ComDevice.

---

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

• ComDeviceNetwork.h