PTLib  Version 2.10.4
PEthSocket Class Reference

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

#include <ethsock.h>

Inheritance diagram for PEthSocket:
PSocket PChannel PObject

List of all members.

Classes

union  Address
 An ethernet MAC Address specification. More...
struct  Frame
 An ethernet MAC frame. More...

Public Member Functions

Constructor
 PEthSocket (PINDEX nReadBuffers=8, PINDEX nWriteBuffers=1, PINDEX size=1514)
 Create a new ethernet packet socket.
 ~PEthSocket ()
 Close the socket.
Overrides from class PChannel
virtual PBoolean Close ()
 Close the channel, shutting down the link to the data source.
virtual PBoolean Read (void *buf, PINDEX len)
 Low level read from the channel.
virtual PBoolean Write (const void *buf, PINDEX len)
 Low level write to the channel.
Overrides from class PSocket
virtual PBoolean Connect (const PString &address)
 Connect a socket to an interface.
virtual PBoolean Listen (unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
 This function is illegal and will assert if attempted.
I/O functions
PBoolean ResetAdaptor ()
 Reset the interface.
PBoolean ReadPacket (PBYTEArray &buffer, Address &dest, Address &src, WORD &type, PINDEX &len, BYTE *&payload)
 Read a packet from the interface and parse out the information specified by the parameters.

Protected Member Functions

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

Protected Attributes

WORD filterType
Address macAddress
MediumTypes medium
unsigned filterMask
PBoolean fakeMacHeader
PBoolean ipppInterface

Information functions

enum  MediumTypes {
  MediumLoop, Medium802_3, MediumWan, MediumUnknown,
  NumMediumTypes
}
 Medium types for the open interface. More...
PBoolean EnumInterfaces (PINDEX idx, PString &name)
 Enumerate all the interfaces that are capable of being accessed at the ethernet level.
PBoolean GetAddress (Address &addr)
 Get the low level MAC address of the open interface.
PBoolean GetIpAddress (PIPSocket::Address &addr)
 Get the prime IP number bound to the open interface.
PBoolean GetIpAddress (PIPSocket::Address &addr, PIPSocket::Address &netMask)
 Get the prime IP number bound to the open interface.
PBoolean EnumIpAddress (PINDEX idx, PIPSocket::Address &addr, PIPSocket::Address &netMask)
 Enumerate all of the IP addresses and net masks bound to the open interface.
MediumTypes GetMedium ()
 Return the type of the interface.

Filtering functions

enum  EthTypes {
  TypeAll = 3, TypeIP = 0x800, TypeX25 = 0x805, TypeARP = 0x806,
  TypeAtalk = 0x809B, TypeAARP = 0x80F3, TypeIPX = 0x8137, TypeIPv6 = 0x86DD
}
 Type codes for ethernet frames. More...
enum  FilterMask {
  FilterDirected = 0x01, FilterMulticast = 0x02, FilterAllMulticast = 0x04, FilterBroadcast = 0x08,
  FilterPromiscuous = 0x10
}
 Mask filter bits for GetFilter() function. More...
PBoolean GetFilter (unsigned &mask, WORD &type)
 Get the current filtering criteria for receiving packets.
PBoolean SetFilter (unsigned mask, WORD type=TypeAll)
 Set the current filtering criteria for receiving packets.

Detailed Description

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


Member Enumeration Documentation

Type codes for ethernet frames.

Enumerator:
TypeAll 

All frames (3 is value for Linux)

TypeIP 

Internet Protocol.

TypeX25 

X.25.

TypeARP 

Address Resolution Protocol.

TypeAtalk 

Appletalk DDP.

TypeAARP 

Appletalk AARP.

TypeIPX 

Novell IPX.

TypeIPv6 

Bluebook IPv6.

Mask filter bits for GetFilter() function.

Enumerator:
FilterDirected 

Packets directed at the interface.

FilterMulticast 

Multicast packets directed at the interface.

FilterAllMulticast 

All multicast packets.

FilterBroadcast 

Packets with a broadcast address.

FilterPromiscuous 

All packets.

Medium types for the open interface.

Enumerator:
MediumLoop 

A Loopback Network.

Medium802_3 

An ethernet Network Interface Card (10base2, 10baseT etc)

MediumWan 

A Wide Area Network (modem etc)

MediumUnknown 

Something else.

NumMediumTypes 

Constructor & Destructor Documentation

PEthSocket::PEthSocket ( PINDEX  nReadBuffers = 8,
PINDEX  nWriteBuffers = 1,
PINDEX  size = 1514 
)

Create a new ethernet packet socket.

Some platforms require a set of buffers to be allocated to avoid losing frequent packets.

Parameters:
nReadBuffersNumber of buffers used for reading.
nWriteBuffersNumber of buffers used for writing.
sizeSize of each buffer.

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:
addressName of interface to connect to.

Reimplemented from PSocket.

PBoolean PEthSocket::EnumInterfaces ( PINDEX  idx,
PString name 
)

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

Begin with index 0, and increment until the function returns false. The name string 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:
true if an interface has the index supplied.
Parameters:
idxIndex of interface
nameInterface name
PBoolean PEthSocket::EnumIpAddress ( PINDEX  idx,
PIPSocket::Address addr,
PIPSocket::Address netMask 
)

Enumerate all of the IP addresses and net masks bound to the open interface.

This allows all the addresses to be found on multi-homed hosts. Begin with index 0 and increment until the function returns false to enumerate all the addresses.

Returns:
true if the address is returned, false on error or if there are no more addresses bound to the interface.
Parameters:
idxIndex
addrVariable to receive the IP address.
netMaskVariable to receive the net mask.

Get the low level MAC address of the open interface.

Returns:
true if the address is returned, false on error.
Parameters:
addrVariable to receive the MAC address.
PBoolean PEthSocket::GetFilter ( unsigned &  mask,
WORD &  type 
)

Get the current filtering criteria for receiving packets.

A bit-wise OR of the FilterMask values will filter packets so that they do not appear in the Read() function at all.

The type is be the specific frame type to accept. A value of TypeAll may be used to match all frame types.

Returns:
A bit mask is returned, a value of 0 indicates an error.
Parameters:
maskBits for filtering on address
typeCode for filtering on type.

Get the prime IP number bound to the open interface.

Returns:
true if the address is returned, false on error.
Parameters:
addrVariable to receive the IP address.

Get the prime IP number bound to the open interface.

This also returns the net mask associated with the open interface.

Returns:
true if the address is returned, false on error.
Parameters:
addrVariable to receive the IP address.
netMaskVariable to receive the net mask.

Return the type of the interface.

Returns:
Type enum for the interface, or NumMediumTypes if interface not open.
virtual const char* PEthSocket::GetProtocolName ( ) const [protected, virtual]

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:
queueSizeNumber of pending accepts that may be queued.
portPort number to use for the connection.
reuseCan/Cant listen more than once.

Reimplemented from PSocket.

virtual PBoolean PEthSocket::OpenSocket ( ) [protected, virtual]

Implements PSocket.

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:
bufPointer to a block of memory to receive the read bytes.
lenMaximum number of bytes to read into the buffer.

Reimplemented from PSocket.

PBoolean PEthSocket::ReadPacket ( PBYTEArray buffer,
Address dest,
Address src,
WORD &  type,
PINDEX &  len,
BYTE *&  payload 
)

Read a packet from the interface and parse out the information specified by the parameters.

This will automatically adjust for 802.2 and 802.3 ethernet frames.

Returns:
true if the packet read, false on error.
Parameters:
bufferBuffer to receive the raw packet
destDestination address of packet
srcSource address of packet
typePacket frame type ID
lenLength of payload
payloadPointer into buffer of payload.

Reset the interface.

PBoolean PEthSocket::SetFilter ( unsigned  mask,
WORD  type = TypeAll 
)

Set the current filtering criteria for receiving packets.

A bit-wise OR of the FilterMask values will filter packets so that they do not appear in the Read() function at all.

The type is be the specific frame type to accept. A value of TypeAll may be used to match all frame types.

A value of zero for the filter mask is useless and will assert.

Returns:
true if the address is returned, false on error.
Parameters:
maskBits for filtering on address
typeCode for filtering on type.
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:
bufPointer to a block of memory to write.
lenNumber of bytes to write.

Reimplemented from PChannel.


Member Data Documentation

unsigned PEthSocket::filterMask [protected]
WORD PEthSocket::filterType [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines