log4cxx::helpers::DatagramSocket Class Reference

This class represents a socket for sending and receiving datagram packets. More...

#include <datagramsocket.h>

Inheritance diagram for log4cxx::helpers::DatagramSocket:

Public Member Functions
virtual	~DatagramSocket ()
	ensure the socket is closed.
virtual void	bind (int lport, InetAddressPtr laddress)=0
	Binds a datagram socket to a local port and address.
virtual void	close ()
	Closes this datagram socket.
virtual void	connect (InetAddressPtr address, int port)=0
	Connects the socket to a remote address for this socket.
InetAddressPtr	getInetAddress () const
	Returns the address to which this socket is connected.
InetAddressPtr	getLocalAddress () const
	Gets the local address to which the socket is bound.
int	getLocalPort () const
	Returns the port number on the local host to which this socket is bound.
int	getPort () const
	Returns the port for this socket.
bool	isBound () const
	Returns the binding state of the socket.
virtual bool	isClosed () const =0
	Returns wether the socket is closed or not.
bool	isConnected () const
	Returns the connection state of the socket.
virtual void	receive (DatagramPacketPtr &p)=0
	Receives a datagram packet from this socket.
virtual void	send (DatagramPacketPtr &p)=0
	Sends a datagram packet from this socket.
Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()
virtual const helpers::Class &	getClass () const =0
virtual bool	instanceof (const Class &clazz) const =0
virtual const void *	cast (const Class &clazz) const =0

Static Public Member Functions
static DatagramSocketUniquePtr	create ()
	Constructs a datagram socket and binds it to any available port on the local host machine.
static DatagramSocketUniquePtr	create (int port)
	Constructs a datagram socket and binds it to the specified port on the local host machine.
static DatagramSocketUniquePtr	create (int port, InetAddressPtr laddr)
	Creates a datagram socket, bound to the specified local address.

Protected Member Functions
	DatagramSocket (LOG4CXX_PRIVATE_PTR(DatagramSocketPriv) priv)

Detailed Description

This class represents a socket for sending and receiving datagram packets.

Constructor & Destructor Documentation

DatagramSocket()

log4cxx::helpers::DatagramSocket::DatagramSocket ( LOG4CXX_PRIVATE_PTR(DatagramSocketPriv)  priv )

protected

~DatagramSocket()

virtual log4cxx::helpers::DatagramSocket::~DatagramSocket ( )

virtual

ensure the socket is closed.

Member Function Documentation

bind()

virtual void log4cxx::helpers::DatagramSocket::bind ( int  lport, InetAddressPtr  laddress  )

pure virtual

Binds a datagram socket to a local port and address.

close()

virtual void log4cxx::helpers::DatagramSocket::close ( )

virtual

Closes this datagram socket.

connect()

virtual void log4cxx::helpers::DatagramSocket::connect ( InetAddressPtr  address, int  port  )

pure virtual

Connects the socket to a remote address for this socket.

create() [1/3]

static DatagramSocketUniquePtr log4cxx::helpers::DatagramSocket::create ( )

static

Constructs a datagram socket and binds it to any available port on the local host machine.

create() [2/3]

static DatagramSocketUniquePtr log4cxx::helpers::DatagramSocket::create ( int  port )

static

Constructs a datagram socket and binds it to the specified port on the local host machine.

create() [3/3]

static DatagramSocketUniquePtr log4cxx::helpers::DatagramSocket::create ( int  port, InetAddressPtr  laddr  )

static

Creates a datagram socket, bound to the specified local address.

getInetAddress()

InetAddressPtr log4cxx::helpers::DatagramSocket::getInetAddress

(

)

const

Returns the address to which this socket is connected.

getLocalAddress()

InetAddressPtr log4cxx::helpers::DatagramSocket::getLocalAddress

(

)

const

Gets the local address to which the socket is bound.

getLocalPort()

int log4cxx::helpers::DatagramSocket::getLocalPort

(

)

const

Returns the port number on the local host to which this socket is bound.

getPort()

int log4cxx::helpers::DatagramSocket::getPort

(

)

const

Returns the port for this socket.

isBound()

bool log4cxx::helpers::DatagramSocket::isBound

(

)

const

Returns the binding state of the socket.

isClosed()

virtual bool log4cxx::helpers::DatagramSocket::isClosed ( ) const

pure virtual

Returns wether the socket is closed or not.

isConnected()

bool log4cxx::helpers::DatagramSocket::isConnected

(

)

const

Returns the connection state of the socket.

receive()

virtual void log4cxx::helpers::DatagramSocket::receive ( DatagramPacketPtr &  p )

pure virtual

Receives a datagram packet from this socket.

send()

virtual void log4cxx::helpers::DatagramSocket::send ( DatagramPacketPtr &  p )

pure virtual

Sends a datagram packet from this socket.

---

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

• datagramsocket.h