EPOC   SDK Home Glossary Indexes Previous Next Up

RBasicGsmCall class


Contents


RBasicGsmCall class — GSM call sub-session

Section Contents


Overview

Derivation

RCall

Base class. Defines ETel core call sub-session functionality

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

RBasicGsmCall provides access to basic call GSM functionality.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


RBasicGsmCall() — Trivial default C++ constructor

RBasicGsmCall();

Description

The default C++ constructor constructs an RBasicGsmCall object, specifying the default initialisation for the base class RCall.


Call capability functions


GetBasicGsmCaps() — Get call capabilities

virtual TInt GetBasicGsmCaps(TCaps& aCaps) const;

Description

This function retrieves the call’s capabilities.

Arguments

TCaps& aCaps

On return, contains the call’s capabilities.

Return value

TInt

An error code: see System error codes.


NotifyBasicGsmCaps() — Notification of any change to the call capabilities

virtual void NotifyBasicGsmCaps(TRequestStatus& aStatus, TCaps& aCaps);

Description

This function provides notification when any of the call’s capabilities change.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCaps& aCaps

On request completion, contains the call’s current capabilities.


NotifyBasicGsmCapsCancel() — Cancel notification of changes to the call capabilities

virtual void NotifyBasicGsmCapsCancel() const;

Description

This function cancels an outstanding “any change to call capabilities” notification request, placed using the NotifyBasicGsmCaps() function.


Call information functions


GetInfoBasicGsm() — Get current call information

virtual TInt GetInfoBasicGsm(TCallNotifyInfo& aCallNotifyInfo) const;

Description

This function retrieves a snapshot of the current call information.

Arguments

TCallNotifyInfo& aCallNotifyInfo

On return, contains the current call information.

Return value

TInt

An error code: see System error codes.


NotifyOnAnythingBasicGsm() — Notification of any change to the call information

virtual void NotifyOnAnythingBasicGsm(TRequestStatus& aStatus,TCallNotifyInfo& aCallNotifyInfo);

Description

This function provides notification of changes to any members of the call information structure.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCallNotifyInfo& aCallNotifyInfo

On request completion, contains the updated call information.


NotifyOnAnythingBasicGsmCancel() — Cancel notification of any change to the call information

virtual void NotifyOnAnythingBasicGsmCancel() const;

Description

This function cancels an "Any change" notification request, placed using the NotifyOnAnythingBasicGsm() function.


Enumerations


TBearerSpeed enum — Bearer speed flags

This enumeration specifies transfer rates and protocols.

EBearerSpeedAutobauding

Automatic detection of baud rate.

EBearerSpeedV21_300

V.21 protocol. Transfer rate 300 bps.

EBearerSpeedV22_1200

V.22 protocol. Transfer rate 1200 bps.

EBearerSpeedV23_1200_75

V.23 protocol. Transfer rate 1200 bps forward, 75 back.

EBearerSpeedV22bis_2400

V.22bis protocol. Transfer rate 2400 bps.

EBearerSpeedV26ter_2400

V.21ter protocol. Transfer rate 1400 bps.

EBearerSpeedV32_4800

V.32 protocol. Transfer rate 4800 bps.

EBearerSpeedV32_9600

V.32 protocol. Transfer rate 9600 bps.

EBearerSpeedUnknown_NetworkSpecific

Network specification unknown

EBearerSpeedV32bis_7200

V.32bis protocol. Transfer rate 7200 bps.

EBearerSpeedV32bis_12000

V.32bis protocol. Transfer rate 12000 bps.

EBearerSpeedV32bis_14400

V.32bis protocol. Transfer rate 14400 bps.

EBearerSpeedV34_9600

V.34 protocol. Transfer rate 9600 bps.

EBearerSpeedV34_12000

V.34 protocol. Transfer rate 12000 bps.

EBearerSpeedV34_14400

V.34 protocol. Transfer rate 14400 bps.

EBearerSpeedV34_192000

V.34 protocol. Transfer rate 192000 bps.

EBearerSpeedV34_288000

V.34 protocol. Transfer rate 288000 bps.

EBearerSpeedV110_300

V.110 protocol. Transfer rate 300 bps.

EBearerSpeedV110_1200

V.110 protocol. Transfer rate 1200 bps.

EBearerSpeedV110_2400

V.110 protocol. Transfer rate 2400 bps.

EBearerSpeedV110_4800

V.110 protocol. Transfer rate 4800 bps.

