Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

Socket Class Reference

The Socket is used as the base for all Internet protocol services under Common C++. base class of all sockets. More...

#include <socket.h>

Inheritance diagram for Socket::

List of all members.

Public Methods
virtual	~Socket ()
	The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object. More...
Socket &	operator= (const Socket &from)
	Sockets may also be duplicated by the assignment operator. More...
InetHostAddress	getSender (tpport_t *port=NULL) const
	May be used to examine the origin of data waiting in the socket receive queue. More...
InetHostAddress	getPeer (tpport_t *port=NULL) const
	Get the host address and port of the socket this socket is connected to. More...
InetHostAddress	getLocal (tpport_t *port=NULL) const
	Get the local address and port number this socket is currently bound to. More...
void	setCompletion (bool immediate)
	Used to specify blocking mode for the socket. More...
sockerror_t	setLinger (bool linger)
	Enable lingering sockets on close. More...
sockerror_t	setKeepAlive (bool enable)
	Set the keep-alive status of this socket and if keep-alive messages will be sent. More...
sockerror_t	setTypeOfService (socktos_t service)
	Set packet scheduling on platforms which support ip quality of service conventions. More...
bool	isConnected (void) const
	Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More...
bool	isActive (void) const
	Test to see if the socket is at least operating or if it is mearly initialized. More...
bool	operator! () const
	Operator based testing to see if a socket is currently active. More...
bool	isBroadcast (void) const
	Return if broadcast has been enabled for the specified socket. More...
bool	isRouted (void) const
	Return if socket routing is enabled. More...
sockerror_t	getErrorNumber (void) const
	Often used by a "catch" to fetch the last error of a thrown socket. More...
const char *	getErrorString (void) const
	Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used. More...
virtual bool	isPending (sockpend_t pend, timeout_t timeout=TIMEOUT_INF)
	Get the status of pending operations. More...
Protected Methods
sockerror_t	Error (sockerror_t error, char *errstr=NULL) const
	This service is used to throw all socket errors which usually occur during the socket constructor. More...
void	Error (char *estr)
	This service is used to throw application defined socket errors where the application specific error code is a string. More...
void	setError (bool enable)
	This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. More...
void	endSocket (void)
	Used as the default destructor for ending a socket. More...
sockerror_t	connectError (void)
	Used as a common handler for connection failure processing. More...
sockerror_t	setBroadcast (bool enable)
	Set the subnet broadcast flag for the socket. More...
sockerror_t	setMulticast (bool enable)
	Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. More...
sockerror_t	setLoopback (bool enable)
	Set the multicast loopback flag for the socket. More...
sockerror_t	setTimeToLive (unsigned char ttl)
	Set the multicast time to live for a multicast socket. More...
sockerror_t	Join (const InetMcastAddress &ia)
	Join a multicast group. More...
sockerror_t	Drop (const InetMcastAddress &ia)
	Drop membership from a multicast group. More...
sockerror_t	setRouting (bool enable)
	Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More...
sockerror_t	setNoDelay (bool enable)
	Enable/disable delaying packets (Nagle algorithm). More...
	Socket (int domain, int type, int protocol=0)
	An unconnected socket may be created directly on the local machine. More...
	Socket (SOCKET fd)
	A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. More...
	Socket (const Socket &source)
	A socket can also be constructed from an already existing Socket object. More...
ssize_t	Readline (char *buf, size_t len, timeout_t timeout=0)
	Process a logical input line from a socket descriptor directly. More...
Protected Attributes
Socket:: { ... }	flags
SOCKET	so
	the actual socket descriptor, in Windows, unlike posix it cannot* be used as an file descriptor that way madness lies -- jfc.* More...
sockstate_t	state
bool	thrown: 1
bool	broadcast: 1
bool	route: 1
bool	keepalive: 1
bool	loopback: 1
bool	multicast: 1
bool	completion: 1
bool	linger: 1
unsigned	ttl: 8

Detailed Description

The Socket is used as the base for all Internet protocol services under Common C++. base class of all sockets.

A socket is a system resource (or winsock descriptor) that occupies a specific port address (and may be bound to a specific network interface) on the local machine. The socket may also be directly connected to a specific socket on a remote internet host.

This base class is not directly used, but is provided to offer properties common to other Common C++ socket classes, including the socket exception model and the ability to set socket properties such as QoS, "sockopts" properties like Dont-Route and Keep-Alive, etc.

Author:: David Sugar <dyfet@ostel.com>

Constructor & Destructor Documentation

Socket::Socket ( int domain,

int type,

int protocol = 0

) [protected]

An unconnected socket may be created directly on the local machine.
Sockets can occupy both the internet domain (AF_INET) and UNIX socket domain (AF_UNIX) under unix. The socket type (SOCK_STREAM, SOCK_DGRAM) and protocol may also be specified. If the socket cannot be created, an exception is thrown.
Parameters:

domain socket domain to use.

type base type and protocol family of the socket.

protocol specific protocol to apply.

Socket::Socket ( SOCKET fd ) [protected]

A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call.
This constructor is mostly for internal use.
Parameters:

fd file descriptor of an already existing socket.

Socket::Socket ( const Socket & source ) [protected]

A socket can also be constructed from an already existing Socket object.
The socket file descriptor is dup()'d. This does not exist under win32.
Parameters:

source of existing socket to clone.

virtual Socket::~Socket ( ) [virtual]

The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object.
By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated.

Member Function Documentation

sockerror_t Socket::Drop ( const InetMcastAddress & ia ) [protected]

Drop membership from a multicast group.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

address of multicast group to drop.

void Socket::Error ( char * estr ) [inline, protected]

This service is used to throw application defined socket errors where the application specific error code is a string.

Parameters:

errstr string or message to pass.

sockerror_t Socket::Error ( sockerror_t error,

char * errstr = NULL

) const [protected]

This service is used to throw all socket errors which usually occur during the socket constructor.

Parameters:

error defined socket error id.

errstr string or message to pass.

sockerror_t Socket::Join ( const InetMcastAddress & ia ) [protected]

Join a multicast group.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

ia address of multicast group to join.

ssize_t Socket::Readline ( char * buf,

size_t len,

timeout_t timeout = 0

) [protected]

Process a logical input line from a socket descriptor directly.

Parameters:

pointer to string.

maximum length to read.

timeout for pending data in milliseconds.

Returns:
number of bytes actually read.

sockerror_t Socket::connectError ( void ) [protected]

Used as a common handler for connection failure processing.

Returns:
correct failure code to apply.

void Socket::endSocket ( void ) [protected]

Used as the default destructor for ending a socket.
This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors.

sockerror_t Socket::getErrorNumber ( void ) const [inline]

Often used by a "catch" to fetch the last error of a thrown socket.

Returns:
error number of sockerror_t error.

const char* Socket::getErrorString ( void ) const [inline]

Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.

Returns:
string for error message.

InetHostAddress Socket::getLocal ( tpport_t * port = NULL ) const

Get the local address and port number this socket is currently bound to.

Parameters:

ptr to port number on local host.

Returns:
host address of interface this socket is bound to.

Reimplemented in TCPSocket.

InetHostAddress Socket::getPeer ( tpport_t * port = NULL ) const

Get the host address and port of the socket this socket is connected to.
If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.
Parameters:

ptr to port number of remote socket.

Returns:
host address of remote socket.

Reimplemented in UDPSocket.

InetHostAddress Socket::getSender ( tpport_t * port = NULL ) const

May be used to examine the origin of data waiting in the socket receive queue.
This can tell a TCP server where pending "connect" requests are coming from, or a UDP socket where it's next packet arrived from.
Parameters:

ptr to port number of sender.

Returns:
host address, test with "isInetAddress()".

bool Socket::isActive ( void ) const

Test to see if the socket is at least operating or if it is mearly initialized.
"initialized" sockets may be the result of failed constructors.

Returns:
true if not in initial state.

bool Socket::isBroadcast ( void ) const [inline]

Return if broadcast has been enabled for the specified socket.

Returns:
true if broadcast socket.

bool Socket::isConnected ( void ) const

Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer().
Of course, an unconnected socket will return a 0.0.0.0 address from getPeer() as well.

Returns:
true when socket is connected to a peer.

virtual bool Socket::isPending ( sockpend_t pend,

timeout_t timeout = TIMEOUT_INF

) [virtual]

Get the status of pending operations.
This can be used to examine if input or output is waiting, or if an error has occured on the descriptor.

Returns:
true if ready, false on timeout.
Parameters:

ready check to perform.

timeout in milliseconds, inf. if not specified.

Reimplemented in TCPStream.

bool Socket::isRouted ( void ) const [inline]

Return if socket routing is enabled.

Returns:
true if routing enabled.

bool Socket::operator! ( void ) const

Operator based testing to see if a socket is currently active.

Reimplemented in tcpstream.

Socket& Socket::operator= ( const Socket & from )

Sockets may also be duplicated by the assignment operator.

sockerror_t Socket::setBroadcast ( bool enable ) [protected]

Set the subnet broadcast flag for the socket.
This enables sending to a subnet and may require special image privileges depending on the operating system.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

enable when set to true.

Reimplemented in UDPTransmit.

void Socket::setCompletion ( bool immediate )

Used to specify blocking mode for the socket.
A socket can be made non-blocking by setting setCompletion(false) or set to block on all access with setCompletion(true). I do not believe this form of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous set of socket services.
Parameters:

mode specify socket I/O call blocking mode.

void Socket::setError ( bool enable ) [inline, protected]

This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.

Parameters:

true to enable handler.

sockerror_t Socket::setKeepAlive ( bool enable )

Set the keep-alive status of this socket and if keep-alive messages will be sent.

Returns:
0 on success.
Parameters:

enable keep alive messages.

sockerror_t Socket::setLinger ( bool linger )

Enable lingering sockets on close.

Parameters:

specify linger enable.

sockerror_t Socket::setLoopback ( bool enable ) [protected]

Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

enable when set to true.

sockerror_t Socket::setMulticast ( bool enable ) [protected]

Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
It is also used as a check flag to make sure multicast is enabled before multicast operations are used.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

enable when set to true.

sockerror_t Socket::setNoDelay ( bool enable ) [protected]

Enable/disable delaying packets (Nagle algorithm).

Returns:
0 on success.
Parameters:

disable Nagle algorithm when set to true.

sockerror_t Socket::setRouting ( bool enable ) [protected]

Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).

Returns:
0 on success.
Parameters:

enable normal routing when set to true.

Reimplemented in UDPTransmit, and UDPReceive.

sockerror_t Socket::setTimeToLive ( unsigned char ttl ) [protected]

Set the multicast time to live for a multicast socket.

Returns:
0 (SOCKET_SUCCESS) on success, else error code.
Parameters:

time to live.

sockerror_t Socket::setTypeOfService ( socktos_t tos )

Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.

Returns:
0 on success, error code on failure.
Parameters:

type of service enumerated type.

Reimplemented in UDPTransmit.

Member Data Documentation

bool Socket::broadcast [protected]

bool Socket::completion [protected]

struct { ... } Socket::flags [protected]

bool Socket::keepalive [protected]

bool Socket::linger [protected]

bool Socket::loopback [protected]

bool Socket::multicast [protected]

bool Socket::route [protected]

SOCKET Socket::so [protected]

the actual socket descriptor, in Windows, unlike posix it *cannot* be used as an file descriptor that way madness lies -- jfc.

sockstate_t Socket::state [protected]

bool Socket::thrown [protected]

unsigned Socket::ttl [protected]

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

socket.h

Generated at Tue Nov 20 12:34:37 2001 for CommonC++ by

Socket Class Reference

Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation