class Socket

base class of all sockets. More...

Definition#include <socket.h>
Inherited byUDPSocket, UDPBroadcast, UDPTransmit, UDPDuplex, UDPReceive, UDPDuplex, TCPSocket, TCPStream, tcpstream, TCPSession, SocketPort
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Members

Protected Members


Detailed Description

The Socket is used as the base for all Internet protocol services under Common C++. 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.

sockerror_t Error (sockerror_t error, char *errstr = NULL)
[protected const]

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

Parameters:
errordefined socket error id.
errstrstring or message to pass.

inline void Error (char *estr)
[protected]

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

Parameters:
errstrstring or message to pass.

inline void setError (bool enable)
[protected]

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

Parameters:
trueto enable handler.

void 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 connectError (void)
[protected]

Used as a common handler for connection failure processing.

Returns: correct failure code to apply.

sockerror_t 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.

Parameters:
enablewhen set to true.

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

sockerror_t setRouting (bool enable)
[protected]

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

Parameters:
enablenormal routing when set to true.

Returns: 0 on success.

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:
domainsocket domain to use.
typebase type and protocol family of the socket.
protocolspecific protocol to apply.

Socket (int 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:
fdfile descriptor of an already existing 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:
sourceof existing socket to clone.

~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.

Socket & operator= (const Socket &from)

Sockets may also be duplicated by the assignment operator.

InetHostAddress 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:
ptrto port number of sender.

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

InetHostAddress 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:
ptrto port number of remote socket.

Returns: host address of remote socket.

InetHostAddress getLocal (tpport_t *port = NULL)
[const]

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

Parameters:
ptrto port number on local host.

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

void setCompletion (sockcomplete_t completion)

Used to specify blocking mode for the socket. A socket can be made non-blocking by setting SOCKET_COMPLETION_DELAYED or set to block on all access with SOCKET_COMPLETION_IMMEDIATE. 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:
modespecify socket I/O call blocking mode.

sockerror_t setKeepAlive (bool enable)

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

Parameters:
enablekeep alive messages.

Returns: 0 on success.

sockerror_t setTypeOfService (socktos_t service)

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

Parameters:
typeof service enumerated type.

Returns: 0 on success, error code on failure.

bool 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.

bool 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 operator! ()
[const]

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

inline bool isBroadcast (void)
[const]

Return if broadcast has been enabled for the specified socket.

Returns: true if broadcast socket.

inline bool isRouted (void)
[const]

Return if socket routing is enabled.

Returns: true if routing enabled.

inline sockerror_t getErrorNumber (void)
[const]

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

Returns: error number of sockerror_t error.

inline const char * getErrorString (void)
[const]

Often used by a "catch" to fetch the user set error string of a thrown socket.

Returns: string for error message.

bool 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.

Parameters:
readycheck to perform.
timeoutin milliseconds, inf. if not specified.

Returns: true if ready, false on timeout.