EBearerSpeedV110_9600

V.110 protocol. Transfer rate 9600 bps.

EBearerSpeedV110_12000

V.110 protocol. Transfer rate 12000 bps.

EBearerSpeedV110_14400

V.110 protocol. Transfer rate 14400 bps.

EBearerSpeedV110_19200

V.110 protocol. Transfer rate 19200 bps.

EBearerSpeedV110_38400

V.110 protocol. Transfer rate 38400 bps.


TBearerName enum — Bearer service name flags

This enumeration specifies the different types of bearer.

EBearerNameAsynchronousModem

Network supports asynchronous modem transfer

EBearerNameSynchronousModem

Network supports synchronous modem transfer

EBearerNamePADAccessAsynchronous

Network supports PAD asynchronous transfer

EBearerNamePacketAccessSynchronous

Network supports packet synchronous transfer


TBearerCE enum — Connection element flags

This enumeration specifies whether or not RLP is used.

EBearerCETransparent

RLP is not used.

EBearerCENonTransparent

RLP is used. Transmission is more reliable.


TBearerCaps enum — Bearer speed capability flags

This enumeration specifies which bearer transfer rates and protocols are supported by the network.

KCapsBearerSpeedAutobauding

Automatic detection of baud rate

KCapsBearerSpeedV21_300

V.21 protocol. Transfer rate 300 bps.

KCapsBearerSpeedV22_1200

V.22 protocol. Transfer rate 1200 bps.

KCapsBearerSpeedV23_1200_75

V.23 protocol. Transfer rate 1200 bps forward, 75 back.

KCapsBearerSpeedV22bis_2400

V.22bis protocol. Transfer rate 2400 bps.

KCapsBearerSpeedV26ter_2400

V.21ter protocol. Transfer rate 1400 bps.

KCapsBearerSpeedV32_4800

V.32 protocol. Transfer rate 4800 bps.

KCapsBearerSpeedV32_9600

V.32 protocol. Transfer rate 9600 bps.

KCapsBearerSpeedUnknown_NetworkSpecific

Network specification unknown

KCapsBearerSpeedV32bis_7200

V.32bis protocol. Transfer rate 7200 bps.

KCapsBearerSpeedV32bis_12000

V.32bis protocol. Transfer rate 12000 bps.

KCapsBearerSpeedV32bis_14400

V.32bis protocol. Transfer rate 14400 bps.

KCapsBearerSpeedV34_9600

V.34 protocol. Transfer rate 9600 bps.

KCapsBearerSpeedV34_12000

V.34 protocol. Transfer rate 12000 bps.

KCapsBearerSpeedV34_14400

V.34 protocol. Transfer rate 14400 bps.

KCapsBearerSpeedV34_192000

V.34 protocol. Transfer rate 192000 bps.

KCapsBearerSpeedV34_288000

V.34 protocol. Transfer rate 288000 bps.

KCapsBearerSpeedV110_300

V.110 protocol. Transfer rate 300 bps.

KCapsBearerSpeedV110_1200

V.110 protocol. Transfer rate 1200 bps.

KCapsBearerSpeedV110_2400

V.110 protocol. Transfer rate 2400 bps.

KCapsBearerSpeedV110_4800

V.110 protocol. Transfer rate 4800 bps.

KCapsBearerSpeedV110_9600

V.110 protocol. Transfer rate 9600 bps.

KCapsBearerSpeedV110_12000

V.110 protocol. Transfer rate 12000 bps.

KCapsBearerSpeedV110_14400

V.110 protocol. Transfer rate 14400 bps.

KCapsBearerSpeedV110_19200

V.110 protocol. Transfer rate 19200 bps.

KCapsBearerSpeedV110_38400

V.110 protocol. Transfer rate 38400 bps.

KCapsBearerSpeedUnknown

Bearer speed is unknown.


Anonymous enum — Bearer name capability flags

This enumeration is used to specify the bearer types supported by the network.

KCapsBearerNameAsynchronousModem

The network supports asynchronous modem transfer.

KCapsBearerNameSynchronousModem

The network supports synchronous modem transfer.

KCapsBearerNamePADAccessAsynchronous

The network supports PAD asynchronous transfer.

KCapsBearerNamePacketAccessSynchronous

The network supports Packet Access synchronous transfer.

KCapsBearerNameUnknown

The bearer capability is unknown.


Anonymous enum — Bearer connection element capability flags

This enumeration is used to specify network connection element capabilities.

