## wxDialUpManager

This class encapsulates functions dealing with veryfying 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 wxWindows classes in that there is at most one instance of this class in the program accessed via wxDialUpManager::Create() and you can't create the objects of this class directly.

Derived from

No base class

Include files

<wx/dialup.h>

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 wxDialUpEvent argument.

EVT_DIALUP_CONNECTED(func) | A connection with the network was established.
EVT_DIALUP_DISCONNECTED(func) | The connection with the network was lost.

See also

dialup sample
wxDialUpEvent

Members

wxDialUpManager::Create
wxDialUpManager::IsOk
wxDialUpManager::~wxDialUpManager
wxDialUpManager::GetISPNames
wxDialUpManager::Dial
wxDialUpManager::IsDialing
wxDialUpManager::CancelDialing
wxDialUpManager::HangUp
wxDialUpManager::IsAlwaysOnline
wxDialUpManager::IsOnline
wxDialUpManager::SetOnlineStatus
wxDialUpManager::EnableAutoCheckOnlineStatus
wxDialUpManager::DisableAutoCheckOnlineStatus
wxDialUpManager::SetWellKnownHost
wxDialUpManager::SetConnectCommand

### wxDialUpManager::Create

wxDialUpManager* Create()

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

### wxDialUpManager::IsOk

bool IsOk() const

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 wxDialUpManager methods

### wxDialUpManager::~wxDialUpManager

~wxDialUpManager()

Destructor.

### wxDialUpManager::GetISPNames

size_t GetISPNames(wxArrayString& names) const

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).

### wxDialUpManager::Dial

bool Dial(const wxString& nameOfISP = wxEmptyString, const wxString& username = wxEmptyString, const wxString& password = wxEmptyString, bool async = TRUE)

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

The parameters are only used under Windows currently, for Unix you should use SetConnectCommand 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).

### wxDialUpManager::IsDialing

bool IsDialing() const

Returns TRUE if (async) dialing is in progress.

See also

Dial

### wxDialUpManager::CancelDialing

bool CancelDialing()

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

IsDialing

### wxDialUpManager::HangUp

bool HangUp()

Hang up the currently active dial up connection.

### wxDialUpManager::IsAlwaysOnline

bool IsAlwaysOnline() const

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.

### wxDialUpManager::IsOnline

bool IsOnline() const

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 SetWellKnownHost) is reachable.

### wxDialUpManager::SetOnlineStatus

void SetOnlineStatus(bool 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

IsOnline

### wxDialUpManager::EnableAutoCheckOnlineStatus

bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60)

Enable automatical checks for the connection status and sending of `wxEVT_DIALUP_CONNECTED/wxEVT_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.

### wxDialUpManager::DisableAutoCheckOnlineStatus

void DisableAutoCheckOnlineStatus()

Disable automatic check for connection status change - notice that the `wxEVT_DIALUP_XXX` events won't be sent any more neither.

### wxDialUpManager::SetWellKnownHost

void SetWellKnownHost(const wxString& hostname, int 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`.

### wxDialUpManager::SetConnectCommand

SetConnectCommand(const wxString& commandDial = wxT("/usr/bin/pon"), const wxString& commandHangup = wxT("/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