wxRuby Documentation Home

# Wx::DialUpManager

This class encapsulates functions dealing with verifying the connection status
of the workstation (connected to the Internet via a direct connection,
connected through a modem or not connected at all) and to establish this
connection if possible/required (i.e. in the case of the modem).

The program may also wish to be notified about the change in the connection
status (for example, to perform some action when the user connects to the
network the next time or, on the contrary, to stop receiving data from the net
when the user hangs up the modem). For this, you need to use one of the event
macros described below.

This class is different from other Widgets classes in that there is at most
one instance of this class in the program accessed via
DialUpManager::Create and you can’t
create the objects of this class directly.

## Derived from

No base class

## Event table macros

To be notified about the change in the network connection status, use these
event handler macros to direct input to member functions that take a
DialUpEvent argument.

evt_dialup_connected() { | event | … } | A connection with the network was established.
evt_dialup_disconnected() { | event | … } | The connection with the network was lost.

## See also

dialup sample

DialUpEvent

## Methods

- DialUpManager#create
- DialUpManager#is_ok
- DialUpManager#get_isp_names
- DialUpManager#dial
- DialUpManager#is_dialing
- DialUpManager#cancel_dialing
- DialUpManager#hang_up
- DialUpManager#is_always_online
- DialUpManager#is_online
- DialUpManager#set_online_status
- DialUpManager#enable_auto_check_online_status
- DialUpManager#disable_auto_check_online_status
- DialUpManager#set_well_known_host
- DialUpManager#set_connect_command

### DialUpManager#create

DialUpManager create()

This function should create and return the object of the platform-specific
class derived from DialUpManager. You should delete the pointer when you are
done with it.

### DialUpManager#is_ok

Boolean is_ok()

Returns `true` if the dialup manager was initialized correctly. If this
function returns `false`, no other functions will work neither, so it is a
good idea to call this function and check its result before calling any other
DialUpManager methods

destructor()

Destructor.

### DialUpManager#get_isp_names

Integer get_isp_names(%(arg-type)ArrayString% names)

This function is only implemented under Windows.

Fills the array with the names of all possible values for the first
parameter to Dial on this machine and returns
their number (may be $0$).

### DialUpManager#dial

Boolean dial(%(arg-type)String% nameOfISP = ‘’, String username = ’’, String password = ’’, Boolean async = true)

Dial the given ISP, use username and password to authenticate.

The parameters are only used under Windows currently, for Unix you should use
set_connect_command to customize this
functions behaviour.

If no nameOfISP is given, the function will select the default one
(proposing the user to choose among all connections defined on this machine)
and if no username and/or password are given, the function will try to do
without them, but will ask the user if really needed.

If async parameter is `false`, the function waits until the end of dialing
and returns `true` upon successful completion.

If async is `true`, the function only initiates the connection and
returns immediately – the result is reported via events (an event is sent
anyhow, but if dialing failed it will be a DISCONNECTED one).

### DialUpManager#is_dialing

Boolean is_dialing()

Returns true if (async) dialing is in progress.

#### See also

Dial

### DialUpManager#cancel_dialing

Boolean cancel_dialing()

Cancel dialing the number initiated with Dial
with async parameter equal to `true`.

Note that this won’t result in DISCONNECTED event being sent.

#### See also

is_dialing

### DialUpManager#hang_up

Boolean hang_up()

Hang up the currently active dial up connection.

### DialUpManager#is_always_online

Boolean is_always_online()

Returns `true` if the computer has a permanent network connection (i.e. is
on a LAN) and so there is no need to use Dial() function to go online.

NB: this functions tries to guess the result and it is not always
guaranteed to be correct, so it is better to ask user for
confirmation or give him a possibility to override it.

### DialUpManager#is_online

Boolean is_online()

Returns `true` if the computer is connected to the network: under Windows,
this just means that a RAS connection exists, under Unix we check that
the “well-known host” (as specified by
set_well_known_host) is reachable.

### DialUpManager#set_online_status

set_online_status(%(arg-type)Boolean% isOnline = true)

Sometimes the built-in logic for determining the online status may fail,
so, in general, the user should be allowed to override it. This function
allows to forcefully set the online status – whatever our internal
algorithm may think about it.

#### See also

is_online

### DialUpManager#enable_auto_check_online_status

Boolean enable_auto_check_online_status(%(arg-type)Integer% nSeconds = 60)

Enable automatic checks for the connection status and sending of
`EVT_DIALUP_CONNECTED/EVT_DIALUP_DISCONNECTED` events. The interval
parameter is only for Unix where we do the check manually and specifies how
often should we repeat the check (each minute by default). Under Windows, the
notification about the change of connection status is sent by the system and so
we don’t do any polling and this parameter is ignored.

Returns `false` if couldn’t set up automatic check for online status.

### DialUpManager#disable_auto_check_online_status

disable_auto_check_online_status()

Disable automatic check for connection status change – notice that the
`EVT_DIALUP_XXX` events won’t be sent any more neither.

### DialUpManager#set_well_known_host

set_well_known_host(%(arg-type)String% hostname, Integer portno = 80)

This method is for Unix only.

Under Unix, the value of well-known host is used to check whether we’re
connected to the internet. It is unused under Windows, but this function
is always safe to call. The default value is `www.yahoo.com:80`.

### DialUpManager#set_connect_command

set_connect_command(%(arg-type)String% commandDial = T(“/usr/bin/pon”), String commandHangup = T(“/usr/bin/poff”))

This method is for Unix only.

Sets the commands to start up the network and to hang up again.

#### See also

Dial

[This page automatically generated from the Textile source at 2023-06-09 00:45:37 +0000]