#include <ConUDPSocket.h>

Inheritance diagram for ASSA::ConUDPSocket:

Public Member Functions
	ConUDPSocket ()
	Constructor. More...

virtual	~ConUDPSocket ()
	Destructor. More...

bool	connect (const Address &peer_addr_)
	Connect socket to the peer. More...

void	unconnect ()
	Unconnect connected socket. More...

int	read (char *buf_, const unsigned int size_)
	Read specified number of bytes off the socket. More...

int	write (const char *buf_=NULL, const unsigned int size_=0)
	Perform blocking write by writing packet of specified size. More...

virtual int	in_avail () const
	This function returns the number of characters immediately available in the get area of the underlying Socketbuf buffer without making a system call if Socket is doing buffering I/O. More...

Public Member Functions inherited from ASSA::UDPSocket
	UDPSocket ()
	Default constructor. More...

	UDPSocket (const handler_t fd_)
	Constructor. More...

virtual	~UDPSocket ()
	Destructor will close connection. More...

bool	open (const int domain_)
	Create socket. More...

bool	close ()
	Close socket connection. More...

bool	bind (const Address &my_address_)
	Server in UDP client-server scenario has to bind socket to its local well-known port. More...

handler_t	getHandler () const
	Get socket file descriptor. More...

const int	getDomain () const
	Get socket domain type. More...

Public Member Functions inherited from ASSA::Socket
	Socket ()
	Constructor. More...

virtual	~Socket ()
	Destructor. More...

int	getBytesAvail (void) const
	Return number of bytes available in socket receive buffer. More...

int	ignore (int n_=INT_MAX, int delim_=EOF)
	Extracts bytes and discards them. More...

virtual Streambuf *	rdbuf ()
	Return a pointer to the Streambuf associated with the stream. More...

virtual Streambuf *	rdbuf (Streambuf *)
	Virtual function that sets new socket buffer and returns the old one. More...

virtual Socket &	flush ()
	This function simply calls the public "synchronizing" function rdbuf()->pubsync() (assuming the associated streambuf object is present). More...

bool	turnOptionOn (opt_t opt_)
	Enable socket option. More...

bool	turnOptionOff (opt_t opt_)
	Disable socket option. More...

bool	setOption (opt_t opt_, int arg_)
	Set socket option to value required. More...

int	getOption (opt_t opt_) const
	Get current value of a socket option. More...

	operator void * () const
	Convertion to void* (for testing where bool is required) More...

bool	operator! () const
	Alias to fail() More...

iostate	rdstate () const
	Retrieve state of the socket. More...

void	clear (iostate state_=Socket::goodbit)
	Clear the socket state. Closed socket remains in bad state. More...

void	setstate (iostate flag_)
	Set socket state to flag_ by adding flag_ to the existing state. More...

bool	good () const
	Indicates no error on the socket. More...

bool	eof () const
	An earlier extraction operation has encountered the end of file of the input stream (peer closed its socket). More...

bool	fail () const
	Indicates that earlier extraction opeartion has failed to match the required pattern of input. More...

bool	bad () const
	Socket fd == -1 or read/write error occured or some loss of integrity on assosiated stream buffer. More...

void	dumpState () const
	Write state bits of the socket to the log file. More...

Socket &	operator>> (char &c)
	Input of built-in char type. The value will be XDR-decoded. More...

Socket &	operator>> (unsigned char &c_)
	Input of built-in u_char type. The value will be XDR-decoded. More...

Socket &	operator>> (signed char &c_)
	Input of built-in signed char type. The value will be XDR-decoded. More...

Socket &	operator>> (std::string &s_)
	Input of STL string type. The string content will be XDR-decoded. More...

Socket &	operator>> (short &n_)
	Input of built-in short type. The value will be XDR-decoded. More...

Socket &	operator>> (unsigned short &n_)
	Input of built-in u_short type. The value will be XDR-decoded. More...

Socket &	operator>> (int &n_)
	Input of built-in integer type. The value will be XDR-decoded. More...

Socket &	operator>> (unsigned int &n_)
	Input of built-in u_int type. The value will be XDR-decoded. More...

Socket &	operator>> (long &n_)
	Input of built-in long type. The value will be XDR-decoded. More...

Socket &	operator>> (unsigned long &n_)
	Input of built-in u_long type. The value will be XDR-decoded. More...

Socket &	operator>> (float &n_)
	Input of built-in float type. The value will be XDR-decoded. More...

Socket &	operator>> (double &n_)
	Input of built-in double type. The value will be XDR-decoded. More...

Socket &	operator<< (char c)
	Output of built-in char type. The value will be XDR-encoded. More...

Socket &	operator<< (unsigned char c_)
	Output of built-in u_char type. The value will be XDR-encoded. More...

Socket &	operator<< (signed char c_)
	Output of built-in signed char type. The value will be XDR-encoded. More...

Socket &	operator<< (const std::string &s_)
	Output of STL string type. The value will be XDR-encoded. More...

Socket &	operator<< (short n_)
	Output of built-in short type. The value will be XDR-encoded. More...

Socket &	operator<< (unsigned short n_)
	Output of built-in u_short type. The value will be XDR-encoded. More...

Socket &	operator<< (int n_)
	Output of built-in integer type. The value will be XDR-encoded. More...

Socket &	operator<< (unsigned int n_)
	Output of built-in u_int type. The value will be XDR-encoded. More...

Socket &	operator<< (long n_)
	Output of built-in long type. The value will be XDR-encoded. More...

Socket &	operator<< (unsigned long n_)
	Output of built-in u_long type. The value will be XDR-encoded. More...

Socket &	operator<< (float n_)
	Output of built-in float type. The value will be XDR-encoded. More...

Socket &	operator<< (double n_)
	Output of built-in double type. The value will be XDR-encoded. More...

Socket &	operator<< (Socket &(*f)(Socket &))
	Manipulators plug-in operator. More...

Additional Inherited Members
Public Types inherited from ASSA::Socket
enum	io_state_t { goodbit = 0, eofbit = 1, failbit = 2, badbit = 4 }
	State bits: goodbit, eofbit, failbit, badbit. More...

enum	opt_t { reuseaddr, rcvlowat, sndlowat, nonblocking }
	Socket options. More...

typedef int	iostate

typedef unsigned char	IOState

Static Public Member Functions inherited from ASSA::Socket
static size_t	xdr_length (const std::string &s_)
	Give the true length of the XDR-encoded STL string. More...

static bool	is_little_endian ()
	Determine the endianess of the platform we are on. More...

static void	close_handler (handler_t &socket_)
	Close socket endpoint in a portable way. More...

static string	decode_fcntl_flags (long mask_)
	Decipher flags packed into mask_ used in fcntl() call. More...

Static Public Attributes inherited from ASSA::Socket
static const int	PGSIZE = 4096
	Size of bytes of a kernel page. More...

Protected Member Functions inherited from ASSA::UDPSocket
void	setHandler (const int fd_)
	Set file descriptor. More...

void	setDomain (const int type_)
	Set socket domain type. More...

Protected Member Functions inherited from ASSA::Socket
int	set_option (int level_, int optname_, int val_)
	Gateway method of setting socket options. More...

int	set_fd_options (long flags_)
	Gateway method for setting file descriptor options. More...

int	clear_fd_options (long flags_)
	Gateway method for clearing file descriptor options. More...

Protected Attributes inherited from ASSA::Socket
handler_t	m_fd
	File descriptor. More...

int	m_type
	Socket domain type. More...

IOState	m_state
	Control state of the socket. More...

Detailed Description

Definition at line 24 of file ConUDPSocket.h.

Constructor & Destructor Documentation

◆ ConUDPSocket()

ASSA::ConUDPSocket::ConUDPSocket ( )

inline

Constructor.

Definition at line 27 of file ConUDPSocket.h.

References trace.

                     : UDPSocket() {
         char self[] = "ConUDPSocket::ConUDPSocket"; trace(self);
     }

◆ ~ConUDPSocket()

virtual ASSA::ConUDPSocket::~ConUDPSocket ( )

inlinevirtual

Destructor.

Definition at line 32 of file ConUDPSocket.h.

References connect(), read(), trace, unconnect(), and write().

                              {
         char self[] = "ConUDPSocket::~ConUDPSocket"; trace(self);
     } 

Member Function Documentation

◆ connect()

