---

PEthSocket Class Reference

#include <ethsock.h>

Inheritance diagram for PEthSocket:

List of all members.

Information functions
enum	MediumTypes {   MediumLoop, Medium802_3, MediumWan, MediumUnknown,   NumMediumTypes }
	Medium types for the open interface. More...
BOOL	EnumInterfaces (PINDEX idx, PString &name)
BOOL	GetAddress (Address &addr)
BOOL	GetIpAddress (PIPSocket::Address &addr)
BOOL	GetIpAddress (PIPSocket::Address &addr, PIPSocket::Address &netMask)
BOOL	EnumIpAddress (PINDEX idx, PIPSocket::Address &addr, PIPSocket::Address &netMask)
MediumTypes	GetMedium ()
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...
BOOL	GetFilter (unsigned &mask, WORD &type)
BOOL	SetFilter (unsigned mask, WORD type=TypeAll)
Public Types
Public Methods
Constructor
	PEthSocket (PINDEX nReadBuffers=8, PINDEX nWriteBuffers=1, PINDEX size=1514)
	~PEthSocket ()
	Close the socket.
Overrides from class PChannel
virtual BOOL	Close ()
virtual BOOL	Read (void *buf, PINDEX len)
virtual BOOL	Write (const void *buf, PINDEX len)
Overrides from class PSocket
virtual BOOL	Connect (const PString &address)
virtual BOOL	Listen (unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
I/O functions
BOOL	ResetAdaptor ()
BOOL	ReadPacket (PBYTEArray &buffer, Address &dest, Address &src, WORD &type, PINDEX &len, BYTE *&payload)
Protected Methods
virtual BOOL	OpenSocket ()
virtual const char *	GetProtocolName () const
Protected Attributes
WORD	filterType
Address	macAddress
MediumTypes	medium
unsigned	filterMask
BOOL	fakeMacHeader
BOOL	ipppInterface

---

Detailed Description

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

---

Member Enumeration Documentation

enum PEthSocket::EthTypes

Type codes for ethernet frames. Enumeration values: 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.

enum PEthSocket::FilterMask

Mask filter bits for GetFilter() function. Enumeration values: 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.

enum PEthSocket::MediumTypes

Medium types for the open interface. Enumeration values: 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: nWriteBuffers  Number of buffers used for reading. size  Number of buffers used for writing. Size of each buffer.

PEthSocket::~PEthSocket (    )

Close the socket.

---

Member Function Documentation

virtual BOOL 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 BOOL 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.

BOOL 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: name  Index of interface Interface name

BOOL 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: addr  Index netMask  Variable to receive the IP address. Variable to receive the net mask.

BOOL PEthSocket::GetAddress (  Address &    addr )

Get the low level MAC address of the open interface. Returns: TRUE if the address is returned, FALSE on error. Parameters: addr  Variable to receive the MAC address.

BOOL 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: type  Bits for filtering on address Code for filtering on type.

BOOL PEthSocket::GetIpAddress (  PIPSocket::Address &    addr, PIPSocket::Address &    netMask )

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: netMask  Variable to receive the IP address. Variable to receive the net mask.

BOOL PEthSocket::GetIpAddress (  PIPSocket::Address &    addr )

Get the prime IP number bound to the open interface. Returns: TRUE if the address is returned, FALSE on error. Parameters: addr  Variable to receive the IP address.

MediumTypes PEthSocket::GetMedium (    )

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

virtual const char* PEthSocket::GetProtocolName (    )  [protected, virtual]

This function returns the protocol name for the socket type. Implements PSocket.

virtual BOOL 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: port  Number of pending accepts that may be queued. reuse  Port number to use for the connection. Can/Cant listen more than once. Reimplemented from PSocket.

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

Implements PSocket.

virtual BOOL 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: len  Pointer to a block of memory to receive the read bytes. Maximum number of bytes to read into the buffer. Reimplemented from PSocket.

BOOL 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: dest  Buffer to receive the raw packet src  Destination address of packet type  Source address of packet len  Packet frame type ID payload  Length of payload Pointer into buffer# of payload.

BOOL PEthSocket::ResetAdaptor (    )

Reset the interface.

BOOL 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: type  Bits for filtering on address Code for filtering on type.

virtual BOOL 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: len  Pointer to a block of memory to write. Number of bytes to write. Reimplemented from PChannel.

---

Member Data Documentation

BOOL PEthSocket::fakeMacHeader [protected]

unsigned PEthSocket::filterMask [protected]

WORD PEthSocket::filterType [protected]

BOOL PEthSocket::ipppInterface [protected]

Address PEthSocket::macAddress [protected]

MediumTypes PEthSocket::medium [protected]

---

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

• ethsock.h

---