#include <SimpleSocket.h>

Public Types
enum	ShutdownDirection { STOP_SEND = SHUT_WR, STOP_RECEIVE = SHUT_RD, STOP_BOTH = SHUT_RDWR }
Public Member Functions
void	disconnect ()
bool	peerDisconnected () const
	returns whether a peer disconnected
int	receive (void *buffer, size_t len)
	receive data from a bound socket
int	send (const void *buffer, size_t len)
	send data through a connected socket
void	shutdown (ShutdownDirection type)
	shutdown the connection in the specified direction
int	timedReceive (void *buffer, size_t len, int timeout)
	receive data from a bound socket, return after the given timespan
	~SimpleSocket ()
Protected Types
enum	SocketDomain { INTERNET = PF_INET, UNIX = PF_LOCAL }
enum	SocketType { STREAM = SOCK_STREAM, DATAGRAM = SOCK_DGRAM }
Protected Member Functions
	SimpleSocket (int sockfd)
	enables return of an accepted socket
	SimpleSocket (int domain, int type, int protocol)
	allows a subclass to create new socket
Protected Attributes
bool	m_peerDisconnected
int	m_socket

Detailed Description

A socket representing a basic communication endpoint

All sockets must inherit from this class. It provides the basic interface for network communication.

Definition at line 46 of file SimpleSocket.h.

Member Enumeration Documentation

enum NET::SimpleSocket::ShutdownDirection

Enumerator:

STOP_SEND	disable all variants of send() on the socket, receive calls still work
STOP_RECEIVE	disable all variants of receive() on the socket, send calls still work
STOP_BOTH	disable all send() and receive() calls on the socket

Definition at line 49 of file SimpleSocket.h.

enum NET::SimpleSocket::SocketDomain [protected]

Enumerator:

INTERNET
UNIX

Definition at line 166 of file SimpleSocket.h.

enum NET::SimpleSocket::SocketType [protected]

Enumerator:

STREAM
DATAGRAM

Definition at line 172 of file SimpleSocket.h.

Constructor & Destructor Documentation

SimpleSocket::~SimpleSocket ( )

Definition at line 37 of file SimpleSocket.cpp.

SimpleSocket::SimpleSocket ( int sockfd ) [protected]

enables return of an accepted socket

Definition at line 29 of file SimpleSocket.cpp.

SimpleSocket::SimpleSocket	(	int	domain,
		int	type,
		int	protocol
	)		`[protected]`

allows a subclass to create new socket

Definition at line 22 of file SimpleSocket.cpp.

Member Function Documentation

int SimpleSocket::send	(	const void *	buffer,
		size_t	len
	)

send data through a connected socket

send() can only be used on a socket that called connect() before. If you try to use send() on a not connected socket, SocketException will be thrown.

If you are using a stream oriented socket (like TCPSocket), the operating system is allowed to send only a part of the packet you told it to send, so send() will return the number of bytes actually sent. It is your responsibility to resend the data not sent by send()

If you are using a datagram oriented socket (like UDPSocket or SCTPSocket) the operating system will only send and receive complete datagrams, but send() will fail if you are trying to send too much data. In that case SocketException will be thrown.

Parameters:

buffer	data to be send
len	length of the data to be sent

Returns:: number of bytes sent

Exceptions:

SocketException if sending went wrong

Examples:: TCP_Server.cpp, and UDP_Multicast.cpp.

Definition at line 43 of file SimpleSocket.cpp.

int SimpleSocket::receive	(	void *	buffer,
		size_t	len
	)

receive data from a bound socket

receive() can only be used on a socket that called bind() or connect() before. If you try to use receive() on a not bound socket, SocketException will be thrown.

If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.

If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.

If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.

Parameters:

buffer	the buffer the received data will be written to
len	length of the provided buffer, receive will not read more than that

Returns:: number of bytes received

Exceptions:

SocketException in case an error occured

Examples:: UDP_Multicast.cpp.

Definition at line 61 of file SimpleSocket.cpp.

int SimpleSocket::timedReceive	(	void *	buffer,
		size_t	len,
		int	timeout
	)

receive data from a bound socket, return after the given timespan

timedReceive() can only be used on a socket that called bind() or connect before. If you try to use receive() on a not bound socket, SocketException will be thrown.

If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.

If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.

If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.

Parameters:

buffer	the buffer the received data will be written to
len	length of the provided buffer, receive will not read more than that
timeout	the timeout in ms after which receive will give up and return

Returns:: number of bytes received, 0 on timeout

Exceptions:

SocketException in case an error occured

Examples:: TCP_Client.cpp.

Definition at line 68 of file SimpleSocket.cpp.

void SimpleSocket::disconnect ( )

Disconnect and unset any foreign addresses

Exceptions:

SocketException thrown if unable to disconnect

Examples:: TCP_Client.cpp, and TCP_Server.cpp.

Definition at line 88 of file SimpleSocket.cpp.

void SimpleSocket::shutdown ( ShutdownDirection type )

shutdown the connection in the specified direction

Depending on the specified ShutdownDirection, calls for that direction will stop working. Use this function if you want to have more control than just destroing the socket. It allows you to cut the connection in one direction, or both.

If you use shutdown() on an unconnected socket, the corresponding calls will simply stop working.

Parameters:

type	the ShutdownDirection that be used

Exceptions:

SocketException in case an error occured

Definition at line 103 of file SimpleSocket.cpp.

bool SimpleSocket::peerDisconnected ( ) const

returns whether a peer disconnected

Will only work if you use a connection oriented, connected socket. Returns true if the peer disconnected. Use this function after a call to receive, returned 0 received bytes.

Returns:: true if a peer disconnected

Examples:: TCP_Server.cpp.

Definition at line 109 of file SimpleSocket.cpp.

Member Data Documentation

int NET::SimpleSocket::m_socket [protected]

Definition at line 185 of file SimpleSocket.h.

bool NET::SimpleSocket::m_peerDisconnected [protected]

Definition at line 186 of file SimpleSocket.h.

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

NET::SimpleSocket Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation