Broadcast datagram socket. More...

#include <netcomm/socket/datagram.h>

Inheritance diagram for fawkes::BroadcastDatagramSocket:

Public Member Functions
	BroadcastDatagramSocket (const char *broadcast_addr_s, unsigned short port, float timeout=0.f)
	Constructor.
	BroadcastDatagramSocket (BroadcastDatagramSocket &s)
	Copy constructor.
virtual	~BroadcastDatagramSocket ()
	Destructor.
virtual Socket *	clone ()
	Clone socket.
virtual void	bind ()
	Bind socket.
virtual void	send (void *buf, unsigned int buf_len)
	Send data.
Public Member Functions inherited from fawkes::Socket
	Socket (int domain, int type, int protocol, float timeout=0.f)
	Constructor similar to syscall.
	Socket (Socket &socket)
	Copy constructor.
virtual	~Socket ()
	Destructor.
virtual void	connect (const char *hostname, const unsigned short int port)
	Connect socket.
virtual void	connect (struct sockaddr *addr_port, unsigned int struct_size)
	Connect socket.
virtual void	bind (const unsigned short int port)
	Bind socket.
virtual void	bind (const unsigned short int port, const char *hostname)
	Bind socket to a specific address.
virtual void	listen (int backlog=1)
	Listen on socket.
virtual Socket *	accept ()
	Accept connection.
virtual void	close ()
	Close socket.
virtual bool	available ()
	Check if data is available.
virtual size_t	read (void *buf, size_t count, bool read_all=true)
	Read from socket.
virtual void	write (const void *buf, size_t count)
	Write to the socket.
virtual void	send (void *buf, size_t buf_len)
	Write to the socket.
virtual void	send (void buf, size_t buf_len, const struct sockaddr to_addr, socklen_t addr_len)
	Send message.
virtual size_t	recv (void *buf, size_t buf_len)
	Read from socket.
virtual size_t	recv (void buf, size_t buf_len, struct sockaddr from_addr, socklen_t *addr_len)
	Receive data.
virtual short	poll (int timeout=-1, short what=POLL_IN\|POLL_HUP\|POLL_PRI\|POLL_RDHUP)
	Wait for some event on socket.
virtual bool	listening ()
	Is socket listening for connections?
virtual unsigned int	mtu ()
	Maximum Transfer Unit (MTU) of socket.
template<class SocketType >
SocketType *	accept ()
	Accept connection.

Additional Inherited Members
Static Public Attributes inherited from fawkes::Socket
static const short	POLL_IN = POLLIN
	Data can be read.
static const short	POLL_OUT = POLLOUT
	Writing will not block.
static const short	POLL_PRI = POLLPRI
	There is urgent data to read (e.g., out-of-band data on TCP socket; pseudo-terminal master in packet mode has seen state change in slave).
static const short	POLL_RDHUP = 0
	Stream socket peer closed connection, or shut down writing half of connection.
static const short	POLL_ERR = POLLERR
	Error condition.
static const short	POLL_HUP = POLLHUP
	Hang up.
static const short	POLL_NVAL = POLLNVAL
	Invalid request.
Protected Member Functions inherited from fawkes::Socket
	Socket ()
	Constructor.
Protected Attributes inherited from fawkes::Socket
int	sock_fd
	Socket file descriptor.
float	timeout
	Timeout in seconds for various operations.
struct::sockaddr_in *	client_addr
	Client address, set if connected.
unsigned int	client_addr_len
	length in bytes of client address.

Detailed Description

Broadcast datagram socket.

An broadcast UDP socket on top of IP.

Author:: Christoph Schwering

Definition at line 32 of file datagram_broadcast.h.

Constructor & Destructor Documentation

fawkes::BroadcastDatagramSocket::BroadcastDatagramSocket	(	const char *	broadcast_addr_s,
		unsigned short	port,
		float	timeout = `0.f`
	)

Constructor.

Parameters:

broadcast_addr_s	textual representation of the broadcast IP address to use for broadcast communication. NOT a hostname!
port	port
timeout	timeout, if 0 all operationsare blocking, otherwise it is tried for timeout seconds.

Definition at line 51 of file datagram_broadcast.cpp.

Referenced by clone().

fawkes::BroadcastDatagramSocket::BroadcastDatagramSocket ( BroadcastDatagramSocket & datagram_socket )

Copy constructor.

Parameters:

datagram_socket socket to copy.

Definition at line 83 of file datagram_broadcast.cpp.

fawkes::BroadcastDatagramSocket::~BroadcastDatagramSocket ( )

virtual

Destructor.

Definition at line 74 of file datagram_broadcast.cpp.

Member Function Documentation

void fawkes::BroadcastDatagramSocket::bind ( )

virtual

Bind socket.

This will make the socket listen for incoming traffic.

Definition at line 95 of file datagram_broadcast.cpp.

References fawkes::Socket::sock_fd.

Referenced by fawkes::WorldInfoTransceiver::WorldInfoTransceiver().

Socket * fawkes::BroadcastDatagramSocket::clone ( )

virtual

Clone socket.

Returns:: a copied instance of BroadcastDatagramSocket.

Implements fawkes::Socket.

Definition at line 122 of file datagram_broadcast.cpp.

References BroadcastDatagramSocket().

void fawkes::BroadcastDatagramSocket::send	(	void *	buf,
		unsigned int	buf_len
	)

virtual

Send data.

This will send the given data to the broadcast address specified in the constructor.

Parameters:

buf	buffer to write
buf_len	length of buffer, number of bytes to write to stream

Definition at line 135 of file datagram_broadcast.cpp.

References fawkes::Exception::append().

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

src/libs/netcomm/socket/datagram_broadcast.h
src/libs/netcomm/socket/datagram_broadcast.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation