Remote Access Connection class
Inheritance:
Public Methods
| Construction
|
| Overrides from class PObject
|
| Dial/Hangup functions
|
| Information functions
|
Public Members
| Error/Status functions
|
| Configuration functions
|
Inherited from PObject:
Public Methods
-
Run Time Type functions
-
I/O functions
-
Miscellaneous functions
Public Members
-
Comparison functions
Documentation
Remote Access Connection class
Construction
PRemoteConnection()
- Create a new remote connection
PRemoteConnection( const PString & name )
- Create a new remote connection.
This will initiate the connection using the specified settings.
- Parameters:
- name - Name of RAS configuration.
~PRemoteConnection()
- Disconnect remote connection
Overrides from class PObject
virtual Comparison Compare( const PObject & obj ) const
- Compare two connections.
- Parameters:
- obj - Another connection instance.
- Returns:
- EqualTo of same RAS connectionconfiguration.
virtual PINDEX HashFunction() const
- Get has value for the connection
- Returns:
- Hash value of the connection name string.
Dial/Hangup functions
BOOL Open( BOOL existing = FALSE )
- Open the remote connection.
- Parameters:
- existing - Flag for open only if already connected.
BOOL Open( const PString & name, BOOL existing = FALSE )
- Open the remote connection.
- Parameters:
- name - RAS name of of connection to open.
existing - Flag for open only if already connected.
BOOL Open( const PString & name, const PString & username, const PString & password, BOOL existing = FALSE )
- Open the remote connection.
- Parameters:
- name - RAS name of of connection to open.
username - Username for remote log in.
password - password for remote log in.
existing - Flag for open only if already connected.
void Close()
- Close the remote connection.
This will hang up/dosconnect the connection, net access will no longer
be available to this site.
Error/Status functions
enum Status
- Status codes for remote connection
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
Status GetStatus() const
- Get the current status of the RAS connection.
- Returns:
- Status code.
DWORD GetErrorCode() const
- Get the error code for the last operation.
- Returns:
- Operating system error code.
Information functions
const PString& GetName() const
- Get the name of the RAS connection.
- Returns:
- String for IP address, or empty string if none.
PString GetAddress()
- Get the IP address in dotted decimal form for the RAS connection.
- Returns:
- String for IP address, or empty string if none.
static PStringArray GetAvailableNames()
- Get an array of names for all of the available remote connections on
this system.
- Returns:
- Array of strings for remote connection names.
Configuration functions
struct Configuration
- Structure for a RAS configuration
PString device
- Device name for connection eg /dev/modem
PString phoneNumber
- Telephone number to call to make the connection
PString ipAddress
- IP address of local machine after connection is made
PString dnsAddress
- DNS host on remote site
PString script
- Script name for doing remote log in
PINDEX subEntries
- Sub-entry number when Multi-link PPP is used
BOOL dialAllSubEntries
- Always establish maximum bandwidth when Multi-link PPP is used
Status GetConfiguration( Configuration & config )
- Get the configuration of the specified remote access connection.
- Parameters:
- config - Configuration of remote 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.
static Status GetConfiguration( const PString & name, Configuration & config )
- Get the configuration of the specified remote access connection.
- Parameters:
- name - Remote connection name to get configuration
- 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.
Status SetConfiguration( const Configuration & config, BOOL create = FALSE )
- Set the configuration of the specified remote access connection.
- Parameters:
- config - Configuration of remote connection
create - Flag to create connection if not present
- 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.
static Status SetConfiguration( const PString & name, const Configuration & config, BOOL create = FALSE )
- Set the configuration of the specified remote access connection.
- Parameters:
- name - Remote connection name to configure
config - Configuration of remote connection
create - Flag to create connection if not present
- 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.
static Status RemoveConfiguration( const PString & name )
- Remove the specified remote access connection.
- Parameters:
- name - Remote connection name to configure
- 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.
- This class has no child classes.
Alphabetic index HTML hierarchy of classes or Java
This page was generated with the help of DOC++.