class RScsClientSubsessionBase : public RSubSessionBase |
This class is used to send messages to server-side SCS subsessions. This class cannot be used directly - the implementor must define a subclass.
Public Member Functions | |
---|---|
IMPORT_C void | Close () |
Protected Member Functions | |
---|---|
RScsClientSubsessionBase () | |
IMPORT_C TInt | CallSubsessionFunction ( TInt ) |
IMPORT_C TInt | CallSubsessionFunction ( TInt , const TIpcArgs &) |
IMPORT_C void | CallSubsessionFunction ( TInt , const TIpcArgs &, TRequestStatus &) |
IMPORT_C void | CancelSubsessionFunction ( TInt ) |
IMPORT_C TInt | CreateSubsession (const RScsClientBase &, TInt , const TIpcArgs &) |
IMPORT_C | RScsClientSubsessionBase | ( | ) | [protected] |
This protected constructor prevents the class from being instantiated directly.
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.
TInt aFunction | Subsession command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
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.
IMPORT_C void | CallSubsessionFunction | ( | TInt | aFunction, |
const TIpcArgs & | aArgs, | |||
TRequestStatus & | aStatus | |||
) | const [protected] |
Send a command to the corresponding server-side subsession.
TInt aFunction | Subsession command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
const TIpcArgs & aArgs | Standard IPC arguments. The fourth argument cannot be used because that is reserved for the subsession handle. |
TRequestStatus & aStatus | The server completes this object when it has finished handling the session. |
IMPORT_C void | CancelSubsessionFunction | ( | TInt | aFunction | ) | const [protected] |
Cancel an outstanding subsession request. This has no effect if the request is not outstanding.
TInt aFunction | Implementation function. This must be the same value that was supplied to CallSubsessionFunction. |
IMPORT_C TInt | CreateSubsession | ( | const RScsClientBase & | aSession, |
TInt | aFunction, | |||
const TIpcArgs & | aArgs | |||
) | [protected] |
Create a subsession over the supplied session.
const RScsClientBase & aSession | Session which will host the subsession. |
TInt aFunction | Command identifier. Bits 31:24 must be zero, because they are reserved for SCS commands. |
const TIpcArgs & aArgs | Standard IPC arguments. The fourth argument cannot be used because that is reserved for the subsession handle. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.