PRemoteConnection Class Reference
#include <remconn.h>
List of all members.
Classes |
struct | Configuration |
| Structure for a RAS configuration. More...
|
Public Member Functions |
|
|
| PRemoteConnection () |
| Create a new remote connection.
|
| PRemoteConnection (const PString &name) |
| ~PRemoteConnection () |
| Disconnect remote connection.
|
|
|
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 () |
Protected Attributes |
PString | remoteName |
PString | userName |
PString | password |
DWORD | osError |
PString | pppDeviceName |
PPipeChannel * | pipeChannel |
BOOL | 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 |
DWORD | GetErrorCode () const |
Information functions |
|
const PString & | GetName () const |
PString | GetAddress () |
static PStringArray | GetAvailableNames () |
Configuration functions |
|
Status | GetConfiguration (Configuration &config) |
Status | SetConfiguration (const Configuration &config, BOOL create=FALSE) |
static Status | GetConfiguration (const PString &name, Configuration &config) |
static Status | SetConfiguration (const PString &name, const Configuration &config, BOOL create=FALSE) |
static Status | RemoveConfiguration (const PString &name) |
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
PRemoteConnection::PRemoteConnection |
( |
|
) |
|
Create a new remote connection.
PRemoteConnection::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::~PRemoteConnection |
( |
|
) |
|
Disconnect remote connection.
Member Function Documentation
void PRemoteConnection::Close |
( |
|
) |
|
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:
-
| obj | Another connection instance. |
PString PRemoteConnection::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 PRemoteConnection::GetAvailableNames |
( |
|
) |
[static] |
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:
-
| name | Remote connection name to get configuration |
| config | Configuration of remote connection |
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:
-
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.
Status PRemoteConnection::GetStatus |
( |
|
) |
const |
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.
BOOL PRemoteConnection::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. |
BOOL PRemoteConnection::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 PRemoteConnection::Open |
( |
BOOL |
existing = FALSE |
) |
|
Open the remote connection.
- Parameters:
-
| existing | Flag 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:
-
| name | Remote connection name to configure |
static Status PRemoteConnection::SetConfiguration |
( |
const PString & |
name, |
|
|
const Configuration & |
config, |
|
|
BOOL |
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:
-
| name | Remote connection name to configure |
| config | Configuration of remote connection |
| create | Flag to create connection if not present |
Status PRemoteConnection::SetConfiguration |
( |
const Configuration & |
config, |
|
|
BOOL |
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:
-
| config | Configuration of remote connection |
| create | Flag to create connection if not present |
Member Data Documentation
The documentation for this class was generated from the following file: