ESocket Namespace Reference

The namespace for all socket related classes. More...

Namespaces
	TCP
	Namespace for TCP related classes.

Classes
class	Address
	Encapsulates a sockaddr_storage structure that represents a socket address. More...
class	Base
	The base socket class. More...
class	Thread
	The socket thread base class. An event based thread class capable of surfacing socket events. More...
class	UDP
	A UDP socket class capabile of sending and receiving data. More...

Typedefs
typedef Base< EThreadQueuePublic< EThreadMessage >, EThreadMessage >	BasePublic
typedef Base< EThreadQueuePrivate< EThreadMessage >, EThreadMessage >	BasePrivate
typedef Thread< EThreadQueuePublic< EThreadMessage >, EThreadMessage >	ThreadPublic
typedef Thread< EThreadQueuePrivate< EThreadMessage >, EThreadMessage >	ThreadPrivate
typedef UDP< EThreadQueuePublic< EThreadMessage >, EThreadMessage >	UdpPublic
typedef UDP< EThreadQueuePrivate< EThreadMessage >, EThreadMessage >	UdpPrivate

Enumerations
enum	Family { Family::Undefined, Family::INET, Family::INET6 }
	Defines the possible address family values. More...
enum	SocketType { SocketType::Undefined, SocketType::TcpTalker, SocketType::TcpListener, SocketType::Udp }
	Defines the possible socket types. More...
enum	SocketState {   SocketState::Undefined, SocketState::Disconnected, SocketState::Connecting, SocketState::Listening,   SocketState::Connected }
	The socket connection state. More...

Detailed Description

The namespace for all socket related classes.

Typedef Documentation

BasePrivate

typedef Base<EThreadQueuePrivate<EThreadMessage>,EThreadMessage> ESocket::BasePrivate

BasePublic

typedef Base<EThreadQueuePublic<EThreadMessage>,EThreadMessage> ESocket::BasePublic

ThreadPrivate

typedef Thread<EThreadQueuePrivate<EThreadMessage>,EThreadMessage> ESocket::ThreadPrivate

ThreadPublic

typedef Thread<EThreadQueuePublic<EThreadMessage>,EThreadMessage> ESocket::ThreadPublic

UdpPrivate

typedef UDP<EThreadQueuePrivate<EThreadMessage>,EThreadMessage> ESocket::UdpPrivate

UdpPublic

typedef UDP<EThreadQueuePublic<EThreadMessage>,EThreadMessage> ESocket::UdpPublic

Enumeration Type Documentation

Family

enum ESocket::Family

strong

Defines the possible address family values.

Enumerator
Undefined	undefined
INET	IPv4 address.
INET6	IPv6 address.

SocketState

enum ESocket::SocketState

strong

The socket connection state.

Enumerator
Undefined	undefined
Disconnected	socket is disconnected
Connecting	socket is connecting
Listening	socket is listening
Connected	socket is connected

SocketType

enum ESocket::SocketType

strong

Defines the possible socket types.

Enumerator
Undefined	an undefined socket
TcpTalker	a TCP talker socket
TcpListener	a TCP listener socket
Udp	a UDP socket