#include "mmfcontrollerframework.h"
| class TMMFMessage |
| Public Member Functions | |
|---|---|
| TMMFMessage(const TMMFMessage &) | |
| TMMFMessage(const RMmfIpcMessage &) | |
| IMPORT_C void | AdoptFileHandleFromClientL(TInt, TInt, RFile &) |
| IMPORT_C void | Complete(TInt) |
| IMPORT_C const TMMFMessageDestination & | Destination() |
| IMPORT_C void | FetchDestinationL() |
| IMPORT_C TInt | Function() |
| IMPORT_C TBool | IsCompleted() |
| IMPORT_C TInt | ReadData1FromClient(TDes8 &) |
| IMPORT_C void | ReadData1FromClientL(TDes8 &) |
| IMPORT_C TInt | ReadData2FromClient(TDes8 &) |
| IMPORT_C void | ReadData2FromClientL(TDes8 &) |
| IMPORT_C TInt | SizeOfData1FromClient() |
| IMPORT_C TInt | SizeOfData2FromClient() |
| IMPORT_C TInt | WriteDataToClient(const TDesC8 &) |
| IMPORT_C void | WriteDataToClientL(const TDesC8 &) |
Encapsulation of an RMessage or an RMessage2 to provide protection to controller plugins from the changes occurring with secure APIs.
Adds required destination information to the message so the controller framework can determine which object the message is for.
Adds capability to check whether the message has been completed.
Allows two descriptors to be read from the client, and one descriptor to be copied to the client.
See also: RMMFControllerProxy::SendSync RMMFControllerProxy::SendAsync
| IMPORT_C | TMMFMessage | ( | const TMMFMessage & | aMessage | ) |
Copy constructor.
A controller plugin should use this to take a copy of the message when it must wait for some other event before completing it.
| Parameter | Description |
|---|---|
| aMessage | The message object to copy. |
| IMPORT_C | TMMFMessage | ( | const RMmfIpcMessage & | aMessage | ) |
Constructs a TMMFMessage from an RMmfIpcMessage.
| Parameter | Description |
|---|---|
| aMessage | The handle to the remote message. |
| IMPORT_C void | Complete | ( | TInt | aReason | ) |
Signals to the client that its request has been completed.
Equivalent to RMessage::Complete.
| Parameter | Description |
|---|---|
| aReason | The result code to be given back to the client. |
| IMPORT_C const TMMFMessageDestination & | Destination | ( | ) |
Returns the destination of the message.
Returns: The destination of the message, consisting of a UID defining the interface and the handle of the destination object.
| IMPORT_C void | FetchDestinationL | ( | ) |
Gets the destination info from the client.
| IMPORT_C TInt | Function | ( | ) |
Returns an integer describing the function being called. Equivalent to RMessage::Function().
See also: RMessage::Function()
Returns: The function being called over IPC.
| IMPORT_C TBool | IsCompleted | ( | ) |
Checks whether this message has already been completed.
Returns: A boolean indicating if the message has been completed. ETrue if the message has been completed, EFalse if not.
Copy the first descriptor from the client.
| Parameter | Description |
|---|---|
| aDes | A descriptor defining the area of memory into which the data from the client will be copied. Note, the descriptor must be of sufficient size. |
Returns: One of the system-wide error codes. In particular, KErrBadDescriptor will be returned if the client did not provide a valid descriptor.
| IMPORT_C void | ReadData1FromClientL | ( | TDes8 & | aDes | ) |
Copy the first descriptor from the client.
This functino can leave with one of the system-wide error codes. In particular, the leave code KErrBadDescriptor will be used if the client did not provide a valid descriptor.
| Parameter | Description |
|---|---|
| aDes | A descriptor defining the area of memory into which the data from the client will be copied. Note, the descriptor must be of sufficient size. |
Copies the second descriptor from the client.
| Parameter | Description |
|---|---|
| aDes | A descriptor defining the area of memory into which the data from the client will be copied. Note, the descriptor must be of sufficient size. |
Returns: One of the system-wide error codes. In particular, KErrBadDescriptor will be returned if the client did not provide a valid descriptor.
| IMPORT_C void | ReadData2FromClientL | ( | TDes8 & | aDes | ) |
Copies the second descriptor from the client.
This function can leave with one of the system-wide error codes. In particular, the leave code KErrBadDescriptor will be used if the client did not provide a valid descriptor.
| Parameter | Description |
|---|---|
| aDes | A descriptor defining the area of memory into which the data from the client will be copied. Note, the descriptor must be of sufficient size. |
| IMPORT_C TInt | SizeOfData1FromClient | ( | ) |
Returns the size of the first descriptor that can be copied over from the client.
Use this to create a descriptor of appropriate size before reading the data from the client.
Returns: The size of data 1.
| IMPORT_C TInt | SizeOfData2FromClient | ( | ) |
Returns the size of the second descriptor that can be copied over from the client.
Use this to create a descriptor of appropriate size before reading the data from the client.
Returns: The size of data 2.
Copies data back to the client.
| Parameter | Description |
|---|---|
| aDes | The data to be copied back to the client. Note that the client must have already created a descriptor of sufficient size for the data to be copied into. |
Returns: One of the system-wide error codes. In particular, the error code KErrBadDescriptor will be returned if the client did not provide a valid descriptor.
| IMPORT_C void | WriteDataToClientL | ( | const TDesC8 & | aDes | ) |
Copies the data back to the client.
This function can leave with one of the system-wide error codes. In particular, the leave code KErrBadDescriptor will be used if the client did not provide a valid descriptor.
| Parameter | Description |
|---|---|
| aDes | The data to be copied back to the client. Note that the client must have already created a descriptor of sufficient size for the data to be copied into. |