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): ______________________________________.
 */

#ifndef PTLIB_ETHSOCKET_H
#define PTLIB_ETHSOCKET_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/ipsock.h>


class PEthSocket : public PSocket
{
    PCLASSINFO(PEthSocket, PSocket);
  public:
    PEthSocket(
      bool promiscuous =  true,     
      unsigned snapLength = 65536   
    );

    ~PEthSocket();


  public:
    P_DECLARE_STREAMABLE_ENUM(MediumType,
      MediumLoop,      
      Medium802_3,     
      MediumWan,       
      MediumLinuxSLL,  
      MediumUnknown   
    );

#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; }
    };
#pragma pack()

    virtual PString GetName() const { return m_channelName; }

    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 
    );


    static PStringArray EnumInterfaces(
      bool detailed = true
    );


    MediumType GetMedium();

    const PTime & GetLastPacketTime() const { return m_lastPacketTime; }


    const PString & GetFilter() const { return m_filter; }

    bool SetFilter(
      const PString & filter   
    );


    class Frame : public PObject
    {
        PCLASSINFO(Frame, PObject);
      public:
        Frame(
          PINDEX maxSize = 65536
        );
        Frame(
          const Frame & frame
        );

        virtual bool Write(
          PChannel & channel
        ) const;

        virtual bool Read(
          PChannel & channel,
          PINDEX packetSize = P_MAX_INDEX
        );

        void PreRead();

        int GetDataLink(
          PBYTEArray & payload
        );
        int GetDataLink(
          PBYTEArray & payload,
          Address & src,
          Address & dst
        );
        BYTE * CreateDataLink(
          const Address & src,
          const Address & dst,
          unsigned proto,
          PINDEX length
        );

        int GetIP(
          PBYTEArray & payload
        );
        int GetIP(
          PBYTEArray & payload,
          PIPSocket::Address & src,
          PIPSocket::Address & dst
        );
        BYTE * CreateIP(
          const PIPSocket::Address & src,
          const PIPSocket::Address & dst,
          unsigned proto,
          PINDEX length
        );

        bool GetUDP(
          PBYTEArray & payload,
          WORD & srcPort,
          WORD & dstPort
        );
        bool GetUDP(
          PBYTEArray & payload,
          PIPSocketAddressAndPort & src,
          PIPSocketAddressAndPort & dst
        );
        BYTE * CreateUDP(
          const PIPSocketAddressAndPort & src,
          const PIPSocketAddressAndPort & dst,
          PINDEX length,
          const void * data = NULL
        );

        bool GetTCP(
          PBYTEArray & payload,
          WORD & srcPort,
          WORD & dstPort
        );
        bool GetTCP(
          PBYTEArray & payload,
          PIPSocketAddressAndPort & src,
          PIPSocketAddressAndPort & dst
        );
        BYTE * CreateTCP(
          const PIPSocketAddressAndPort & src,
          const PIPSocketAddressAndPort & dst,
          PINDEX length,
          const void * data = NULL
        );

        const PTime & GetTimestamp() const { return m_timestamp; }
        bool IsFragmentated() const { return m_fragmentated; }

        PINDEX GetSize() const { return m_rawSize; }

        void SetDataLinkType(unsigned dataLinkType) { m_dataLinkType = dataLinkType;  }
        unsigned GetDataLinkType() const { return m_dataLinkType;  }

      protected:
        PBYTEArray  m_rawData;
        PINDEX      m_rawSize;
        unsigned    m_dataLinkType;

        PBYTEArray  m_fragments;
        bool        m_fragmentated;
        unsigned    m_fragmentProto;
        bool        m_fragmentProcessed;

        PTime              m_timestamp;
        PIPSocket::Address m_fragmentSrcIP;
        PIPSocket::Address m_fragmentDstIP;
    };

    bool ReadFrame(
      Frame & frame
    ) { return frame.Read(*this); }

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

    PString  m_channelName;
    bool     m_promiscuous;
    unsigned m_snapLength;
    PString  m_filter;  // Filter expression

    struct InternalData;
    InternalData * m_internal;

    PTime m_lastPacketTime;
};


class PEthSocketThread : public PObject
{
    PCLASSINFO(PEthSocketThread, PObject);
  public:
    #define PDECLARE_EthFrameNotifier(cls, fn) PDECLARE_NOTIFIER2(PEthSocket, cls, fn, PEthSocket::Frame &)
    typedef PNotifierTemplate<PEthSocket::Frame &> FrameNotifier;

    PEthSocketThread(const FrameNotifier & notifier = NULL);
    ~PEthSocketThread() { Stop(); }

    virtual bool Start(
      const PString & device,
      const PString & filter = PString::Empty(),
      PThread::Priority priority = PThread::NormalPriority
    );

    virtual void Stop();

    bool IsRunning() const { return m_running; }

    virtual PEthSocket * CreateEthSocket() const;

    void SetNotifier(
      const FrameNotifier & notifier
    ) { m_notifier = notifier; }

    PEthSocket * GetSocket() const { return m_socket; }

  protected:
    virtual void MainLoop();

    FrameNotifier     m_notifier;
    PThread         * m_thread;
    PEthSocket      * m_socket;
    PEthSocket::Frame m_frame;
    bool              m_running;
};


#endif // PTLIB_ETHSOCKET_H


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