EPOC   SDK Home Glossary Indexes Previous Next Up

MBasicGsmPhoneNetwork class


Contents


MBasicGsmPhoneNetwork class — Protocol for accessing network functionality

Section Contents


Overview

Derivation

MBasicGsmPhoneNetwork

Mixin: interface for accessing network capabilities

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class defines the protocol for accessing GSM network functionality.


Construction and destruction


MBasicGsmPhoneNetwork() — Protected default C++ constructor

protected: MBasicGsmPhoneNetwork()

Description

The default C++ constructor is protected, which prevents objects of this class from being constructed. This class is intended only as an abstract base for other classes.


Network capability functions


GetNetworkInfoCaps() — Get network capabilities

virtual TInt GetNetworkInfoCaps(TNetworkCapsFlags& aCaps) const=0;

Description

This function retrieves the static network capabilities.

Arguments

TNetworkCapsFlags& aCaps

On return, contains the static network capabilities

Return value

TInt

An error code: see System error codes.

Note

Network registration functions


GetNetworkRegistrationStatus() — Get network registration status

virtual TInt GetNetworkRegistrationStatus(TRegistrationStatus& aRegistrationStatus) const=0;

Description

This function retrieves information about the current network registration status.

Arguments

TRegistrationStatus& aRegistrationStatus

On return, contains the network registration status.

Return value

TInt

An error code: see System error codes.

Note

NotifyChangeOfNetworkRegistrationStatus() — Notification of a change of network registration status

virtual void NotifyChangeOfNetworkRegistrationStatus(TRequestStatus& aStatus,TRegistrationStatus& aRegistrationStatus)=0;

Description

This function provides notification of changes to the current network registration status.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TRegistrationStatus& aRegistrationStatus

On request completion, contains the current registration status information.


NotifyChangeOfNetworkRegistrationStatusCancel() — Cancel notification of a change of network registration status

virtual void NotifyChangeOfNetworkRegistrationStatusCancel() const=0;

Description

This function cancels an outstanding request to be notified about changes to the current network registration status, placed with the NotifyChangeOfNetworkRegistrationStatus() function.


Network search mode functions


SetNetworkMode() — Set network search mode — synchronous

virtual TInt SetNetworkMode(const TNetworkSetMode aMode) const=0;

Description

This function synchronously sets the current network search mode.

Arguments

const TNetworkSetMode aMode

The new network search mode.

Return value

TInt

An error code: see System error codes.


SetNetworkMode() — Set network search mode — asynchronous

virtual void SetNetworkMode(TRequestStatus& aStatus,const TNetworkSetMode aMode)=0;

Description

This function asynchronously sets the current network search mode.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TNetworkSetMode aMode

The new network search mode.


SetNetworkModeCancel() — Cancel request to set the network search mode

virtual void SetNetworkModeCancel() const=0;

Description

This function cancels an outstanding request to set the network search mode, placed with the SetNetworkMode() function.


GetNetworkSearchMode() — Get network search mode

virtual TInt GetNetworkSearchMode(TNetworkSetMode& aMode) const=0;

Description

This function retrieves the current network search mode.

Arguments

TNetworkSetMode& aMode

On return, contains the network search mode.

Return value

TInt

An error code: see System error codes.

Note

NotifyChangeOfNetworkSearchMode() — Notification of a change of network search mode

virtual void NotifyChangeOfNetworkSearchMode(TRequestStatus& aStatus,TNetworkSetMode& aMode)=0;

Description

This function provides notification of changes to the network search mode.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TNetworkSetMode& aMode

On request completion, contains the current network search mode.


NotifyChangeOfNetworkSearchModeCancel() — Cancels notification of a change of network search mode

virtual void NotifyChangeOfNetworkSearchModeCancel() const=0;

Description

This function cancels an outstanding network search mode notification request, placed with the NotifyChangeOfNetworkSearchMode() function.


Detected network functions


EnumerateDetectedNetworks() — Enumerate detected networks — synchronous

virtual TInt EnumerateDetectedNetworks(TInt& aNetworkCnt) const=0;      

Description

This function retrieves the number of networks currently available to the phone.

Arguments

TInt& aNetworkCnt

On return, contains the number of networks available to the phone.

Return value

TInt

An error code: see System error codes.

Notes:

EnumerateDetectedNetworks() — Enumerate detected networks — asynchronous

virtual void EnumerateDetectedNetworks(TRequestStatus& aStatus, TInt& aNetworkCnt)=0;

Description

This function retrieves the number of networks currently available to the phone.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TInt& aNetworkCnt

On request completion, contains the number of networks available to the phone.

Notes:

EnumerateDetectedNetworksCancel() — Cancel enumerate detected networks request

virtual void EnumerateDetectedNetworksCancel() const=0;

Description

This function cancels an outstanding request to enumerate the detected networks, made using the asynchronous version of the EnumerateDetectedNetworks() function.


GetDetectedNetworkInfo() — Get information about a detected network — synchronous

virtual TInt GetDetectedNetworkInfo(const TInt aIndex,TNetworkInfo& aNetworkInfo) const=0;

Description

This function retrieves information about a currently detected network.

Arguments

const TInt aIndex

The index of the network for which information is required. The valid range for the index is between 0 and (n-1), where n is the number returned by the EnumerateDetectedNetworks() function.

TNetworkInfo& aNetworkInfo

On return, contains information about the selected network.

Return value

TInt

An error code: see System error codes.

Notes:

GetDetectedNetworkInfo() — Get information about a detected network — asynchronous

virtual void GetDetectedNetworkInfo(TRequestStatus& aStatus, const TInt aIndex,TNetworkInfo& aNetworkInfo)=0;

Description

This function retrieves information about a currently detected network.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TInt aIndex

The index of the network for which information is required. The valid range for the index is between 0 and (n-1), where n is the number returned by the EnumerateDetectedNetworks() function.

TNetworkInfo& aNetworkInfo

On request completion, contains information about the selected network.

Notes:

GetDetectedNetworkInfoCancel() — Cancel get information about a detected network request

virtual void GetDetectedNetworkInfoCancel() const=0;

Description

This function cancels an outstanding network information retrieval request, placed using the asynchronous variant of the GetNetworkInfo() function.


RetrieveDetectedNetworksLC() — Get information for all detected networks — synchronous

virtual CGsmDetectedNetworkResults* RetrieveDetectedNetworksLC()=0;

Description

This function synchronously returns information about all the detected networks. It may be used in place of the combination of EnumerateDetectedNetworks() and GetDetectedNetworkInfo() functions, and eliminates the small possibility of the Detected Network information changing before the GetDetectedNetworkInfo() function completes.

Return value

CGsmDetectedNetworkResults*

On return, contains the information about all the detected networks. This information is then available client-side.

Notes:

Current network functions


SetManualNetwork() — Set current network— synchronous

virtual TInt SetManualNetwork(const TBscNetworkId aNetworkId) const=0;

Description

This function sets a network as the current network.

Arguments

const TBscNetworkId aNetworkId

The ID of the network to be set as the current network.

Return value

TInt

An error code: see System error codes.

Notes:

SetManualNetwork() — Set current network — asynchronous

virtual void SetManualNetwork(TRequestStatus& aStatus,const TBscNetworkId aNetworkId)=0;

Description

This function sets a network as the current network.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TBscNetworkId aNetworkId

The ID of the network to be set as the current network.


SetManualNetworkCancel() — Cancel set current network request

virtual void SetManualNetworkCancel() const=0;

Description

This function cancels an outstanding request to set the current network, made using the asynchronous variant of the SetManualNetwork() function.


GetCurrentNetworkInfo() — Get current network information

virtual TInt GetCurrentNetworkInfo(TCurrentNetworkInfo& aNetworkInfo) const=0;

Description

This function retrieves information about the current network.

Arguments

