This class describes a type of socket that will communicate using raw ethernet packets. More...

#include <ethsock.h>

Inheritance diagram for PEthSocket:

Collaboration diagram for PEthSocket:

Classes
union	Address
	An ethernet MAC Address specification. More...

class	Frame
	An ethernet MAC frame. More...

Public Member Functions
	P_DECLARE_STREAMABLE_ENUM (MediumType, MediumLoop, Medium802_3, MediumWan, MediumLinuxSLL, MediumUnknown)
	Medium types for the open interface. More...

Constructor
	PEthSocket (bool promiscuous=true, unsigned snapLength=65536)
	Create a new ethernet packet socket. More...

	~PEthSocket ()
	Close the socket. More...

Overrides from class PChannel
virtual PString	GetName () const
	Get the platform and I/O channel type name of the channel. More...

virtual PBoolean	Close ()
	Close the channel, shutting down the link to the data source. More...

virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

Overrides from class PSocket
virtual PBoolean	Connect (const PString &address)
	Connect a socket to an interface. More...

virtual PBoolean	Listen (unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
	This function is illegal and will assert if attempted. More...

Filtering functions
const PString &	GetFilter () const
	Get the current filtering criteria for receiving packets. More...

bool	SetFilter (const PString &filter)
	Set the current filtering criteria for receiving packets. More...

I/O functions
bool	ReadFrame (Frame &frame)
	Read a frame from the interface. More...

Public Member Functions inherited from PSocket
	~PSocket ()

PBoolean	SetOption (int option, int value, int level=SOL_SOCKET)
	Set options on the socket. More...

PBoolean	SetOption (int option, const void *valuePtr, PINDEX valueSize, int level=SOL_SOCKET)
	Set options on the socket. More...

PBoolean	GetOption (int option, int &value, int level=SOL_SOCKET)
	Get options on the socket. More...

PBoolean	GetOption (int option, void *valuePtr, PINDEX valueSize, int level=SOL_SOCKET)
	Get options on the socket. More...

virtual bool	Read (Slice *slices, size_t sliceCount)
	Low level scattered read from the channel. More...

virtual bool	Write (const Slice *slices, size_t sliceCount)
	Low level scattered write to the channel. More...

virtual PBoolean	Accept (PSocket &socket)
	Open a socket to a remote host on the specified port number. More...

virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a socket. More...

virtual WORD	GetPortByService (const PString &service) const
	Get the port number for the specified service name. More...

virtual PString	GetServiceByPort (WORD port) const
	Get the service name from the port number. More...

void	SetPort (WORD port)
	Set the port number for the channel. More...

void	SetPort (const PString &service)
	Set the port number for the channel. More...

WORD	GetPort () const
	Get the port the TCP socket channel object instance is using. More...

PString	GetService () const
	Get a service name for the port number the TCP socket channel object instance is using. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two strings. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open. More...

virtual P_INT_PTR	GetHandle () const
	Get the integer operating system handle for the channel. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

virtual PChannel *	GetBaseReadChannel () const
	Get the base channel of channel indirection using PIndirectChannel. More...

virtual PChannel *	GetBaseWriteChannel () const
	Get the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

virtual int	ReadChar ()
	Read a single character from the channel. More...

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual PBoolean	OpenSocket ()

virtual const char *	GetProtocolName () const
	This function returns the protocol name for the socket type. More...

Protected Member Functions inherited from PSocket
	PSocket ()

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

int	os_close ()

int	os_socket (int af, int type, int proto)

PBoolean	os_connect (struct sockaddr *sin, socklen_t size)

PBoolean	os_vread (Slice slices, size_t sliceCount, int flags, struct sockaddr from, socklen_t *fromlen)

PBoolean	os_vwrite (const Slice slices, size_t sliceCount, int flags, struct sockaddr to, socklen_t tolen)

PBoolean	os_accept (PSocket &listener, struct sockaddr addr, socklen_t size)

virtual int	os_errno () const

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PString	m_channelName

bool	m_promiscuous

unsigned	m_snapLength

PString	m_filter

InternalData *	m_internal

PTime	m_lastPacketTime

Protected Attributes inherited from PSocket
WORD	m_port
	Port to be used by the socket when opening the channel. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Information functions
MediumType	GetMedium ()
	Return the data link of the interface. More...

const PTime &	GetLastPacketTime () const
	Return the capture time of the last read packet. More...

static PStringArray	EnumInterfaces (bool detailed=true)
	Enumerate all the interfaces that are capable of being accessed at the ethernet level. More...

Additional Inherited Members
Public Types inherited from PSocket
enum	Reusability { CanReuseAddress, AddressIsExclusive }
	Flags to reuse of port numbers in Listen() function. More...

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PSocket
static int	Select (PSocket &sock1, PSocket &sock2)
	Select a socket with available data. More...

static int	Select (PSocket &sock1, PSocket &sock2, const PTimeInterval &timeout)
	Select a socket with available data. More...

static Errors	Select (SelectList &read)
	Select a socket with available data. More...

static Errors	Select (SelectList &read, const PTimeInterval &timeout)
	Select a socket with available data. More...

static Errors	Select (SelectList &read, SelectList &write)
	Select a socket with available data. More...

static Errors	Select (SelectList &read, SelectList &write, const PTimeInterval &timeout)
	Select a socket with available data. More...

static Errors	Select (SelectList &read, SelectList &write, SelectList &except)
	Select a socket with available data. More...

static Errors	Select (SelectList &read, SelectList &write, SelectList &except, const PTimeInterval &timeout)
	Select a socket with available data. More...

static WORD	Host2Net (WORD v)
	Convert from host to network byte order. More...

static DWORD	Host2Net (DWORD v)
	Convert from host to network byte order. More...

static WORD	Net2Host (WORD v)
	Convert from network to host byte order. More...

static DWORD	Net2Host (DWORD v)
	Convert from network to host byte order. More...

static WORD	GetProtocolByName (const PString &name)
	Get the number of the protocol associated with the specified name. More...

static PString	GetNameByProtocol (WORD proto)
	Get the name of the protocol number specified. More...

static WORD	GetPortByService (const char *protocol, const PString &service)
	Get the port number for the specified service name. More...

static PString	GetServiceByPort (const char *protocol, WORD port)
	Get the service name from the port number. More...

Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Static Public Attributes inherited from PSocket
static unsigned	NoBufferRetryCount

Detailed Description

This class describes a type of socket that will communicate using raw ethernet packets.

Constructor & Destructor Documentation

PEthSocket::PEthSocket	(	bool	promiscuous = `true`,
		unsigned	snapLength = `65536`
	)

Create a new ethernet packet socket.

Parameters

promiscuous	Indicates all packets to be received, not just ones directed to this interface address
snapLength	Maximum data size for each apcket capture.

PEthSocket::~PEthSocket ( )

Close the socket.

Member Function Documentation

virtual PBoolean PEthSocket::Close ( )

virtual

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

Returns: true if the channel successfully closed.

Reimplemented from PChannel.

virtual PBoolean PEthSocket::Connect ( const PString & address )

virtual

Connect a socket to an interface.

The first form opens an interface by a name as returned by the EnumInterfaces() function. The second opens the interface that has the specified MAC address.

Returns: true if the channel was successfully connected to the interface.

Parameters

address Name of interface to connect to.

Reimplemented from PSocket.

static PStringArray PEthSocket::EnumInterfaces ( bool detailed = true )

static

Enumerate all the interfaces that are capable of being accessed at the ethernet level.

The name string(s) returned can be passed, unchanged, to the Connect() function.

Note that the driver does not need to be open for this function to work.

Returns: Empty array if no devices are available.

const PString& PEthSocket::GetFilter ( ) const

inline

Get the current filtering criteria for receiving packets.

References m_filter.

const PTime& PEthSocket::GetLastPacketTime ( ) const

inline

Return the capture time of the last read packet.

References m_lastPacketTime.

MediumType PEthSocket::GetMedium ( )

Return the data link of the interface.

Returns: Type enum for the interface, or NumMediumTypes if interface not open.

virtual PString PEthSocket::GetName ( ) const

inlinevirtual

Get the platform and I/O channel type name of the channel.

For example, it would return the filename in PFile type channels.

Returns: the name of the channel.

Implements PChannel.

References m_channelName.

virtual const char* PEthSocket::GetProtocolName ( ) const

protectedvirtual

This function returns the protocol name for the socket type.

Implements PSocket.

virtual PBoolean PEthSocket::Listen	(	unsigned	queueSize = `5`,
		WORD	port = `0`,
		Reusability	reuse = `AddressIsExclusive`
	)

virtual

This function is illegal and will assert if attempted.

You must be connected to an interface using Connect() to do I/O on the socket.

Returns: true if the channel was successfully opened.

Parameters

queueSize	Number of pending accepts that may be queued.
port	Port number to use for the connection.
reuse	Can/Cant listen more than once.

Reimplemented from PSocket.

virtual PBoolean PEthSocket::OpenSocket ( )

protectedvirtual

Implements PSocket.

PEthSocket::P_DECLARE_STREAMABLE_ENUM	(	MediumType	,
		MediumLoop	,
		Medium802_3	,
		MediumWan	,
		MediumLinuxSLL	,
		MediumUnknown
	)

Medium types for the open interface.

virtual PBoolean PEthSocket::Read	(	void *	buf,
		PINDEX	len
	)

virtual

Low level read from the channel.

This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read.

The GetErrorCode() function should be consulted after Read() returns false to determine what caused the failure.

Returns: true indicates that at least one character was read from the channel. false means no bytes were read due to timeout or some other I/O error.

Parameters

buf	Pointer to a block of memory to receive the read bytes.
len	Maximum number of bytes to read into the buffer.

Reimplemented from PSocket.

bool PEthSocket::ReadFrame ( Frame & frame )

inline

Read a frame from the interface.

Note that for correct decoding of fragmented IP packets, you should make consecutive calls to this function with the same instance of Frame which maintains some context.

Returns: true if the packet read, false on error.

References PEthSocket::Frame::Read().

bool PEthSocket::SetFilter ( const PString & filter )

Set the current filtering criteria for receiving packets.

See http://www.tcpdump.org for the expression syntax.

Returns: true if the filter expression is valid.

Parameters

filter Bits for filtering on address

virtual PBoolean PEthSocket::Write	(	const void *	buf,
		PINDEX	len
	)

virtual

Low level write to the channel.

This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written.

The GetErrorCode() function should be consulted after Write() returns false to determine what caused the failure.

Returns: true if at least len bytes were written to the channel.

Parameters

buf	Pointer to a block of memory to write.
len	Number of bytes to write.

Reimplemented from PSocket.

Member Data Documentation

PString PEthSocket::m_channelName

protected

Referenced by GetName().

PString PEthSocket::m_filter

protected

Referenced by GetFilter().

InternalData* PEthSocket::m_internal

protected

PTime PEthSocket::m_lastPacketTime

protected

Referenced by GetLastPacketTime().

bool PEthSocket::m_promiscuous

protected

unsigned PEthSocket::m_snapLength

protected

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

ethsock.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Information functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation