---

lat::Socket Class Reference

Basic socket interface. More...

#include <Iguana/Utilities/classlib/iobase/Socket.h>

Inheritance diagram for lat::Socket:

List of all members.

Public Member Functions
virtual void	abort (void)
virtual Socket *	accept (void)
virtual void	close (void)
virtual int	getopt (int option, void *p, size_t n, int level=SocketConst::OptLevelSocket) const
virtual int	getopt (int option, int level=SocketConst::OptLevelSocket) const
virtual int	linger (int time=-1) const
virtual void	listen (int queuelen=1)
virtual void	oob (bool process=true)
IOSize	peek (IOBuffer into)
virtual IOSize	peek (void *into, IOSize n)
virtual IOSize	read (void *into, IOSize n)
virtual void	setopt (int option, const void *p, size_t n, int level=SocketConst::OptLevelSocket) const
virtual void	setopt (int option, int n, int level=SocketConst::OptLevelSocket) const
virtual void	shutdown (int mode)
virtual int	type (void) const
virtual IOSize	write (const void *from, IOSize n)
	~Socket (void)
Static Public Member Functions
static bool	hasopt (int option)
Protected Member Functions
void	bind (const SocketAddress &addr)
void	connect (const SocketAddress &addr)
virtual Socket *	copy (void)=0
void	create (int af, int type, int protocol)
IOSize	peek (void *into, IOSize n, SocketAddress &source)
size_t	peername (SocketAddress &addr)
IOSize	read (void *into, IOSize n, SocketAddress &source)
virtual void	select (IOSelectMethod *to, const IOSelectRequest &req)
	Socket (void)
size_t	sockname (SocketAddress &addr)
IOSize	write (const void *from, IOSize n, const SocketAddress &dest)
Static Private Member Functions
static void	sysinit (void)
Private Attributes
void *	m_extra
bool	m_oob

---

Detailed Description

Basic socket interface.

The actual implementation and connection details are handled by derived classes, but communication (reading and writing) can be done through this interface.

The sockets support:

• normal and out-of-band (urgent) data
• message peeking (with source identification)
• message source identification
• class interface for useful conversions.

Definition at line 46 of file Socket.h.

---

Constructor & Destructor Documentation

lat::Socket::~Socket

(

void

)

lat::Socket::Socket

(

void

)

[protected]

---

Member Function Documentation

virtual void lat::Socket::abort

(

void

)

[virtual]

Referenced by VisNet::run(), IgNet::run(), and DQMNet::run().

virtual Socket* lat::Socket::accept

(

void

)

[virtual]

Referenced by DQMNet::onPeerConnect(), IgNet::onPeerConnect(), and VisNet::onPeerConnect().

void lat::Socket::bind

(

const SocketAddress &

addr

)

[protected]

virtual void lat::Socket::close

(

void

)

[virtual]

Reimplemented from lat::IOChannel.

Referenced by IgNet::losePeer(), DQMNet::losePeer(), and VisNet::losePeer().

void lat::Socket::connect

(

const SocketAddress &

addr

)

[protected]

virtual Socket* lat::Socket::copy

(

void

)

[protected, pure virtual]

Implemented in lat::InetServerSocket, lat::InetSocket, lat::LocalServerSocket, and lat::LocalSocket.

void lat::Socket::create	(	int	af,
		int	type,
		int	protocol
	)			[protected]

virtual int lat::Socket::getopt	(	int	option,
		void *	p,
		size_t	n,
		int	level = SocketConst::OptLevelSocket
	)			const [virtual]

virtual int lat::Socket::getopt	(	int	option,
		int	level = SocketConst::OptLevelSocket
	)			const [virtual]

static bool lat::Socket::hasopt

(

int

option

)

[static]

virtual int lat::Socket::linger

(

int

time = -1

)

const [virtual]

virtual void lat::Socket::listen

(

int

queuelen = 1

)

[virtual]

virtual void lat::Socket::oob

(

bool

process = true

)

[virtual]

IOSize lat::Socket::peek	(	void *	into,
		IOSize	n,
		SocketAddress &	source
	)			[protected]

IOSize lat::Socket::peek

(

IOBuffer

into

)

virtual IOSize lat::Socket::peek	(	void *	into,
		IOSize	n
	)			[virtual]

size_t lat::Socket::peername

(

SocketAddress &

addr

)

[protected]

IOSize lat::Socket::read	(	void *	into,
		IOSize	n,
		SocketAddress &	source
	)			[protected]

virtual IOSize lat::Socket::read	(	void *	into,
		IOSize	n
	)			[virtual]

Reimplemented from lat::IOChannel.

virtual void lat::Socket::select	(	IOSelectMethod *	to,
		const IOSelectRequest &	req
	)			[protected, virtual]

Reimplemented from lat::IOChannel.

virtual void lat::Socket::setopt	(	int	option,
		const void *	p,
		size_t	n,
		int	level = SocketConst::OptLevelSocket
	)			const [virtual]

virtual void lat::Socket::setopt	(	int	option,
		int	n,
		int	level = SocketConst::OptLevelSocket
	)			const [virtual]

Referenced by VisNet::run(), IgNet::run(), DQMNet::run(), DQMNet::startLocalServer(), VisNet::startLocalServer(), and IgNet::startLocalServer().

virtual void lat::Socket::shutdown

(

int

mode

)

[virtual]

size_t lat::Socket::sockname

(

SocketAddress &

addr

)

[protected]

static void lat::Socket::sysinit

(

void

)

[static, private]

virtual int lat::Socket::type

(

void

)

const [virtual]

IOSize lat::Socket::write	(	const void *	from,
		IOSize	n,
		const SocketAddress &	dest
	)			[protected]

virtual IOSize lat::Socket::write	(	const void *	from,
		IOSize	n
	)			[virtual]

Reimplemented from lat::IOChannel.

---

Member Data Documentation

void* lat::Socket::m_extra [private]

Definition at line 105 of file Socket.h.

bool lat::Socket::m_oob [private]

Definition at line 106 of file Socket.h.

---

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

• Iguana/Utilities/classlib/iobase/Socket.h

---