TCurrentNetworkInfo& aNetworkInfo

On return, contains information about the current network.

Return value

TInt

An error code: see System error codes.

Notes:

NotifyChangeOfCurrentNetwork() — Notification of changes to the current network information

virtual void NotifyChangeOfCurrentNetwork(TRequestStatus& aStatus,TCurrentNetworkInfo& aNetworkInfo)=0;

Description

This function provides notification when the current network information changes.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCurrentNetworkInfo& aNetworkInfo

On request completion, contains the new network information.


NotifyChangeOfCurrentNetworkCancel() — Cancel notification of changes to current network information

virtual void NotifyChangeOfCurrentNetworkCancel() const=0;

Description

This function cancels an outstanding request to be notified about changes to the current network information, placed with the NotifyChangeOfCurrentNetwork() function.


Enumerations


TNetworkSetMode enum — Network search mode flags

ENetworkSetModeAutomatic

The ME attempts to register to the detected networks in the priority order specified by the preferred networks list.

ENetworkSetModeManual

The ME registers the network stored in the "Registered PLMN" field on the SIM.

Notes:

TNetworkInfoCaps enum — Network capability flags

KCapsNetworkInfoAvailable

Indicates that functionality to obtain network information from the TSY is available.

KCapsNetworkShortName

Indicates that the short network name is available when requesting available network information.

KCapsNetworkLongName

Indicates that the long network name is available when requesting available network information.

KCapsNetworkCurrentInfoAvailable

Indicates that current network information is available.


TRegistrationStatus enum — Network registration status

ENotRegisteredNotSearching

Not registered. The ME is not currently searching a new network to register with.

ERegisteredOnHomeNetwork

Registered on home network.

ENotRegisteredSearching

Not registered, but the ME is currently searching a new network to register with.

ERegistrationDenied

Registration denied.

EUnknown

Registration status is unknown.

ERegisteredRoaming

Registered, roaming.


TNetworkStatus enum — Network information status flags

ENetStatUnknown

Status is unknown.

ENetStatAvailable

A network that the ME is allowed to register with.

ENetStatCurrent

The currently registered network.

ENetStatForbidden

A network that the ME is not allowed to register with.


Anonymous enum — Network name size

KShortNetworkNameSize

Size of the short network name (8 characters).

KLongNetworkNameSize

Size of the long network name (16 characters).


Struct


TNetworkCapsFlags struct — Network capabilities

TUint iNetworkInfoCaps

Defines the network capabilities as a bitmask of the TNetworkInfoCaps constants.


TCurrentNetworkInfo struct — Current network information

TNetworkInfo iNetworkInfo

Information about the current network.

TUint iLocationAreaCode

Location area code.

TUint iCellId

Cell identity code.


MBasicGsmPhoneNetwork::TBscNetworkId class — Network ID information

Section Contents


Overview

Derivation

MBasicGsmPhoneNetwork::TBscNetworkId

Scoped class: Network ID information

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

Defines a structure for network ID information, including the country and network code for the mobile subscriber.


Construction and destruction

The class does not declare a constructor.


Data members

TUint iMCC

A three decimal digit mobile country code converted to Binary Coded Decimal representation.

TUint iMNC

A two decimal digit mobile network code converted to Binary Coded Decimal representation.


MBasicGsmPhoneNetwork::TNetworkInfo class — Detected network information

Section Contents


Overview

Derivation

MBasicGsmPhoneNetwork::TNetworkInfo

Scoped class: Detected network information

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

Defines a structure for containing the information about detected networks.


Construction and destruction


TNetworkInfo() — Default C++ constructor

TNetworkInfo();

Description

The class declares a default empty constructor.


Data members

TBscNetworkId iId

Network identification number.

TNetworkStatus iStatus

Status of the network.

TBuf8<KShortNetworkNameSize> iShortName

Short network name.

TBuf8<KLongNetworkNameSize> iLongName

Long network name.

EPOC       SDK Home Glossary Indexes Previous Next Up