utl::ServerSocket Class Reference

Local host server socket. More...

#include <ServerSocket.h>

Inheritance diagram for utl::ServerSocket:

Public Member Functions
virtual int	compare (const Object &rhs) const
	Compare with another object. More...
virtual FDstream *	makeSocket () const =0
	Create a utl::FDstream-derived socket suitable for passing to accept. More...
virtual bool	accept (FDstream *socket, InetHostAddress *clientAddr=nullptr)=0
	Accept a client connection. More...
int	fd () const
	Get the file descriptor. More...
void	close ()
	Stop listening for connections. More...
void	setNonBlocking ()
	Set non-blocking mode. More...
Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...
virtual void	copy (const Object &rhs)
	Copy another instance. More...
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...
virtual const Object &	getKey () const
	Get the key for this object. More...
bool	hasKey () const
	Determine whether or not the object has a key. More...
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...
virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...
virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...
virtual String	toString () const
	Return a string representation of self. More...
	operator String () const
	Conversion to String. More...
size_t	allocatedSize () const
	Get the total allocated size of this object. More...
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...
bool	operator< (const Object &rhs) const
	Less-than operator. More...
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...
bool	operator> (const Object &rhs) const
	Greater-than operator. More...
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...
bool	operator== (const Object &rhs) const
	Equal-to operator. More...
bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...
static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...
static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...
static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...
static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Local host server socket.

Author

Adam McKee

Definition at line 24 of file ServerSocket.h.

Member Function Documentation

compare()

virtual int utl::ServerSocket::compare ( const Object &  rhs ) const

virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also

getKey

Returns

< 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs

Parameters

rhs	object to compare with

Reimplemented from utl::Object.

makeSocket()

virtual FDstream* utl::ServerSocket::makeSocket ( ) const

pure virtual

Create a utl::FDstream-derived socket suitable for passing to accept.

Implemented in utl::LocalServerSocket, and utl::TCPserverSocket.

accept()

virtual bool utl::ServerSocket::accept ( FDstream *  socket, InetHostAddress *  clientAddr = nullptr  )

pure virtual

Accept a client connection.

Returns

true iff a connection was accepted

Parameters

socket	socket connection to client
clientAddr	(optional) client address

Implemented in utl::LocalServerSocket, and utl::TCPserverSocket.

fd()

int utl::ServerSocket::fd ( ) const

inline

Get the file descriptor.

Definition at line 45 of file ServerSocket.h.

References utl::deInit(), and utl::init().

close()

void utl::ServerSocket::close

(

)

Stop listening for connections.

setNonBlocking()

void utl::ServerSocket::setNonBlocking

(

)

Set non-blocking mode.

---

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

• ServerSocket.h