Carapace

Remote Access Service (RAS) Object

The Ras object provides dialup TCP/IP communications. It sits at the bottom of a communications stack.

Ras Creation

The create function can be used to create a Ras module eg.

    (loadLibrary "cararas")
    (create Ras)
Note that this object is defined in the cararas.dll dynamic library, so this library needs to be loaded before the type is available.

Once created, this module is tailored using its properties and methods.

Ras Properties

A Ras object supports the following properties:

property name property type description
entryName String containing the phone-book entry to use to establish the connection
phoneNo String a telephone number which, if present, overrides any value read from the entry in the phone book
domain String the domain on which authentication is to occur
userName String user name -- used for authorisation
password String password -- used for authorisation
callbackNo String a callback number to be used by the RAS server
statusReporter Object this object is required to have a method called status which takes a single string argument -- the Ras module will then invoke this method whenever the RAS state changes

Ras Methods

The Ras module supports the following methods:

method name description
dial dial the remote service
hangup hang up from the remote service
connections list the current dialup networking connections
state return the current state of the connection


dial

Dial the remote service.

Arguments: none

Return type: the empty List ()


hangup

Hang up from the remote service.

Arguments: none

Return type: the empty List ()


connections

List the current dialup networking connections. Each element in the returned List is itself a list of four String values:

IP address assigned on this interface
entry name
device type e.g. MODEM
device name e.g. Gold Card Global 56K V.90

Arguments: none

Return type: List


state

Return the current state of the connection. The state is one of the following values:

OpenPort
PortOpened
ConnectDevice
DeviceConnected
AllDevicesConnected
Authenticate
AuthNotify
AuthRetry
AuthCallback
AuthChangePassword
AuthProject
AuthLinkSpeed
AuthAck
ReAuthenticate
Authenticated
PrepareForCallback
WaitForModemReset
WaitForCallback
Projected
StartAuthentication
CallbackComplete
LogonNetwork
SubEntryConnected
SubEntryDisconnected
Interactive
RetryAuthentication
CallbackSetByCaller
PasswordExpired
Connected
Disconnected

Arguments: none

Return type: String


Contents Index Current topic: communications Related topics: communications classes, objects