ipxsock.h

Go to the documentation of this file.

/*
 * ipxsock.h
 *
 * IPX protocol 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): ______________________________________.
 *
 * $Log: ipxsock.h,v $
 * Revision 1.12  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.11  2003/09/17 05:41:58  csoutheren
 * Removed recursive includes
 *
 * Revision 1.10  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.9  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.8  2001/05/22 12:49:32  robertj
 * Did some seriously wierd rewrite of platform headers to eliminate the
 *   stupid GNU compiler warning about braces not matching.
 *
 * Revision 1.7  1999/03/09 02:59:50  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.6  1999/02/16 08:12:00  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.5  1998/11/30 02:50:58  robertj
 * New directory structure
 *
 * Revision 1.4  1998/09/23 06:20:47  robertj
 * Added open source copyright license.
 *
 * Revision 1.3  1996/10/08 13:21:04  robertj
 * More IPX implementation.
 *
 * Revision 1.1  1996/09/14 13:00:56  robertj
 * Initial revision
 *
 */

#ifndef _PIPXSOCKET
#define _PIPXSOCKET

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/socket.h>


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

  public:
    PIPXSocket(
      WORD port = 0       
    );


  public:
    class Address {
      public:
        union {
          struct {
            BYTE b1,b2,b3,b4;
          } b;
          struct {
            WORD w1,s_w2;
          } w;
          DWORD dw;
        } network;
        BYTE node[6];

        Address();
        Address(const Address & addr );
        Address(const PString & str );
        Address(
          DWORD netNum, 
          const char * nodeNum  
        );
        Address & operator=(const Address & addr );
        operator PString() const;
        BOOL IsValid() const;
      friend ostream & operator<<(
        ostream & strm, 
        Address & addr  
      ) { return strm << (PString)addr; }
    };

    virtual PString GetName() const;


    virtual BOOL Connect(
      const PString & address   
    );
    virtual BOOL Connect(
      const Address & address   
    );

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

    static PString GetHostName(
      const Address & addr    
    );

    static BOOL GetHostAddress(
      Address & addr    
    );

    static BOOL GetHostAddress(
      const PString & hostname,
      Address & addr    
    );

    BOOL GetLocalAddress(
      Address & addr    
    );

    BOOL GetLocalAddress(
      Address & addr,    
      WORD & port        
    );

    BOOL GetPeerAddress(
      Address & addr    
    );

    BOOL GetPeerAddress(
      Address & addr,    
      WORD & port        
    );

    BOOL SetPacketType(
      int type    
    );

    int GetPacketType();


    virtual BOOL ReadFrom(
      void * buf,     
      PINDEX len,     
      Address & addr, 
      WORD & port     
    );

    virtual BOOL WriteTo(
      const void * buf,   
      PINDEX len,         
      const Address & addr, 
      WORD port           
    );


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


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

#endif

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

---