ESocket::Base< TQueue, TMessage > Class Template Reference

The base socket class. More...

#include <esocket.h>

Inheritance diagram for ESocket::Base< TQueue, TMessage >:

Public Member Functions
virtual	~Base ()
	Virtual class destructor. More...
Thread< TQueue, TMessage > &	getThread ()
	Retrieves the socket thread that this socket is associated with. More...
SocketType	getSocketType ()
	Retrieves the socket type. More...
Int	getFamily ()
	Retrieves the address family. More...
Int	getType ()
	Retrieves the socket type. More...
Int	getProtocol ()
	Retrieves the protocol. More...
Int	getError ()
	Retrieves the last error value. More...
Void	close ()
	Closes this socket. More...
virtual Void	disconnect ()
	Disconnects this socket. More...
Int	getHandle ()
	Retrieves the socket file handle. More...
cpStr	getStateDescription (SocketState state)
	Retrieves the description of the connection state. More...

Friends
class	TCP::Talker< TQueue, TMessage >
class	TCP::Listener< TQueue, TMessage >
class	UDP< TQueue, TMessage >
class	Thread< TQueue, TMessage >

Detailed Description

template<class TQueue, class TMessage>
class ESocket::Base< TQueue, TMessage >

The base socket class.

Constructor & Destructor Documentation

~Base()

template<class TQueue, class TMessage>

virtual ESocket::Base< TQueue, TMessage >::~Base ( )

inlinevirtual

Virtual class destructor.

Member Function Documentation

close()

template<class TQueue, class TMessage>

Void ESocket::Base< TQueue, TMessage >::close ( )

inline

Closes this socket.

disconnect()

template<class TQueue, class TMessage>

virtual Void ESocket::Base< TQueue, TMessage >::disconnect ( )

inlinevirtual

Disconnects this socket.

Reimplemented in ESocket::UDP< TQueue, TMessage >, and ESocket::TCP::Talker< TQueue, TMessage >.

getError()

template<class TQueue, class TMessage>

Int ESocket::Base< TQueue, TMessage >::getError ( )

inline

Retrieves the last error value.

Returns

the last error value.

getFamily()

template<class TQueue, class TMessage>

Int ESocket::Base< TQueue, TMessage >::getFamily ( )

inline

Retrieves the address family.

Returns

the address family.

getHandle()

template<class TQueue, class TMessage>

Int ESocket::Base< TQueue, TMessage >::getHandle ( )

inline

Retrieves the socket file handle.

Returns

the socket file handle.

getProtocol()

template<class TQueue, class TMessage>

Int ESocket::Base< TQueue, TMessage >::getProtocol ( )

inline

Retrieves the protocol.

Returns

the protocol.

getSocketType()

template<class TQueue, class TMessage>

SocketType ESocket::Base< TQueue, TMessage >::getSocketType ( )

inline

Retrieves the socket type.

Returns

the socket type.

getStateDescription()

template<class TQueue, class TMessage>

cpStr ESocket::Base< TQueue, TMessage >::getStateDescription ( SocketState  state )

inline

Retrieves the description of the connection state.

Returns

the description of the connection state.

getThread()

template<class TQueue, class TMessage>

Thread<TQueue,TMessage>& ESocket::Base< TQueue, TMessage >::getThread ( )

inline

Retrieves the socket thread that this socket is associated with.

Returns

the socket thread that this socket is associated with.

getType()

template<class TQueue, class TMessage>

Int ESocket::Base< TQueue, TMessage >::getType ( )

inline

Retrieves the socket type.

Returns

the address family.

Friends And Related Function Documentation

TCP::Listener< TQueue, TMessage >

template<class TQueue, class TMessage>

friend class TCP::Listener< TQueue, TMessage >

friend

TCP::Talker< TQueue, TMessage >

template<class TQueue, class TMessage>

friend class TCP::Talker< TQueue, TMessage >

friend

Thread< TQueue, TMessage >

template<class TQueue, class TMessage>

friend class Thread< TQueue, TMessage >

friend

UDP< TQueue, TMessage >

template<class TQueue, class TMessage>

friend class UDP< TQueue, TMessage >

friend

---

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

• /home/vagrant/share/code/epctools/include/epc/esocket.h