ethsock.h

Go to the documentation of this file.

/*
 * ethsock.h
 *
 * Direct Ethernet socket I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 20385 $
 * $Author: rjongbloed $
 * $Date: 2008-06-04 10:40:38 +0000 (Wed, 04 Jun 2008) $
 */

#ifndef _PETHSOCKET
#define _PETHSOCKET

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/socket.h>

#ifdef _WIN32
class PWin32PacketDriver;
class PWin32SnmpLibrary;
class PWin32PacketBuffer;

PARRAY(PWin32PackBufArray, PWin32PacketBuffer);
#endif

class PEthSocket : public PSocket
{
  PCLASSINFO(PEthSocket, PSocket);

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

    ~PEthSocket();


  public:
#pragma pack(1)

    union Address {
      BYTE b[6];
      WORD w[3];
      struct {
        DWORD l;
        WORD  s;
      } ls;

      Address();
      Address(const BYTE * addr);
      Address(const Address & addr);
      Address(const PString & str);
      Address & operator=(const Address & addr);
      Address & operator=(const PString & str);

      bool operator==(const BYTE * eth) const;
      bool operator!=(const BYTE * eth) const;
      bool operator==(const Address & eth) const { return ls.l == eth.ls.l && ls.s == eth.ls.s; }
      bool operator!=(const Address & eth) const { return ls.l != eth.ls.l || ls.s != eth.ls.s; }

      operator PString() const;

      friend ostream & operator<<(ostream & s, const Address & a)
        { return s << (PString)a; }
    };

    struct Frame {
      Address dst_addr;
      Address src_addr;
      union {
        struct {
          WORD type;
          BYTE payload[1500];
        } ether;
        struct {
          WORD length;
          BYTE dsap;
          BYTE ssap;
          BYTE ctrl;
          BYTE oui[3];
          WORD type;
          BYTE payload[1492];
        } snap;
      };

      void Parse(
        WORD & type,      // Type of frame
        BYTE * & payload, // Pointer to payload
        PINDEX & length   // Length of payload (on input is full frame length)
      );
    };
#pragma pack()

    virtual PBoolean Close();

    virtual PBoolean Read(
      void * buf,   
      PINDEX len    
    );

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

    virtual PBoolean Connect(
      const PString & address   
    );

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


    PBoolean EnumInterfaces(
      PINDEX idx,      
      PString & name   
    );


    PBoolean GetAddress(
      Address & addr   
    );

    PBoolean GetIpAddress(
      PIPSocket::Address & addr     
    );

    PBoolean GetIpAddress(
      PIPSocket::Address & addr,    
      PIPSocket::Address & netMask  
    );

    PBoolean EnumIpAddress(
      PINDEX idx,                   
      PIPSocket::Address & addr,    
      PIPSocket::Address & netMask  
    );


    enum MediumTypes {
      MediumLoop,     
      Medium802_3,    
      MediumWan,      
      MediumUnknown,  
      NumMediumTypes
    };
    MediumTypes GetMedium();



    enum EthTypes {
      TypeAll = 3,          
      TypeIP  = 0x800,      
      TypeX25 = 0x805,      
      TypeARP = 0x806,      
      TypeAtalk = 0x809B,   
      TypeAARP = 0x80F3,    
      TypeIPX = 0x8137,     
      TypeIPv6 = 0x86DD     
    };

    enum FilterMask {
      FilterDirected     = 0x01,    
      FilterMulticast    = 0x02,    
      FilterAllMulticast = 0x04,    
      FilterBroadcast    = 0x08,    
      FilterPromiscuous  = 0x10     
    };

    PBoolean GetFilter(
      unsigned & mask,  
      WORD & type       
    );

    PBoolean SetFilter(
      unsigned mask,       
      WORD type = TypeAll  
    );


    PBoolean ResetAdaptor();

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

  protected:
    virtual PBoolean OpenSocket();
    virtual const char * GetProtocolName() const;


    WORD filterType;  // Remember the set filter frame type


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/ethsock.h"
#else
#include "unix/ptlib/ethsock.h"
#endif
};

#endif

// End Of File ///////////////////////////////////////////////////////////////

---