UDPSocket Class Reference

Class representing a UDP socket. More...

#include <tdme/os/network/UDPSocket.h>

Inheritance diagram for UDPSocket:

Collaboration diagram for UDPSocket:

Public Member Functions
virtual	~UDPSocket ()
	public destructor More...
ssize_t	read (string &from, unsigned int &port, void *buf, const size_t bytes)
	reads a datagram from socket More...
ssize_t	write (const string &to, const unsigned int port, void *buf, const size_t bytes)
	writes up to "bytes" bytes to socket More...
Public Member Functions inherited from NetworkSocket
NetworkSocket &	operator= (NetworkSocket &socket)
	copy operator More...
	NetworkSocket ()
	Protected constructor. More...
virtual	~NetworkSocket ()
	public destructor More...
const string &	getAddress ()
	returns the end points ip address More...
const unsigned int	getPort ()
	returns the end points port More...
void	shutdown ()
	shuts socket down for reading and writing More...
void	bind (const string &ip, const unsigned int port)
	Binds a socket to local ip and port. More...
void	setNonBlocked ()
	sets the socket non blocked More...
void	close ()
	Closes the socket. More...

Static Public Member Functions
static void	create (UDPSocket &socket, IpVersion ipVersion)
	creates a udp socket More...
static void	createServerSocket (UDPSocket &socket, const std::string &ip, const unsigned int port)
	creates a udp server socket More...
static void	createClientSocket (UDPSocket &socket, IpVersion ipVersion)
	creates a udp client socket More...
Static Public Member Functions inherited from NetworkSocket
static IpVersion	determineIpVersion (const string &ip)
	Determine IP version. More...

Additional Inherited Members
Public Types inherited from NetworkSocket
enum	IpVersion { IPV4 , IPV6 }
Protected Attributes inherited from NetworkSocket
IpVersion	ipVersion
int	descriptor
string	ip
unsigned int	port

Detailed Description

Class representing a UDP socket.

Author

Andreas Drewke

Definition at line 27 of file UDPSocket.h.

Constructor & Destructor Documentation

~UDPSocket()

~UDPSocket ( )

virtual

public destructor

Definition at line 36 of file UDPSocket.cpp.

Member Function Documentation

create()

void create ( UDPSocket &  socket, IpVersion  ipVersion  )

static

creates a udp socket

Parameters

socket	socket
ipVersion	IP version

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 168 of file UDPSocket.cpp.

createClientSocket()

void createClientSocket ( UDPSocket &  socket, IpVersion  ipVersion  )

static

creates a udp client socket

Parameters

socket	socket
ipVersion	IP version

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 211 of file UDPSocket.cpp.

createServerSocket()

void createServerSocket ( UDPSocket &  socket, const std::string &  ip, const unsigned int  port  )

static

creates a udp server socket

Parameters

socket	socket
ip	ip
port	port

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 186 of file UDPSocket.cpp.

read()

ssize_t read	(	string &	from,
		unsigned int &	port,
		void *	buf,
		const size_t	bytes
	)

reads a datagram from socket

Parameters

from	from host
port	from port
buf	buf
bytes	buf size

Exceptions

tdme::os::network::NetworkIOException

Returns

datagram size or -1 if read would block

Definition at line 39 of file UDPSocket.cpp.

write()

ssize_t write	(	const string &	to,
		const unsigned int	port,
		void *	buf,
		const size_t	bytes
	)

writes up to "bytes" bytes to socket

Exceptions

tdme::os::network::NetworkIOException

Parameters

to	to host
port	to port
buf	buf
bytes	buf size

Exceptions

tdme::os::network::NetworkIOException

Returns

datagram bytes written or -1 if write would block

Definition at line 105 of file UDPSocket.cpp.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/os/network/UDPSocket.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/os/network/UDPSocket.cpp