RScsClientSubsessionBase Class Reference
#include
<scs/scsclient.h>
Link against: scsclient.lib
| class RScsClientSubsessionBase : public RSubSessionBase |
| Public Member Functions |
|---|
| IMPORT_C void | Close() |
| Inherited Functions |
|---|
| | RSubSessionBase::CloseSubSession(TInt) |
| | RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &) |
| | RSubSessionBase::CreateSubSession(const RSessionBase &,TInt) |
| | RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &) |
| | RSubSessionBase::RSubSessionBase() |
| | RSubSessionBase::Send(TInt)const |
| | RSubSessionBase::Send(TInt,const TIpcArgs &)const |
| | RSubSessionBase::SendReceive(TInt)const |
| | RSubSessionBase::SendReceive(TInt,TRequestStatus &)const |
| | RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const |
| | RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const |
| | RSubSessionBase::Session()const |
| | RSubSessionBase::SubSessionHandle()const |
Detailed Description
This class is used to send messages to server-side SCS subsessions. This class cannot be used directly - the implementor must define a subclass.
Constructor & Destructor Documentation
RScsClientSubsessionBase ( )
| IMPORT_C | RScsClientSubsessionBase | ( | ) | [protected] |
This protected constructor prevents the class from being instantiated directly.
Member Function Documentation
CallSubsessionFunction ( TInt )
| IMPORT_C TInt | CallSubsessionFunction | ( | TInt | aFunction | ) | const [protected] |
Send a command to the corresponding server-side subsession. The subclass uses this function instead of directly calling RSubSessionBase::SendReceive because it adds the SCS code which marks this as a subsession call. Therefore, it can be routed to the subsession object on the server side without any custom decoding.
| Parameter | Description | | aFunction | Subsession command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
Returns: Error code with which the server completed the request.
CallSubsessionFunction ( TInt, const TIpcArgs & )
| IMPORT_C TInt | CallSubsessionFunction | ( | TInt | aFunction, |
| | const TIpcArgs & | aArgs |
| | ) | const [protected] |
Send a command to the corresponding server-side subsession. The subclass uses this function instead of directly calling RSubSessionBase::SendReceive because it adds the SCS code which marks this as a subsession call. Therefore, it can be routed to the subsession object on the server side without any custom decoding.
| Parameter | Description | | aFunction | Subsession command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
| aArgs | Standard IPC arguments. The fourth argument cannot be used because that is reserved for the subsession handle. |
Returns: Error code with which the server completed the request.
CallSubsessionFunction ( TInt, const TIpcArgs &, TRequestStatus & )
Send a command to the corresponding server-side subsession.
| Parameter | Description | | aFunction | Subsession command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
| aArgs | Standard IPC arguments. The fourth argument cannot be used because that is reserved for the subsession handle. |
| aStatus | The server completes this object when it has finished handling the session. |
CancelSubsessionFunction ( TInt )
| IMPORT_C void | CancelSubsessionFunction | ( | TInt | aFunction | ) | const [protected] |
Cancel an outstanding subsession request. This has no effect if the request is not outstanding.
| Parameter | Description | | aFunction | Implementation function. This must be the same value that was supplied to CallSubsessionFunction. |
Close ( )
Closes the subsession, releasing resources on the server side.
CreateSubsession ( const RScsClientBase &, TInt, const TIpcArgs & )
Create a subsession over the supplied session.
| Parameter | Description | | aSession | Session which will host the subsession. |
| aFunction | Command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
| aArgs | Standard IPC arguments. The fourth argument cannot be used because that is reserved for the subsession handle. |
Returns: Error code with which the server completed the request.