remconn.h

Go to the documentation of this file.

/*
 * remconn.h
 *
 * Remote networking connection 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: remconn.h,v $
 * Revision 1.18  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.17  2003/09/17 05:41:59  csoutheren
 * Removed recursive includes
 *
 * Revision 1.16  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.15  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.14  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.13  1999/03/09 02:59:50  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.12  1999/02/16 08:11:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.11  1998/09/23 06:21:17  robertj
 * Added open source copyright license.
 *
 * Revision 1.10  1998/07/24 06:58:27  robertj
 * Added ability to get IP number of RAS connection.
 *
 * Revision 1.9  1998/02/03 06:28:46  robertj
 * Added more error codes.
 *
 * Revision 1.8  1998/01/26 00:34:51  robertj
 * Added parameter to PRemoteConnection to open only if already connected.
 * Added function to PRemoteConnection to get at OS error code.
 *
 * Revision 1.7  1997/04/01 06:00:05  robertj
 * Added Remove Configuration.
 *
 * Revision 1.6  1997/01/12 04:15:11  robertj
 * Added ability to add/change new connections.
 *
 * Revision 1.5  1996/11/04 03:40:43  robertj
 * Added more debugging for remote drop outs.
 *
 * Revision 1.4  1996/08/11 07:03:45  robertj
 * Changed remote connection to late bind DLL.
 *
 * Revision 1.3  1996/04/23 11:33:04  robertj
 * Added username and password.
 *
 * Revision 1.2  1996/03/02 03:09:48  robertj
 * Added function to get all possible remote access connection names.
 *
 * Revision 1.1  1995/12/10 13:04:46  robertj
 * Initial revision
 *
 */

#ifndef _PREMOTECONNECTION
#define _PREMOTECONNECTION

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/pipechan.h>

#ifdef _WIN32
#include <ras.h>
#include <raserror.h>
#endif

class PRemoteConnection : public PObject
{
  PCLASSINFO(PRemoteConnection, PObject);

  public:

    PRemoteConnection();

    PRemoteConnection(
      const PString & name  
    );

    ~PRemoteConnection();

    virtual Comparison Compare(
      const PObject & obj     
    ) const;

    virtual PINDEX HashFunction() const;

    BOOL Open(
      BOOL existing = FALSE  
    );

    BOOL Open(
      const PString & name,   
      BOOL existing = FALSE   
    );

    BOOL Open(
      const PString & name,     
      const PString & username, 
      const PString & password, 
      BOOL existing = FALSE     
    );

    void Close();


    enum Status {
      Idle,
      Connected,
      InProgress,
      LineBusy,
      NoDialTone,
      NoAnswer,
      PortInUse,
      NoNameOrNumber,
      AccessDenied,
      HardwareFailure,
      GeneralFailure,
      ConnectionLost,
      NotInstalled,
      NumStatuses
    };

    Status GetStatus() const;

    DWORD GetErrorCode() const { return osError; }

    const PString & GetName() const { return remoteName; }

    PString GetAddress();

    static PStringArray GetAvailableNames();


    struct Configuration {
      PString device;
      PString phoneNumber;
      PString ipAddress;
      PString dnsAddress;
      PString script;
      PINDEX  subEntries;
      BOOL    dialAllSubEntries;
    };

    Status GetConfiguration(
      Configuration & config  
    );

    static Status GetConfiguration(
      const PString & name,   
      Configuration & config  
    );

    Status SetConfiguration(
      const Configuration & config,  
      BOOL create = FALSE            
    );

    static Status SetConfiguration(
      const PString & name,          
      const Configuration & config,  
      BOOL create = FALSE            
    );

    static Status RemoveConfiguration(
      const PString & name          
    );
    
  protected:
    PString remoteName;
    PString userName;
    PString password;
    DWORD osError;

  private:
    PRemoteConnection(const PRemoteConnection &) { }
    void operator=(const PRemoteConnection &) { }
    void Construct();


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

#endif

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

---