KCapsBearerCETransparent

The network does not support RLP.

KCapsBearerCENonTransparent

The network supports RLP.

KCapsBearerCEUnknown

It is not known whether the network supports RLP.


Struct


TBearer struct — Current bearer information

TBearerSpeed iSpeed

The current bearer speed information.

TBearerName iName

The name of the bearer service.

TBearerCE iCe

The connection element.


TRlpParamRanges struct — RLP parameter range information

This structure packages the acceptable range of RLP parameters. The acceptable ranges are returned by the network after a request for call capabilities — GetBasicGsmCaps().

TUint iWsMin

The minimum IWF to MS window size supported.

TUint iWsMax

The maximum IWF to MS window size supported.

TUint iMwsMin

The minimum MS to IWF window size supported.

TUint iMwsMax

The maximum MS to IWF window size supported.

TUint iT1Min

The minimum acknowledgement timer value supported (measured in units of 10ms).

TUint iT1Max

The maximum acknowledgement timer value supported (measured in units of 10ms).

TUint iN2Min

The minimum number of re-transmission attempts supported.

TUint iN2Max

The maximum number of re-transmission attempts supported.

TUint iT4Min

The minimum re-sequencing period timer value supported (measured in units of 10ms).

TUint iT4Max

The maximum re-sequencing period timer value supported (measured in units of 10ms).


TCaps struct — Bearer capabilities information

TUint iBearerSpeed

Bearer speed capability information.

TUint iBearerName

Bearer name capability information.

TUint iBearerCe

Bearer connection element capability information.

TRlpParamRanges iRlpParams

RLP Parameter capability information.


TRlpParams struct — RLP parameter information

This structure packages the client’s preferred RLP parameters — which must be within the ranges returned in TRlpParamRanges — for submission to the network. The network may or may not use these values.

This structure is also used to return the actual RLP parameters from the network — see RCall::GetCallParams().

TUint iIws

IWF to MS window size.

TUint iMws

MS to IWF window size.

TUint iT1

Acknowledgement timer, T1 (measured in units of 10ms).

TUint iN2

Maximum number of re-transmission attempts.

TUint iT4

Re-sequencing period timer, T4 (measured in units of 10ms).


RBasicGsmCall::TCallNotifyInfo class — Basic GSM API call class information

Section Contents


Overview

Derivation

RCall::TCallNotifyInfo

Base class. Defines Core API call class information.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

All the information associated with an instance of the basic GSM API call class is collected together into a single, directly accessible, structure to increase the efficiency of those applications that require access to the majority of the call’s data.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TCallNotifyInfo() — Empty default C++ constructor

RBasicGsmCall::TCallNotifyInfo();

Description

The class has an empty constructor, which initialises the base class using its default constructor.


Data members

TBearer iBearer

Contains the current bearer information, described in RBasicGsmCall::TBearer.

TBool iBearerChanged

An indication that the bearer information has changed since the last notification.


RBasicGsmCall::TCallParams class — Basic GSM API call parameter information

Section Contents


Overview

Derivation

RCall::TCallParams

Base class. Defines the call class parameter information.

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class defines the basic GSM call parameter information. It is used to specify the preferred parameters when setting up a call.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TCallParams() — Default C++ constructor

RBasicGsmCall::TCallParams();

Description

The default C++ constructor allows an initialised call information object to be constructed. The base class’s default constructor is called, and the member variables are initialised as detailed below. It is necessary to define the default constructor because there is also a non-default constructor in this class.

Default values

Member variable

Default

iBearer.iSpeed

EBearerSpeedAutobauding

iBearer.iName

EBearerNameAsynchronousModem

iBearer.iCe

EBearerCETransparent

iRlpParams.iIws

0

iRlpParams.iMws

0

iRlpParams.iT1

0

iRlpParams.iN2

0

iRlpParams.iT4

0


TCallParams() — C++ constructor [with bearer and RLP parameters]

RBasicGsmCall::TCallParams(const TBearer& aBearer,const TRlpParams& aRlpParams);

Description

The C++ constructor is used to construct the object with bearer and RLP parameters. The default constructor is called for the base class.

Arguments

const TBearer& aBearer

Defines the bearer information.

const TRlpParams& aRlpParams

Defines RLP parameter information.

      


Data members

TBearer iBearer

Bearer information.

TRlpParams iRlpParams

RLP parameter information.

EPOC       SDK Home Glossary Indexes Previous Next Up