![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
RTelSubSessionBase |
Abstract: implements a subsession |
etel.h
etel.lib
The call sub-session provides access to the functionality associated with a specific call.
This class is not intended for user derivation
RCall();
The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.
TInt OpenNewCall(RTelServer& aServer,const TDesC& aName,TDes& aNewName);
This function opens a new call from a server session.
RTelServer& aServer |
The server opening the call. |
const TDesC& aName |
The name of the line from which the call is to be opened. The format of the name must be as shown below: |
TDes& aNewName |
On return, contains the name of the new call. |
TInt |
An error code: see System error codes. |
TInt OpenNewCall(RTelServer& aServer,const TDesC& aName);
This function opens a new call from a server, but does not return the new name to the client.
RTelServer& aServer |
The server opening the call. |
const TDesC& aName |
The name of the line from which the call is to be opened. The format of the name must be as shown below: |
TInt |
An error code: see System error codes. |
TInt OpenNewCall(RPhone& aPhone,const TDesC& aName,TDes& aNewName);
This function opens a new call from a phone.
RPhone& aPhone |
The phone opening the call. |
const TDesC& aName |
The name of the line to open the call from. The format of the name must be as shown below: The name of the line can be obtained using the RPhone::GetLineInfo() function. |
TDes& aNewName |
On return, contains the name of the new call. |
TInt |
An error code: see System error codes. |
TInt OpenNewCall(RPhone& aPhone,const TDesC& aName);
This function opens a new call from a phone, but does not return the new name to the client.
RPhone& aPhone |
The phone opening the call. |
const TDesC& aName |
The name of the line to open the call from. The format of the name must be as shown below: The name of the line can be obtained using the RPhone::GetLineInfo() function. |
TInt |
An error code: see System error codes. |
TInt OpenNewCall(RLine& aLine,TDes& aNewName);
This function opens a new call from a line.
RLine& aLine |
The line opening the call. |
TDes& aNewName |
On return, contains the name of the new call. |
TInt |
An error code: see System error codes. |
TInt OpenNewCall(RLine& aLine);
This function opens a new call from a line. The name of the new call is not returned.
RLine& aLine |
The line opening the call. |
TInt |
An error code: see System error codes. |
TInt OpenExistingCall(RTelServer& aServer,const TDesC& aName);
This function opens an existing call from a server.
RTelServer& aServer |
The server opening the call. |
const TDesC& aName |
The name of the call to open. Must be of the form: |
TInt |
An error code: see System error codes. |
TInt OpenExistingCall(RPhone& aPhone,const TDesC& aName);
This function opens an existing call from a phone.
RPhone& aPhone |
The phone opening the call. |
const TDesC& aName |
The name of the call to open. Must be of the form: |
TInt |
An error code: see System error codes. |
TInt OpenExistingCall(RLine& aLine,const TDesC& aName);
This function opens an existing call from a line.
RLine& aLine |
The line opening the call. |
const TDesC& aName |
The name of the call to open. |
TInt |
An error code: see System error codes. |
void Close();
This function closes the RCall subsession. This function must be called for all RCall subsessions which have been opened to prevent memory leakage.
TInt GetStatus(TStatus& aStatus) const;
This function retrieves the current call status.
TStatus& aStatus |
On return, contains the current call status |
TInt |
An error code: see System error codes. |
TInt GetCaps(TCaps& aCaps) const;
This function retrieves a snapshot of the current call capabilities.
TCaps& aCaps |
On return, contains the call capabilities |
TInt |
An error code: see System error codes. |
TInt GetBearerServiceInfo(TBearerService& aBearerService) const;
This function retrieves the bearer service information associated with the call. Bearer service information is only available if the call is currently active.
TBearerService& aBearerService |
On return, contains the bearer service information. |
TInt |
An error code: see System error codes. |
TInt GetInfo(TCallNotifyInfo& aCallNotifyInfo) const;
This function retrieves the current call information.
TCallNotifyInfo& aCallNotifyInfo |
On return, contains the current call information |
TInt |
An error code: see System error codes. |
TInt GetCallDuration(TTimeIntervalSeconds& aTime) const;
This function retrieves the call duration.
TTimeIntervalSeconds& aTime |
On return, contains the call duration (in seconds) |
TInt |
An error code: see Error codes. |
TInt GetCallParams(TDes8& aParams) const;
This function retrieves the current call parameters.
TDes8& aParams |
On return, contains the call parameters. The variable must be an instance of the TCallParamPckg class. |
TInt |
An error code: see System error codes. |
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
This function provides notification of a change in the call capabilities.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TCaps& aCaps |
On request completion, contains the calls capability information |
void NotifyCapsChangeCancel() const;
This function cancels a "call capabilities change" notification request, placed using the NotifyCapsChange() function.
void NotifyOnAnything(TRequestStatus& aStatus,TCallNotifyInfo& aCallNotifyInfo);
This function provides notification of changes in the call information.
TRequestStatus& aStatus |
A flag that indicates the completion status of the request. |
TCallNotifyInfo& aCallNotifyInfo |
On return, contains the new call information. |
void NotifyOnAnythingCancel() const;
This function cancels an "Any change" notification request, placed using the NotifyOnAnything() function.
void NotifyHookChange(TRequestStatus& aStatus,THookStatus& aHookStatus);
This function provides notification of a change in the hook status.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
THookStatus& aHookStatus |
On request completion, contains the new hook status |
void NotifyHookChangeCancel() const;
This function cancels an outstanding hook status change notification request, placed with the NotifyHookChange() function.
TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;
This function causes the server to create a buffer, specifically for the requesting client, to store a notification that the hook status has changed. This buffer ensures that information is not lost between the clients request for notification completing, and its next request being posted.
const TInt aBufferSize |
The number of events that the server can buffer |
TInt |
An error code: see System error codes. |
TInt DeregisterNotifyStatusChange() const;
This function deletes the buffer in the server. If a client has a status change notification still outstanding, it will remain so.
TInt |
An error code: see System error codes. |
void NotifyStatusChange(TRequestStatus& aStatus,TStatus& aCallStatus);
This function provides notification about a change in the status of a call.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TStatus& aCallStatus |
On request completion, contains the new call status. |
void NotifyStatusChangeCancel() const;
This function cancels an outstanding call status change notification request, placed using the NotifyStatusChange() function.
void NotifyCallDurationChange(TRequestStatus& aStatus,TTimeIntervalSeconds& aTime);
This function provides notification of an increase in call duration (by one second).
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TTimeIntervalSeconds& aTime |
On request completion, contains the current update of the call duration. |
void NotifyCallDurationChangeCancel() const;
This function cancels an outstanding call duration change notification request, placed using the NotifyCallDurationChange() function.
TInt Dial(const TTelNumberC& aTelNumber) const;
This function attempts to establish a connection using the telephone number specified.
const TTelNumberC& aTelNumber |
A telephone number. |
TInt |
An error code: see Error codes. |
TInt Dial(const TDesC8& aCallParams,const TTelNumberC& aTelNumber) const;
This function attempts to establish a connection using the telephone number specified.
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
const TTelNumberC& aTelNumber |
A telephone number. |
TInt |
An error code: see Error codes. |
void Dial(TRequestStatus& aStatus,const TTelNumberC& aTelNumber);
This function attempts to establish a connection using the telephone number specified.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TTelNumberC& aTelNumber |
A telephone number |
void Dial(TRequestStatus& aStatus,const TDesC8& aCallParams,const TTelNumberC& aTelNumber);
This function attempts to establish a connection using the telephone number specified.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
const TTelNumberC& aTelNumber |
The telephone number |
void DialCancel() const;
This function cancels an outstanding dial request, placed with the asynchronous version of the Dial() function.
TInt Connect() const;
This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.
TInt |
An error code: see Error codes. |
TInt Connect(const TDesC8& aCallParams) const;
This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
TInt |
An error code: see Error codes. |
void Connect(TRequestStatus& aStatus);
This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
void Connect(TRequestStatus& aStatus,const TDesC8& aCallParams);
This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
void ConnectCancel() const;
This function allows a client to cancel a connection request, placed using the asynchronous versions of the Connect() function.
TInt AnswerIncomingCall() const;
This function waits for an incoming call and answers it when it arrives.
TInt |
An error code: see Error codes. |
TInt AnswerIncomingCall(const TDesC8& aCallParams) const;
This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
TInt |
An error code: see Error codes. |
void AnswerIncomingCall(TRequestStatus& aStatus);
This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
void AnswerIncomingCall(TRequestStatus& aStatus,const TDesC8& aCallParams);
This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TDesC8& aCallParams |
The call parameters used by the TSY (a TCallParamsPckg object). |
void AnswerIncomingCallCancel() const;
This function allows a client to cancel an outstanding call answer request, that was placed using the asynchronous versions of the AnswerIncomingCall() function. If a call has not arrived the TSY notes that it should not answer when one arrives; if the call is answering, then an attempt is made to abort.
TInt HangUp() const;
This function terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions.
TInt |
An error code: see Error codes. |
void HangUp(TRequestStatus& aStatus) const;
This function terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions.
TRequestStatus& aStatus |
An error code: see Error codes. |
void HangUpCancel() const;
This function cancels an outstanding HangUp request, placed using the asynchronous version of the HangUp() function. It should be noted that if the call termination sequence has begun there is little hope of retaining the call even if this function is used.
TInt LoanDataPort(TCommPort& aDataPort) const;
This function allows a client to gain control of the serial communications abstraction used to communicate with a modem.
TCommPort& aDataPort |
On return, contains the information required to open the communications port. |
TInt |
An error code: see Error codes. |
void LoanDataPort(TRequestStatus& aStatus,TCommPort& aDataPort);
This function allows a client to gain control of the serial communications abstraction used to communicate with the modem.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TCommPort& aDataPort |
On request completion, contains the information required to open the communications port. |
void LoanDataPortCancel() const;
This function allows a client to cancel an outstanding loan communications port request, placed using the asynchronous version of the LoanDataPort() function.
TInt RecoverDataPort() const;
This function should be used by the client to indicate that it has finished using the serial communication channel so the ETel server can retake control.
TInt |
An error code: see Error codes. |
void AcquireOwnership(TRequestStatus& aStatus) const;
This function is used to gain ownership from another client. This function completes when the current call owner calls the TransferOwnership() function, or if it closes its handle without hanging up. When (and if) the request completes, call ownership has transferred to the new client.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
void AcquireOwnershipCancel() const;
This function cancels an outstanding request to gain call ownership, placed with the AcquireOwnership() function.
TInt TransferOwnership() const;
This function allows clients with call ownership to transfer ownership to another interested client.
TInt |
An error code: see Error codes. |
TInt GetOwnershipStatus(TOwnershipStatus& aOwnershipStatus) const;
This function retrieves ownership information associated with the call.
TOwnershipStatus& aOwnershipStatus |
On return, contains the call ownership status information |
TInt |
An error code: see System error codes. |
TInt GetFaxSettings(TFaxSessionSettings& aSettings) const;
This function retrieves the current fax settings.
TFaxSessionSettings& aSettings |
On return, contains the fax settings |
TInt |
An error code: see System error codes. |
TInt SetFaxSettings(const TFaxSessionSettings& aSettings) const;
This function assigns the fax settings.
const TFaxSessionSettings& aSettings |
The new fax settings |
TInt |
An error code: see System error codes. |
V42bis modem compression protocol. |
|
MNP5 modem compression protocol. |
|
No compression supported. |
|
LAPM error correction protocol. |
|
MNP10 mode. |
|
MNP error correction. |
|
No protocol information provided. |
|
Compression protocol unknown. |
|
Unable to establish protocol. |
Transfer rate of 57600 bps. |
|
Transfer rate of 33600 bps. |
|
Transfer rate of 31200 bps. |
|
Transfer rate of 9200 bps. |
|
Transfer rate of 4400 bps. |
|
Transfer rate of 12000 bps. |
|
Transfer rate of 9600 bps. |
|
Transfer rate of 7200 bps. |
|
Transfer rate of 4800 bps. |
|
Transfer rate of 2400 bps. |
|
Transfer rate of 200 bps. |
|
V.23 75 bps forward, 1200 bps back |
|
V.23 1200 bps forward, 75 bps back |
|
Transfer rate of 300 bps. |
|
Transfer rate is unknown. |
The call supports data calls. |
|
The call supports fax calls. |
|
The call supports voice calls. |
|
The Dial request is currently a valid action. |
|
The Connect request is currently a valid action. |
|
The Hang Up request is currently a valid action. |
|
The Answer request is currently a valid action. |
|
The Loan Data Port request is currently a valid action. |
|
The Recover Data Port request is currently a valid action. |
20 |
Fax is transmitting |
|
Fax is receiving. |
Retrieving a fax opened from voice call (not currently supported by GSM networks). |
|
Retrieve a fax opened from fax call. |
The line is currently off hook. |
|
The line is currently on hook. |
|
The status of the lines hook is currently unknown |
Speaker control is always off |
|
Speaker control is on until the carrier is detected |
|
Speaker control is always active. |
|
Speaker control is on, except while dialling |
|
Speaker control is unknown. |
Speaker volume is off. |
|
Speaker volume is low. |
|
Speaker volume is medium. |
|
Speaker volume is high. |
|
Speaker volume is unknown. |
The call is not owned. |
|
The call is owned, but not by this RCall instance. |
|
The call is owned by this RCall instance. |
|
The call is owned, but not by the priority client |
The call status is not known. |
|
The call is idle. |
|
The call is dialling. |
|
The call is ringing (an incoming, unanswered call). |
|
The call is being answered. |
|
The call is connecting (immediate call establishment, without dialling). |
|
The call is connected and active. |
|
The call is being terminated. |
Waiting for dial tone. |
|
Not waiting for dial tone. |
TUint32 iBearerCaps |
The bearer capabilities. |
TCallBearerSpeed iBearerSpeed |
The bearers speed. |
TUint iFlags |
Call capability flag. Contains a bitmask of values defined in the TCapsEnum enumeration. |
TFileName iCsy |
The CSY module used by the C32 Communications Server to talk to the serial device. |
TName iPort |
The port used by the C32 Communications Server to talk to the serial device. |
TFaxMode iMode |
The fax mode. |
TFaxRetrieveType iFaxRetrieveType |
The mode of retrieving faxes. |
TFaxClass iFaxClass |
The class of fax |
TBuf8<KFaxIdUserNameMaxSize> iFaxId |
The fax identifier string displayed at the top of the fax. |
TInt iMaxSpeed |
The maximum transfer speed that can be negotiated. |
TInt iMinSpeed |
The minimum transfer speed that should be negotiated. |
TInt iPreferredECM |
The preferred compression mode used for negotiation. This may take one of the following values: EModifiedHuffman, EModifiedRead, EUncompressedModifiedRead, EModifiedModifiedRead. |
TInt iFaxOnDemandDelay |
The delay used for Fax on Demand services. Measured in seconds. |
TFaxResolution iTxResolution |
The preferred transmit resolution. This may take one of the following values: EFaxNormal EFaxFine |
TFaxCompression iTxCompression |
Compression mode for transmitting faxes. |
TInt iTxPages |
The number of pages to be transmitted. |
TFaxResolution iRxResolution |
The preferred receive resolution. This may take one of the following values: EFaxNormal EFaxFine. |
TFaxCompression iRxCompression |
Compression mode for receiving faxes. |
typedef TDesC8 TTelNumberC;
etel.h
Objects of this type are used to pass telephone numbers into Dial functions.
typedef TPckg<TCallParams> TCallParamsPckg;
etel.h
The call parameters to be associated with a call may be passed into functions using this type.
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
RCall::TCallNotifyInfo |
The class defines the call information. |
etel.h
etel.lib
All the information associated with an instance of the core 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 calls data.
This class is not intended for user derivation
RCall::TCallNotifyInfo();
The constructor is empty.
TName iCallName |
The name of the call. |
TBool iCallNameChanged |
An indication that the name of the call has changed. |
TName iLineName |
The name of the calls line. |
TBool iLineNameChanged |
An indication that the line information has changed since the last notification. |
THookStatus iHookStatus |
The hook status. |
TBool iHookStatusChanged |
An indication that the hook status information has changed since the last notification. |
TStatus iStatus |
The current call status. |
TBool iStatusChanged |
An indication that the call status has changed since the last notification. |
TTimeIntervalSeconds iDuration |
The current call duration. |
TBool iDurationChanged |
An indication that the call duration has changed since the last notification. |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
RCall::TCallParams |
The class defines the call parameter information. |
etel.h
etel.lib
The class defines the call parameter information.
This class is not intended for user derivation
RCall::TCallParams();
The default constructor creates a properly initialised TCallParams object. The member variables are initialised as shown in the following table.
iSpeakerControl |
EMonitorSpeakerControlOnUntilCarrier |
iSpeakerVolume |
EMonitorSpeakerVolumeLow |
iInterval |
4 |
iWaitForDialTone |
EDialToneWait |
iIsDefault |
ETrue |
TCallParams(TMonitorSpeakerControl aSpeakerControl, TMonitorSpeakerVolume aSpeakerVolume, TUint aInterval, TWaitForDialTone aWaitForDialTone);
The C++ constructor is used to allow developers to initialise member variables when the object is constructed.
TMonitorSpeakerControl aSpeakerControl |
Specifies speaker control mode. |
TMonitorSpeakerVolume aSpeakerVolume |
Specifies the speaker volume setting |
TUint aInterval |
Specifies the pause interval used when a comma is inserted into the dial string |
TWaitForDialTone aWaitForDialTone |
Specifies whether the modem is asked to wait for a dial tone before issuing the dial tones or pulses. |
TBool IsDefault();
Determines if the object was created using the default values.
TBool |
True, if the object was created using the default values. |
TMonitorSpeakerControl iSpeakerControl |
The monitor speaker control setting. |
TMonitorSpeakerVolume iSpeakerVolume |
The monitor speaker volume control setting. |
TUint iInterval |
The length of a pause created during dialling by the comma character (,) measured in seconds |
TWaitForDialTone iWaitForDialTone |
Whether, when dialling a call, the modem should wait for a dial tone. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |