UDP socket class. More...

#include <UDPSocket.h>

Public Types
enum	ShutdownDirection { STOP_SEND = SHUT_WR, STOP_RECEIVE = SHUT_RD, STOP_BOTH = SHUT_RDWR }
Public Member Functions
void	bind (unsigned short localPort=0)
void	bind (const std::string &localAddress, unsigned short localPort=0)
	bind socket to address / port
void	connect (const std::string &foreignAddress, unsigned short foreignPort)
	establish a connection with the given foreign address and port
void	disconnect ()
std::string	getForeignAddress () const
unsigned short	getForeignPort () const
std::string	getLocalAddress () const
unsigned short	getLocalPort () const
void	joinGroup (const std::string &multicastGroup)
void	leaveGroup (const std::string &multicastGroup)
bool	peerDisconnected () const
	returns whether a peer disconnected
int	receive (void *buffer, size_t len)
	receive data from a bound socket
int	receiveFrom (void *buffer, size_t len, std::string &sourceAddress, unsigned short &sourcePort)
int	send (const void *buffer, size_t len)
	send data through a connected socket
void	sendTo (const void *buffer, size_t bufferLen, const std::string &foreignAddress, unsigned short foreignPort)
void	setMulticastTTL (unsigned char multicastTTL)
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
int	timedReceiveFrom (void *buffer, size_t len, std::string &sourceAddress, unsigned short &sourcePort, int timeout)
	UDPSocket ()
Protected Types
enum	SocketDomain { INTERNET = PF_INET, UNIX = PF_LOCAL }
enum	SocketType { STREAM = SOCK_STREAM, DATAGRAM = SOCK_DGRAM }
Static Protected Member Functions
static void	fillAddress (const std::string &address, unsigned short port, sockaddr_in &addr)
Protected Attributes
bool	m_peerDisconnected
int	m_socket

Detailed Description

UDP socket class.

Examples:: UDP_Multicast.cpp.

Definition at line 9 of file UDPSocket.h.

Member Enumeration Documentation

enum NET::SimpleSocket::ShutdownDirection [inherited]

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, inherited]

Enumerator:

INTERNET
UNIX

Definition at line 166 of file SimpleSocket.h.

enum NET::SimpleSocket::SocketType [protected, inherited]

Enumerator:

STREAM
DATAGRAM

Definition at line 172 of file SimpleSocket.h.

Constructor & Destructor Documentation

UDPSocket::UDPSocket ( )

Construct a UDP socket and enable broadcast capabilities

Exceptions:

SocketException thrown if unable to create the socket

Definition at line 39 of file UDPSocket.cpp.

Member Function Documentation

void UDPSocket::sendTo	(	const void *	buffer,
		size_t	bufferLen,
		const std::string &	foreignAddress,
		unsigned short	foreignPort
	)

Send the given buffer as a UDP datagram to the specified address / port.

Can be substituted with send() if the socket is first connected to an address and port. If sendTo() is used on a connected socket, the destination parameters will be ignored, and the datagram will be sent to the connected socket.

If the message you are trying to send is too long for one of the underlying protocols a SocketException will be thrown. Like send(), sendTo() blocks until the message was sent.

Parameters:

buffer	data to be send
bufferLen	number of bytes to write
foreignAddress	address (IP address or name) to send to
foreignPort	port number to send to

Exceptions:

SocketException thrown if unable to send datagram

Examples:: UDP_Multicast.cpp.

Definition at line 45 of file UDPSocket.cpp.

int UDPSocket::receiveFrom	(	void *	buffer,
		size_t	len,
		std::string &	sourceAddress,
		unsigned short &	sourcePort
	)

Read read up to bufferLen bytes data from this socket. The given buffer is where the data will be placed.

In order to receive data, the socket has to be bound at least to a specific port. This is done by explicitly binding the socket, or sending data through the socket.

Parameters:

buffer	buffer to receive data
len	maximum number of bytes to receive
sourceAddress	address of datagram source
sourcePort	port of data source

Returns:: number of bytes received

Exceptions:

SocketException thrown if unable to receive datagram

Examples:: UDP_Multicast.cpp.

Definition at line 57 of file UDPSocket.cpp.

int UDPSocket::timedReceiveFrom	(	void *	buffer,
		size_t	len,
		std::string &	sourceAddress,
		unsigned short &	sourcePort,
		int	timeout
	)

Read read up to bufferLen bytes data from this socket. The given buffer is where the data will be placed. If no host has sent a datagram before the timeout runs out, the function will return without changing the buffer.

In order to receive data, the socket has to be bound at least to a specific port. This is done by explicitly binding the socket, or sending data through the socket.

Parameters:

buffer	buffer to receive data
len	maximum number of bytes to receive
sourceAddress	address of datagram source
sourcePort	port of data source
timeout	timeout in milliseconds

Returns:: number of bytes received, 0 on timeout

Exceptions:

SocketException thrown if unable to receive datagram

Definition at line 72 of file UDPSocket.cpp.

void UDPSocket::setMulticastTTL ( unsigned char multicastTTL )

Set the multicast TTL

Parameters:

multicastTTL multicast TTL

Exceptions:

SocketException thrown if unable to set TTL

Examples:: UDP_Multicast.cpp.

Definition at line 92 of file UDPSocket.cpp.

void UDPSocket::joinGroup ( const std::string & multicastGroup )

Join the specified multicast group

The multicast group has to be a valid multicast IP Address (224.0.0.0/24)

Parameters:

multicastGroup multicast group address to join

Exceptions:

SocketException thrown if unable to join group

Examples:: UDP_Multicast.cpp.

Definition at line 102 of file UDPSocket.cpp.

void UDPSocket::leaveGroup ( const std::string & multicastGroup )

Leave the specified multicast group

The multicast group has to be a valid multicast IP Address (224.0.0.0/24)

Parameters:

multicastGroup multicast group address to leave

Exceptions:

SocketException thrown if unable to leave group

Examples:: UDP_Multicast.cpp.

Definition at line 108 of file UDPSocket.cpp.

void InternetSocket::connect	(	const std::string &	foreignAddress,
		unsigned short	foreignPort
	)		`[inherited]`

establish a connection with the given foreign address and port

If you are using a connection oriented socket (like TCPSocket), you have to call connect() on that socket in order to send data. However, if you are using a non-connection oriented socket (like UDPSocket), calling connect on that socket will allow you to use the send() function like on a connection oriented socket.

Parameters:

foreignAddress	foreign address (IP address or name)
foreignPort	foreign port

Exceptions:

SocketException thrown if unable to establish connection

Examples:: TCP_Client.cpp, and UDP_Multicast.cpp.

Definition at line 19 of file InternetSocket.cpp.

void InternetSocket::bind ( unsigned short localPort = 0 ) [inherited]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Instead of the richer function with more arguments, this bind() binds to any available interface / address

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

Definition at line 30 of file InternetSocket.cpp.

void InternetSocket::bind	(	const std::string &	localAddress,
		unsigned short	localPort = `0`
	)		`[inherited]`

bind socket to address / port

Set the local port to the specified port and the local address to an interface.

bind() attaches the local endpoint of the socket to the specified interface and port. Typically all servers use bind() to attach to the local port specified by the used protocol. You just need to call bind if you want to restrict the connection to a specific local interface, or if you want to listen on a specific port. If you are just a client using connect() to connect to a server, calling bind is most likely unnecessary.

To bind to a port < 1023 you need eighter superuser access, or the SUID bit set on your program.

Parameters:

localAddress	local address
localPort	local port

Exceptions:

SocketException thrown if setting local port fails

Definition at line 41 of file InternetSocket.cpp.

std::string InternetSocket::getLocalAddress ( ) const [inherited]

Get the local address (after binding the socket).

Returns:: local address of socket

Exceptions:

SocketException thrown if fetch fails

Definition at line 50 of file InternetSocket.cpp.

unsigned short InternetSocket::getLocalPort ( ) const [inherited]

Get the local port (after binding the socket).

Returns:: local port of socket

Exceptions:

SocketException thrown if fetch fails

Definition at line 61 of file InternetSocket.cpp.

std::string InternetSocket::getForeignAddress ( ) const [inherited]

Get the foreign address. Call connect() before using this function.

Returns:: foreign address

Exceptions:

SocketException thrown if unable to fetch foreign address

Definition at line 72 of file InternetSocket.cpp.

unsigned short InternetSocket::getForeignPort ( ) const [inherited]

Get the foreign port. Call connect() before using this function.

Returns:: foreign port

Exceptions:

SocketException thrown if unable to fetch foreign port

Definition at line 83 of file InternetSocket.cpp.

void InternetSocket::fillAddress	(	const std::string &	address,
		unsigned short	port,
		sockaddr_in &	addr
	)		`[static, protected, inherited]`

Fill an address structure with the given address and port number. If the given address is not a valid IPv4 address, it will be resolved by hostname or DNS lookup. addr will be unchanged if this resolve fails.

Parameters:

address	IPv4 domain name or address
port	IP port number to fill in
addr	address structure to fill

Exceptions:

SocketException thrown if unable to resolve a hostname

Definition at line 94 of file InternetSocket.cpp.

int SimpleSocket::send	(	const void *	buffer,
		size_t	len
	)		`[inherited]`

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
	)		`[inherited]`

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
	)		`[inherited]`

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 ( ) [inherited]

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 ) [inherited]

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 [inherited]

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, inherited]

Definition at line 185 of file SimpleSocket.h.

bool NET::SimpleSocket::m_peerDisconnected [protected, inherited]

Definition at line 186 of file SimpleSocket.h.

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

NET::UDPSocket Class Reference

Public Types

Public Member Functions

Protected Types

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation