PMonitoredSocketChannel Class Reference

This class can be used to access the bundled/monitored UDP sockets using the PChannel API. More...

#include <psockbun.h>

Inheritance diagram for PMonitoredSocketChannel:

Public Member Functions
Construction
	PMonitoredSocketChannel (const PMonitoredSocketsPtr &sockets, bool shared)
	Construct a monitored socket bundle channel.
Overrides from class PSocket
virtual PBoolean	IsOpen () const
	Determine if the channel is currently open.
virtual PBoolean	Close ()
	Close the channel, shutting down the link to the data source.
virtual PBoolean	Read (void *buffer, PINDEX length)
	Override of PChannel functions to allow connectionless reads.
virtual PBoolean	Write (const void *buffer, PINDEX length)
	Override of PChannel functions to allow connectionless writes.
New functions for class
void	SetInterface (const PString &iface)
	Set the interface descriptor to be used for all reads/writes to this channel.
PString	GetInterface ()
	Get the current interface descriptor being used/.
bool	GetLocal (PIPSocket::Address &address, WORD &port, bool usingNAT)
	Get the local IP address and port for the currently selected interface.
void	SetRemote (const PIPSocket::Address &address, WORD port)
	Set the remote address/port for all Write() functions.
void	SetRemote (const PString &hostAndPort)
	Set the remote address/port for all Write() functions.
void	GetRemote (PIPSocket::Address &addr, WORD &port) const
	Get the current remote address/port for all Write() functions.
void	SetPromiscuous (bool flag)
	Set flag for receiving UDP data from any remote address.
bool	GetPromiscuous ()
	Get flag for receiving UDP data from any remote address.
void	GetLastReceived (PIPSocket::Address &addr, WORD &port) const
	Get the IP address and port of the last received UDP data.
PString	GetLastReceivedInterface () const
	Get the interface the last received UDP data was recieved on.
const PMonitoredSocketsPtr &	GetMonitoredSockets () const
	Get the monitored socket bundle being used by this channel.
Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified.
	PChannel ()
	Create the channel.
	~PChannel ()
	Close down the channel.
virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two strings.
virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries.
virtual PString	GetName () const
	Get the platform and I/O channel type name of the channel.
int	GetHandle () const
	Get the integer operating system handle for the channel.
virtual PChannel *	GetBaseReadChannel () const
	Get the base channel of channel indirection using PIndirectChannel.
virtual PChannel *	GetBaseWriteChannel () const
	Get the base channel of channel indirection using PIndirectChannel.
void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations.
PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations.
virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call.
virtual int	ReadChar ()
	Read a single 8 bit byte from the channel.
PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel.
PString	ReadString (PINDEX len)
	Read len character into a string from the channel.
virtual PBoolean	ReadAsync (void *buf, PINDEX len)
	Begin an asynchronous read from channel.
virtual void	OnReadComplete (void *buf, PINDEX len)
	User callback function for when a ReadAsync() call has completed or timed out.
void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete.
PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete.
virtual PBoolean	Write (const void *buf, PINDEX len, const void *mark)
	Low level write to the channel with marker.
virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call.
PBoolean	WriteChar (int c)
	Write a single character to the channel.
PBoolean	WriteString (const PString &str)
	Write a string to the channel.
virtual PBoolean	WriteAsync (const void *buf, PINDEX len)
	Begin an asynchronous write from channel.
virtual void	OnWriteComplete (const void *buf, PINDEX len)
	User callback function for when a WriteAsync() call has completed or timed out.
virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a channel.
virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode.
virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination.
PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes.
PBoolean	SendCommandString (const PString &command)
	Send a command meta-string.
void	AbortCommandString ()
	Abort a command string that is in progress.
Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code.
int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code.
virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description.
virtual PBoolean	Read (const VectorOfSlice &slices)
	Low level scattered read from the channel.
virtual PBoolean	Write (const VectorOfSlice &slices)
	Low level scattered write to the channel.
Public Member Functions inherited from PObject
virtual	~PObject ()
virtual PObject *	Clone () const
	Create a copy of the class on the heap.
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects.
bool	operator== (const PObject &obj) const
	Compare the two objects.
bool	operator!= (const PObject &obj) const
	Compare the two objects.
bool	operator< (const PObject &obj) const
	Compare the two objects.
bool	operator> (const PObject &obj) const
	Compare the two objects.
bool	operator<= (const PObject &obj) const
	Compare the two objects.
bool	operator>= (const PObject &obj) const
	Compare the two objects.
virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance.
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class.
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream.
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream.

Protected Attributes
PMonitoredSocketsPtr	socketBundle
bool	sharedBundle
PString	currentInterface
bool	promiscuousReads
PIPSocket::Address	remoteAddress
bool	closing
WORD	remotePort
PIPSocket::Address	lastReceivedAddress
WORD	lastReceivedPort
PString	lastReceivedInterface
PMutex	mutex
Protected Attributes inherited from PChannel
int	os_handle
	The operating system file handle return by standard open() function.
Errors	lastErrorCode [NumErrorGroups+1]
	The platform independant error code.
int	lastErrorNumber [NumErrorGroups+1]
	The operating system error number (eg as returned by errno).
PINDEX	lastReadCount
	Number of byte last read by the Read() function.
PINDEX	lastWriteCount
	Number of byte last written by the Write() function.
PTimeInterval	readTimeout
	Timeout for read operations.
PTimeInterval	writeTimeout
	Timeout for write operations.
PString	channelName
PMutex	px_threadMutex
PXBlockType	px_lastBlockType
PThread *	px_readThread
PThread *	px_writeThread
PMutex	px_writeMutex
PThread *	px_selectThread [3]
PMutex	px_selectMutex [3]

Additional Inherited Members
Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }
enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }
enum	Errors {   NoError, NotFound, FileExists, DiskFull,   AccessDenied, DeviceInUse, BadParameter, NoMemory,   NotOpen, Timeout, Interrupted, BufferTooSmall,   Miscellaneous, ProtocolFailure, NumNormalisedErrors }
	Normalised error codes. More...
enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...
typedef std::vector< Slice >	VectorOfSlice
Static Public Member Functions inherited from PChannel
static PBoolean	ConvertOSError (int libcReturnValue, Errors &lastError, int &osError)
	Convert an operating system error into platform independent error.
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description.
Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)
PChannel &	operator= (const PChannel &)
virtual PBoolean	ConvertOSError (int libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error.
int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout.
PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)
PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
int	PXClose ()
Friends inherited from PObject

Detailed Description

This class can be used to access the bundled/monitored UDP sockets using the PChannel API.

Constructor & Destructor Documentation

PMonitoredSocketChannel::PMonitoredSocketChannel	(	const PMonitoredSocketsPtr &	sockets,
		bool	shared
	)

Construct a monitored socket bundle channel.

Parameters

sockets	Monitored socket bundle to use in channel
shared	Monitored socket is shared by other channels

Member Function Documentation

virtual PBoolean PMonitoredSocketChannel::Close ( )

virtual

Close the channel, shutting down the link to the data source.

Returns

true if the channel successfully closed.

Reimplemented from PChannel.

PString PMonitoredSocketChannel::GetInterface

(

)

Get the current interface descriptor being used/.

void PMonitoredSocketChannel::GetLastReceived ( PIPSocket::Address &  addr, WORD &  port  ) const

inline

Get the IP address and port of the last received UDP data.

Parameters

addr	Remote IP address
port	Remote port number

References lastReceivedAddress, and lastReceivedPort.

PString PMonitoredSocketChannel::GetLastReceivedInterface ( ) const

inline

Get the interface the last received UDP data was recieved on.

References lastReceivedInterface.

bool PMonitoredSocketChannel::GetLocal	(	PIPSocket::Address &	address,
		WORD &	port,
		bool	usingNAT
	)

Get the local IP address and port for the currently selected interface.

Parameters

address	IP address of local interface
port	Port listening on
usingNAT	Require NAT address/port

const PMonitoredSocketsPtr& PMonitoredSocketChannel::GetMonitoredSockets ( ) const

inline

Get the monitored socket bundle being used by this channel.

References socketBundle.

bool PMonitoredSocketChannel::GetPromiscuous ( )

inline

Get flag for receiving UDP data from any remote address.

References promiscuousReads.

void PMonitoredSocketChannel::GetRemote ( PIPSocket::Address &  addr, WORD &  port  ) const

inline

Get the current remote address/port for all Write() functions.

Parameters

addr	Remote IP address
port	Remote port number

References remoteAddress, and remotePort.

virtual PBoolean PMonitoredSocketChannel::IsOpen ( ) const

virtual

Determine if the channel is currently open.

This indicates that read and write operations can be executed on the channel. For example, in the PFile class it returns if the file is currently open.

Returns

true if the channel is open.

Reimplemented from PChannel.

virtual PBoolean PMonitoredSocketChannel::Read ( void *  buffer, PINDEX  length  )

virtual

Override of PChannel functions to allow connectionless reads.

Reimplemented from PChannel.

void PMonitoredSocketChannel::SetInterface

(

const PString &

iface

)

Set the interface descriptor to be used for all reads/writes to this channel.

The iface parameter can be a partial descriptor eg "%eth0".

Parameters

iface

Interface descriptor

void PMonitoredSocketChannel::SetPromiscuous ( bool  flag )

inline

Set flag for receiving UDP data from any remote address.

If the flag is false then data received from anything other than the configured remote address and port is ignored.

Parameters

flag

New flag

References promiscuousReads.

void PMonitoredSocketChannel::SetRemote	(	const PIPSocket::Address &	address,
		WORD	port
	)

Set the remote address/port for all Write() functions.

Parameters

address	Remote IP address
port	Remote port number

void PMonitoredSocketChannel::SetRemote

(

const PString &

hostAndPort

)

Set the remote address/port for all Write() functions.

Parameters

hostAndPort

String of the form host[:port]

virtual PBoolean PMonitoredSocketChannel::Write ( const void *  buffer, PINDEX  length  )

virtual

Override of PChannel functions to allow connectionless writes.

Reimplemented from PChannel.

Member Data Documentation

bool PMonitoredSocketChannel::closing

protected

PString PMonitoredSocketChannel::currentInterface

protected

PIPSocket::Address PMonitoredSocketChannel::lastReceivedAddress

protected

Referenced by GetLastReceived().

PString PMonitoredSocketChannel::lastReceivedInterface

protected

Referenced by GetLastReceivedInterface().

WORD PMonitoredSocketChannel::lastReceivedPort

protected

Referenced by GetLastReceived().

PMutex PMonitoredSocketChannel::mutex

protected

bool PMonitoredSocketChannel::promiscuousReads

protected

Referenced by GetPromiscuous(), and SetPromiscuous().

PIPSocket::Address PMonitoredSocketChannel::remoteAddress

protected

Referenced by GetRemote().

WORD PMonitoredSocketChannel::remotePort

protected

Referenced by GetRemote().

bool PMonitoredSocketChannel::sharedBundle

protected

PMonitoredSocketsPtr PMonitoredSocketChannel::socketBundle

protected

Referenced by GetMonitoredSockets().

---

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

• psockbun.h