EPOC   SDK Home Glossary Indexes Previous Next Up

RLine class


Contents


RLine class — Line sub-session

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

RTelSubSessionBase

Abstract: implements a subsession

Defined in

etel.h

Link against

etel.lib

Description

The line sub-session provides access to the functionality associated with a specific line.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


RLine() — Empty default constructor

RLine();

Description

The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.


Open/Close Line requests


Open() — Open a line from a phone connection

TInt Open(RPhone& aPhone,const TDesC& aName);

Description

This function opens a line from a phone connection.

Arguments

RPhone& aPhone

The phone from which the line is to be opened.

const TDesC& aName

The name of the line. Must match the name returned by the RPhone::GetLineInfo() function.

Return value

TInt

An error code: see System error codes.

Notes

Open() — Open a line from a server connection

TInt Open(RTelServer& aServer,const TDesC& aName);

Description

This function opens a line from a server connection. It might be used, in preference to the previous version, when access to phone functionality is not required.

Arguments

RTelServer& aServer

The server from which the line is to be opened.

const TDesC& aName

The name of the line. The format of the name must be as shown below:
PhoneName::LineName

Return value

TInt

An error code: see System error codes.

Notes

Close() — Close the line

void Close();

Description

This function closes the line. This function must be called for all RLine subsessions which have been opened — to prevent memory leakage.


Query Functions


GetCaps() — Get line capabilities

TInt GetCaps(TCaps& aCaps) const;

Description

This function retrieves the line capabilities.

Arguments

TCaps& aCaps

On return, contains the line capabilities.

Return value

TInt

An error code: see System error codes.


GetStatus() — Get line status

TInt GetStatus(RCall::TStatus& aStatus) const;

Description

This function returns line status information.

Arguments

RCall::TStatus& aStatus

On return, contains the line status.

Return value

TInt

An error code: see System error codes.


GetHookStatus() — Get the hook status

TInt GetHookStatus(RCall::THookStatus& aHookStatus) const;

Description

This function retrieves the current hook status.

Arguments

RCall::THookStatus& aHookStatus

On return, contains the current hook status

Return value

TInt

An error code: see System error codes.


EnumerateCall() — Get number of calls opened from line

TInt EnumerateCall(TInt& aCount) const;

Description

This function returns the number of calls opened from a line.

Arguments

TInt& aCount

On return, contains the number of calls opened from the line.

Return value

TInt

An error code: see System error codes.


GetCallInfo() — Get call information

TInt GetCallInfo(TInt aIndex,TCallInfo& aCallInfo) const;

Description

This function returns enough information about a call to differentiate it from other calls on the line.

Arguments

TInt aIndex

The index of the call for which information is to be obtained.

TCallInfo& aCallInfo

On return, contains the call information.

Return value

TInt

An error code: see System error codes.


GetInfo() — Get line information

TInt GetInfo(TLineNotifyInfo& aLineNotifyInfo) const;

Description

This function retrieves a snapshot of the current line information.

Arguments

TLineNotifyInfo& aLineNotifyInfo

On return, contains the current line information

Return value

TInt

An error code: see System error codes.


Notification Functions


NotifyCapsChange() — Notification of a change in line capabilities

void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);

Description

This function provides notification of a change in the line capabilities.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCaps& aCaps

On request completion, contains the new line capabilities


NotifyCapsChangeCancel() — Cancel notification of change in line capabilities

void NotifyCapsChangeCancel() const;

Description

This function cancels an "line capabilities change" notification request, placed using the NotifyCapsChange() function.


NotifyOnAnything() — Notification of any line change

void NotifyOnAnything(TRequestStatus& aStatus,TLineNotifyInfo& aLineNotifyInfo);

Description

This function provides notification of any change in the line information.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TLineNotifyInfo& aLineNotifyInfo

On request completion, contains the new line information.


NotifyOnAnythingCancel() — Cancel notification of any line change

void NotifyOnAnythingCancel() const;

Description

This function cancels an "any change" notification request, placed using the NotifyOnAnything() function.


NotifyIncomingCall() — Notification of an incoming call

void NotifyIncomingCall(TRequestStatus& aStatus, TName& aName);

Description

This function is used to notify a client when an incoming call is detected.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TName& aName

On request completion, contains the name of the incoming call.

Note

NotifyIncomingCallCancel() — Cancel notification of incoming call

void NotifyIncomingCallCancel() const;

Description

This function cancels an outstanding incoming call notification, placed with the NotifyIncomingCall() function.


NotifyHookChange() — Notification of hook change

void NotifyHookChange(TRequestStatus& aStatus,RCall::THookStatus& aHookStatus);

Description

This function provides notification when the hook status changes.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

RCall::THookStatus& aHookStatus

On request completion, contains the new hook status.


NotifyHookChangeCancel() — Cancel notification of a hook change

void NotifyHookChangeCancel() const;

Description

This function cancels an outstanding hook change notification request, placed using the NotifyHookChange() function.


RegisterNotifyStatusChange() — Register interest in the notification of line status change

TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;

Description

This function causes the server to create a buffer, specifically for the requesting client, to store line status change information. This buffer ensures that information is not lost between the completion of the client’s line status change request, and its next request being posted.

This function only creates a buffer for the notification. To actually get the status information use the NotifyStatusChange() function.

Arguments

const TInt aBufferSize

The number of events that the server can buffer

Return value

TInt

An error code: see System error codes.


DeregisterNotifyStatusChange() — Cancel interest in the notification of line status change

TInt DeregisterNotifyStatusChange() const;

Description

This function deletes the buffer in the server. If a client has a status change notification request still outstanding, it will remain so.

Return value

TInt

An error code: see System error codes.


NotifyStatusChange() — Notification of line status change

void NotifyStatusChange(TRequestStatus& aStatus,RCall::TStatus& aLineStatus);

Description

This function provides notification about a change in the line status.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

RCall::TStatus& aLineStatus

On request completion, contains the new line status.


NotifyStatusChangeCancel() — Cancel notification of line status change

void NotifyStatusChangeCancel() const;

Description

This function cancels an outstanding line status change notification request, placed using the NotifyStatusChange() function.


NotifyCallAdded() — Notification of new call added

void NotifyCallAdded(TRequestStatus& aStatus,TName& aName);

Description

This function provides notification that a new call is being added to the line.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TName& aName

On request completion, contains the name of the new call.


NotifyCallAddedCancel() — Cancel notification of new call added

void NotifyCallAddedCancel() const;

Description

This function cancels an outstanding “new call added” notification request, placed using the NotifyCallAdded() function.


RegisterNotifyCallAdded() — Register interest in the notification of call added

TInt RegisterNotifyCallAdded(const TInt aBufferSize) const;

Description

This function causes the server to create a buffer, specifically for the requesting client, to store the notification that a new call has been added to the line. This buffer ensures that information is not lost between completion of the client’s request for notification, and its next request being posted.

Arguments

const TInt aBufferSize

The number of events that the server can buffer

Return value

TInt

An error code: see System error codes.


DeregisterNotifyCallAdded() — Cancel interest in the notification of call added

TInt DeregisterNotifyCallAdded() const;

Description

This function deletes the buffer in the server. If the client has a Call Added notification still outstanding, it will remain so.

Return value

TInt

An error code: see System error codes.


Enumerations


TCapsFlags enum — Line capability flags

KCapsData

The line supports data connections.

KCapsFax

The line supports fax connections.

KCapsVoice

The line supports voice connections.

KCapsEventIncomingCall

The line supports incoming call notification requests.


Struct


TCaps struct — Line capability information

TUint iFlags

Line capability flag. Contains a bitmask of the values defined in the TCapsFlags enumeration.


TCallInfo struct — Line call capability information

TName iCallName

The name of a call.

RCall::TStatus iStatus

The call status.

TUint32 iCallCapsFlags

The call capabilities flag.


Rline::TLineNotifyInfo class — Line capability information

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

Rline::TlineNotifyInfo

Provides structure to contain line capability information.

Defined in

etel.h

Link against

etel.lib

Description

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

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TLineNotifyInfo() — Empty trivial constructor

Rline::TLineNotifyInfo();

Description

The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.


Data members

RCall::THookStatus iHookStatus

The current hook status.

TBool iHookStatusChanged

An indication that the hook status has changed since the last notification.

RCall::TStatus iStatus

The current line status.

TBool iStatusChanged

An indication that the line status has changed since the last notification.

TName iNameOfLastCallAdded

The name of the last call created on the line.

TBool iNameOfLastCallAddedChanged

An indication that a new call has been created on the line and that its name is contained in the iNameOfLastCallAdded member variable.

TName iNameOfCallForAnswering

The name of the call to which a new incoming call will be directed.

TBool iNameOfCallForAnsweringChanged

An indication that a new call has been assigned to answer the next incoming call.

EPOC       SDK Home Glossary Indexes Previous Next Up