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): ______________________________________.
 *
 * $Revision: 28207 $
 * $Author: rjongbloed $
 * $Date: 2012-08-17 10:09:54 +1000 (Fri, 17 Aug 2012) $
 */

#ifndef PTLIB_REMOTECONNECTION_H
#define PTLIB_REMOTECONNECTION_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#if P_REMCONN

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

    PBoolean Open(
      PBoolean existing = false  
    );

    PBoolean Open(
      const PString & name,   
      PBoolean existing = false   
    );

    PBoolean Open(
      const PString & name,     
      const PString & username, 
      const PString & password, 
      PBoolean 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;
      PBoolean    dialAllSubEntries;
    };

    Status GetConfiguration(
      Configuration & config  
    );

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

    Status SetConfiguration(
      const Configuration & config,  
      PBoolean create = false            
    );

    static Status SetConfiguration(
      const PString & name,          
      const Configuration & config,  
      PBoolean 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 // P_REMCONN

#endif // PTLIB_REMOTECONNECTION_H


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