PTLib  Version 2.10.4
PRemoteConnection Class Reference

Remote Access Connection class. More...

#include <remconn.h>

Inheritance diagram for PRemoteConnection:
PObject

List of all members.

Classes

struct  Configuration
 Structure for a RAS configuration. More...

Public Member Functions

Construction
 PRemoteConnection ()
 Create a new remote connection.
 PRemoteConnection (const PString &name)
 Create a new remote connection.
 ~PRemoteConnection ()
 Disconnect remote connection.
Overrides from class PObject
virtual Comparison Compare (const PObject &obj) const
 Compare two connections.
virtual PINDEX HashFunction () const
 Get has value for the connection.
Dial/Hangup functions
PBoolean Open (PBoolean existing=false)
 Open the remote connection.
PBoolean Open (const PString &name, PBoolean existing=false)
 Open the remote connection.
PBoolean Open (const PString &name, const PString &username, const PString &password, PBoolean existing=false)
 Open the remote connection.
void Close ()
 Close the remote connection.

Protected Attributes

PString remoteName
PString userName
PString password
DWORD osError
PString pppDeviceName
PPipeChannelpipeChannel
PBoolean wasConnected
Status status
PString deviceStr

Error/Status functions

enum  Status {
  Idle, Connected, InProgress, LineBusy,
  NoDialTone, NoAnswer, PortInUse, NoNameOrNumber,
  AccessDenied, HardwareFailure, GeneralFailure, ConnectionLost,
  NotInstalled, NumStatuses
}
 Status codes for remote connection. More...
Status GetStatus () const
 Get the current status of the RAS connection.
DWORD GetErrorCode () const
 Get the error code for the last operation.

Information functions

const PStringGetName () const
 Get the name of the RAS connection.
PString GetAddress ()
 Get the IP address in dotted decimal form for the RAS connection.
static PStringArray GetAvailableNames ()
 Get an array of names for all of the available remote connections on this system.

Configuration functions

Status GetConfiguration (Configuration &config)
 Get the configuration of the specified remote access connection.
Status SetConfiguration (const Configuration &config, PBoolean create=false)
 Set the configuration of the specified remote access connection.
static Status GetConfiguration (const PString &name, Configuration &config)
 Get the configuration of the specified remote access connection.
static Status SetConfiguration (const PString &name, const Configuration &config, PBoolean create=false)
 Set the configuration of the specified remote access connection.
static Status RemoveConfiguration (const PString &name)
 Remove the specified remote access connection.

Detailed Description

Remote Access Connection class.


Member Enumeration Documentation

Status codes for remote connection.

Enumerator:
Idle 

Connection has not been made and no attempt is being made.

Connected 

Connection is completed and active.

InProgress 

Connection is in progress.

LineBusy 

Connection failed due to the line being busy.

NoDialTone 

Connection failed due to the line havin no dial tone.

NoAnswer 

Connection failed due to the remote not answering.

PortInUse 

Connection failed due to the port being in use.

NoNameOrNumber 

Connection failed due to the RAS setting name/number being incorrect.

AccessDenied 

Connection failed due to insufficient privilege.

HardwareFailure 

Connection failed due to a hardware failure.

GeneralFailure 

Connection failed due to a general failure.

ConnectionLost 

Connection was lost after successful establishment.

NotInstalled 

The Remote Access Operating System support is not installed.

NumStatuses 

Constructor & Destructor Documentation

Create a new remote connection.

Create a new remote connection.

This will initiate the connection using the specified settings.

Parameters:
nameName of RAS configuration.

Disconnect remote connection.


Member Function Documentation

Close the remote connection.

This will hang up/dosconnect the connection, net access will no longer be available to this site.

virtual Comparison PRemoteConnection::Compare ( const PObject obj) const [virtual]

Compare two connections.

Returns:
EqualTo of same RAS connectionconfiguration.
Parameters:
objAnother connection instance.

Reimplemented from PObject.

Get the IP address in dotted decimal form for the RAS connection.

Returns:
String for IP address, or empty string if none.

Get an array of names for all of the available remote connections on this system.

Returns:
Array of strings for remote connection names.

Get the configuration of the specified remote access connection.

Returns:
Connected if the configuration information was obtained, NoNameOrNumber if the particular RAS name does not exist, NotInstalled if there is no RAS support in the operating system, GeneralFailure on any other error.
Parameters:
configConfiguration of remote connection
static Status PRemoteConnection::GetConfiguration ( const PString name,
Configuration config 
) [static]

Get the configuration of the specified remote access connection.

Returns:
Connected if the configuration information was obtained, NoNameOrNumber if the particular RAS name does not exist, NotInstalled if there is no RAS support in the operating system, GeneralFailure on any other error.
Parameters:
nameRemote connection name to get configuration
configConfiguration of remote connection
DWORD PRemoteConnection::GetErrorCode ( ) const [inline]

Get the error code for the last operation.

Returns:
Operating system error code.

References osError.

const PString& PRemoteConnection::GetName ( ) const [inline]

Get the name of the RAS connection.

Returns:
String for IP address, or empty string if none.

References remoteName.

Get the current status of the RAS connection.

Returns:
Status code.
virtual PINDEX PRemoteConnection::HashFunction ( ) const [virtual]

Get has value for the connection.

Returns:
Hash value of the connection name string.

Reimplemented from PObject.

PBoolean PRemoteConnection::Open ( PBoolean  existing = false)

Open the remote connection.

Parameters:
existingFlag for open only if already connected.
PBoolean PRemoteConnection::Open ( const PString name,
PBoolean  existing = false 
)

Open the remote connection.

Parameters:
nameRAS name of of connection to open.
existingFlag for open only if already connected.
PBoolean PRemoteConnection::Open ( const PString name,
const PString username,
const PString password,
PBoolean  existing = false 
)

Open the remote connection.

Parameters:
nameRAS name of of connection to open.
usernameUsername for remote log in.
passwordpassword for remote log in.
existingFlag for open only if already connected.
static Status PRemoteConnection::RemoveConfiguration ( const PString name) [static]

Remove the specified remote access connection.

Returns:
Connected if the configuration information was removed, NoNameOrNumber if the particular RAS name does not exist, NotInstalled if there is no RAS support in the operating system, GeneralFailure on any other error.
Parameters:
nameRemote connection name to configure
Status PRemoteConnection::SetConfiguration ( const Configuration config,
PBoolean  create = false 
)

Set the configuration of the specified remote access connection.

Returns:
Connected if the configuration information was set, NoNameOrNumber if the particular RAS name does not exist, NotInstalled if there is no RAS support in the operating system, GeneralFailure on any other error.
Parameters:
configConfiguration of remote connection
createFlag to create connection if not present
static Status PRemoteConnection::SetConfiguration ( const PString name,
const Configuration config,
PBoolean  create = false 
) [static]

Set the configuration of the specified remote access connection.

Returns:
Connected if the configuration information was set, NoNameOrNumber if the particular RAS name does not exist, NotInstalled if there is no RAS support in the operating system, GeneralFailure on any other error.
Parameters:
nameRemote connection name to configure
configConfiguration of remote connection
createFlag to create connection if not present

Member Data Documentation

DWORD PRemoteConnection::osError [protected]

Referenced by GetErrorCode().

Referenced by GetName().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines