log4cxx::helpers::Socket Class Reference

Abstract base class for an outgoing socket connection. More...

#include <socket.h>

Inheritance diagram for log4cxx::helpers::Socket:

Public Member Functions
virtual	~Socket ()
virtual size_t	write (ByteBuffer &)=0
virtual void	setNonBlocking (bool newValue)=0
	Use newValue for the behaviour when the network buffer (on an accepted socket connection) is full.
virtual void	open ()=0
	Open this socket.
virtual bool	is_open ()=0
	Is this available for use?
virtual void	close ()=0
	Close this socket.
InetAddressPtr	getInetAddress () const
	Returns the value of this socket's address field.
int	getPort () const
	Returns the value of this socket's port field.
void	setAttributes (const InetAddressPtr &newAddress, int newPort)
	Use newAddress and newPort as the destination.
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 SocketUniquePtr	create (const InetAddressPtr &address, int port, const LogString &concreteClassName={})
	Create a concrete instance of this class.

Protected Member Functions
	Socket (LOG4CXX_PRIVATE_PTR(SocketPrivate) priv)

Detailed Description

Abstract base class for an outgoing socket connection.

A socket is an endpoint for communication between two network connected machines or processes.

Constructor & Destructor Documentation

Socket()

log4cxx::helpers::Socket::Socket ( LOG4CXX_PRIVATE_PTR(SocketPrivate) priv )

protected

~Socket()

virtual log4cxx::helpers::Socket::~Socket ( )

virtual

Member Function Documentation

close()

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

pure virtual

Close this socket.

create()

SocketUniquePtr log4cxx::helpers::Socket::create ( const InetAddressPtr & address, int port, const LogString & concreteClassName = {} )

static

Create a concrete instance of this class.

getInetAddress()

InetAddressPtr log4cxx::helpers::Socket::getInetAddress

(

)

const

Returns the value of this socket's address field.

getPort()

int log4cxx::helpers::Socket::getPort

(

)

const

Returns the value of this socket's port field.

is_open()

virtual bool log4cxx::helpers::Socket::is_open ( )

pure virtual

Is this available for use?

open()

virtual void log4cxx::helpers::Socket::open ( )

pure virtual

Open this socket.

setAttributes()

void log4cxx::helpers::Socket::setAttributes	(	const InetAddressPtr &	newAddress,
		int	newPort )

Use newAddress and newPort as the destination.

setNonBlocking()

virtual void log4cxx::helpers::Socket::setNonBlocking ( bool newValue )

pure virtual

Use newValue for the behaviour when the network buffer (on an accepted socket connection) is full.

When true, an exception is thrown if the write would block.

write()

virtual size_t log4cxx::helpers::Socket::write ( ByteBuffer & )

pure virtual

---

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

• socket.h