bool ConUDPSocket::connect ( const Address & peer_addr_ )

virtual

Connect socket to the peer.

Parameters

peer_addr_ peer address

Reimplemented from ASSA::Socket.

Definition at line 23 of file ConUDPSocket.cpp.

References ASSA::Socket::failbit, ASSA::Address::getAddress(), ASSA::UDPSocket::getHandler(), ASSA::Address::getLength(), ASSA::Socket::setstate(), trace, and unconnect().

Referenced by unconnect(), and ~ConUDPSocket().

 {
     char self[] = "ConUDPSocket::connect"; trace(self);
 
     if ( ::connect (getHandler(),peer_address_.getAddress(),
                     peer_address_.getLength()) < 0 ) {
         setstate (Socket::failbit);
         return false;
     }
     return true;
 }

◆ in_avail()

virtual int ASSA::ConUDPSocket::in_avail ( ) const

inlinevirtual

This function returns the number of characters immediately available in the get area of the underlying Socketbuf buffer without making a system call if Socket is doing buffering I/O.

It is certain that returned number of characters may be fetched without error, and without accessing any external device.

Implements ASSA::Socket.

Definition at line 63 of file ConUDPSocket.h.

63 { return 0; }

◆ read()

int ConUDPSocket::read	(	char *	buf_,
		const unsigned int	size_
	)

virtual

Read specified number of bytes off the socket.

This function cannot be moved up in class hierarchy because IPv4 read() is very different from UDP read (one time shot).

Parameters

buf_	buffer to save received data into
size_	expected packet size

Returns: number of bytes read or -1 on error, indicating the reason in errno. Packets of 0 size are possible.

Reimplemented from ASSA::Socket.

Definition at line 64 of file ConUDPSocket.cpp.

References ASSA::Socket::eofbit, ASSA::Socket::failbit, ASSA::UDPSocket::getHandler(), ASSA::Socket::setstate(), and write().

Referenced by unconnect(), and ~ConUDPSocket().

 {
     int len;
     len = ::read(getHandler(), packet_, size_);
 
     if (len == -1) {
         setstate (Socket::failbit);
     }
     else if ( len == 0 ) {
         setstate (Socket::failbit | Socket::eofbit);
     }
     return len;
 }

◆ unconnect()

void ConUDPSocket::unconnect ( )

Unconnect connected socket.

Definition at line 37 of file ConUDPSocket.cpp.

References connect(), ASSA::UNIXAddress::getAddress(), ASSA::INETAddress::getAddress(), ASSA::UDPSocket::getDomain(), read(), and trace.

Referenced by connect(), and ~ConUDPSocket().

 {
     // Ignore errors here. On some systems connect() might return
     // EAFNOSUPPORT error, on some might not, but it is OK.
     //
     char self[] = "ConUDPSocket::unconnect"; trace(self);
 
     if ( getDomain() == AF_INET ) {
         INETAddress addr;
         SA_IN* addrp = (SA_IN*) addr.getAddress();
 
         addrp->sin_family = AF_UNSPEC;
         (void) connect(addr);
     }
     else {          // AF_LOCAL
         // I haven't tested whether it works at all.
         
         UNIXAddress addr("");
         SA_UN* addrp = (SA_UN*) addr.getAddress();
 
         addrp->sun_family = AF_UNSPEC;
         (void) connect(addr);       
     }
 }

◆ write()

int ConUDPSocket::write	(	const char *	buf_ = `NULL`,
		const unsigned int	size_ = `0`
	)

virtual

Perform blocking write by writing packet of specified size.

Parameters

buf_	buffer to send
size_	packet size

Reimplemented from ASSA::Socket.

Definition at line 80 of file ConUDPSocket.cpp.

References ASSA::UDPSocket::getHandler().

Referenced by read(), and ~ConUDPSocket().

 {
     return  ::write(getHandler(), (const void*) packet_, size_);
 }

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

/build/libassa-yeEZIG/libassa-3.5.1/assa/ConUDPSocket.h
/build/libassa-yeEZIG/libassa-3.5.1/assa/ConUDPSocket.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConUDPSocket()

◆ ~ConUDPSocket()

Member Function Documentation

◆ connect()

◆ in_avail()

◆ read()

◆ unconnect()

◆ write()