anch::network::UdpSocket Class Reference

#include <udpSocket.hpp>

Inheritance diagram for anch::network::UdpSocket:

Collaboration diagram for anch::network::UdpSocket:

Public Member Functions
	UdpSocket ()
	UdpSocket (const std::string &ipAddress, uint16_t port) throw (anch::network::IOException)
virtual	~UdpSocket () noexcept
virtual void	listen () throw (anch::network::IOException)
virtual void	connect () throw (anch::network::IOException)
virtual void	accept (Socket &socket) throw (anch::network::IOException)
virtual void	send (const std::string &message) throw (anch::network::IOException)
virtual void	send (const std::string &message, const sockaddr_storage &peerAddr) throw (anch::network::IOException)
virtual void	receive (std::string &message) throw (anch::network::IOException)
virtual int	getDomain () const
virtual int	getType () const
Public Member Functions inherited from anch::network::Socket
	Socket (const std::string &ipAddress, uint16_t port, anch::network::SocketType type=anch::network::SocketType::UNKNOWN) throw (anch::network::IOException)
virtual	~Socket () noexcept
virtual void	bind () throw (anch::network::IOException)
virtual void	receive () throw (anch::network::IOException)
virtual void	shutdown (anch::network::Direction how=anch::network::Direction::BOTH) throw (anch::network::IOException)
virtual void	close () noexcept
const std::string &	getIpAddress () const
void	setIpAddress (const std::string &ipAddress)
uint16_t	getPort () const
void	setIpAddress (uint16_t port)
anch::network::SocketType	getSocketType () const
void	setSocketType (SocketType type)
int	getBacklog () const
void	setBacklog (int backlog)
Public Member Functions inherited from anch::events::Observable< anch::network::SocketEvent >
	Observable ()
virtual	~Observable ()
bool	addObserver (anch::events::Observer< anch::network::SocketEvent > &observer)
void	removeObserver (anch::events::Observer< anch::network::SocketEvent > &observer)
void	notifyObservers (const anch::network::SocketEvent &event)

Additional Inherited Members
Protected Member Functions inherited from anch::network::Socket
	Socket (anch::network::SocketType type)
Protected Attributes inherited from anch::network::Socket
SOCKET	_sock
int	_backlog
addrinfo *	_address

Detailed Description

UDP socket implementation

Author

Vincent Lachenal

Constructor & Destructor Documentation

UdpSocket::UdpSocket

(

)

UdpSocket default constructor

UdpSocket::UdpSocket	(	const std::string &	ipAddress,
		uint16_t	port
	)
throw	(	anch::network::IOException
	)

UdpSocket constructor

Parameters

ipAddress	The IP address
port	The port number

Exceptions

anch::network::IOException

Error while creating the socket

UdpSocket constructor

Parameters

ipAddress	The IP address
port	The port number

UdpSocket::~UdpSocket ( )

virtualnoexcept

UdpSocket destructor

UdpSocket} destructor

Member Function Documentation

void UdpSocket::accept ( Socket &  socket ) throw ( anch::network::IOException )

virtual

Accept client connection.
This method do nothing since UDP is not connected

Parameters

socket

The socket which describes client connection

Exceptions

anch::network::IOException

Never on UDP socket

Reimplemented from anch::network::Socket.

void UdpSocket::connect ( ) throw ( anch::network::IOException )

virtual

Connect to remote socket.
This method do nothing since UDP is not connected.

Exceptions

anch::network::IOException

Never on UDP socket

Reimplemented from anch::network::Socket.

int UdpSocket::getDomain ( ) const

virtual

Get the socket domain

Returns

The POSIX socket domain

Implements anch::network::Socket.

int UdpSocket::getType ( ) const

virtual

Get the socket service type

Returns

The POSIX socket service type

Implements anch::network::Socket.

void UdpSocket::listen ( ) throw ( anch::network::IOException )

virtual

Listen on socket

Exceptions

anch::network::IOException

Error while listening on the socket

Reimplemented from anch::network::Socket.

void UdpSocket::receive ( std::string &  message ) throw ( anch::network::IOException )

virtual

Receive a message on socket

Parameters

message

The string where to write the message

Exceptions

anch::network::IOException

Network error while receiving message

Implements anch::network::Socket.

void UdpSocket::send ( const std::string &  message ) throw ( anch::network::IOException )

virtual

Send a message on socket

Parameters

message

The message to send

Exceptions

anch::network::IOException

Network error while sending message

Implements anch::network::Socket.

void UdpSocket::send ( const std::string &  message, const sockaddr_storage &  peerAddr  ) throw ( anch::network::IOException )

virtual

Send a message on socket

Parameters

message	The message to send
peerAddr	The address where the message has to be sent

Exceptions

anch::network::IOException

Network error while sending message

Send a message on socket

Parameters

message

The message to send

Exceptions

anch::network::IOException

Network error while sending message

---

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

• anch-network/inc/network/udpSocket.hpp
• anch-network/src/network/udpSocket.cpp