| class MHCICommandQueue |
| TUint | MhcqAddCommandL | ( | CHCICommandQItem * | aQueItem | ) | [pure virtual] |
Adds a pre-allocated command item to the end of the command queue. Ownership of the command item is transferred from the caller (even in the event of an ..Add.. method leaving).
Use this function if you pre-allocated a CHCICommandQItem. Use this for ensuring that a command can get accepted by the command queue in low memory conditions.
| CHCICommandQItem * aQueItem | The command queue item to be added to the queue. Ownership is passed. |
| TUint | MhcqAddCommandL | ( | CHCICommandBase * | aCommandData, |
| MHCICommandQueueClient & | aCmdProgressRecipient | |||
| ) | [pure virtual] | |||
Adds a command to the end of the command queue. Ownership of the command data is transfered from the caller (even in the event of an ..Add.. method leaving).
| CHCICommandBase * aCommandData | The data to be added to a command queue item which will be be placed on the queue. Ownership is passed. |
| MHCICommandQueueClient & aCmdProgressRecipient | The interface which will get notified about the command's progress. |
| TUint | MhcqAddInitCommandL | ( | CHCICommandQItem * | aQueItem | ) | [pure virtual] |
Adds a pre-allocated initialisation command item to the end of the command queue. Ownership of the command item is transferred from the caller (even in the event of an ..Add.. method leaving).
Initialisation commands are only accepted and sent after the Command Queue has been reset but before it has been started.
Use this function if you pre-allocated a CHCICommandQItem. Use this for ensuring that a command can get accepted by the command queue in low memory conditions.
| CHCICommandQItem * aQueItem | The command queue item to be added to the queue. Ownership is passed. |
| TUint | MhcqAddInitCommandL | ( | CHCICommandBase * | aCommandData, |
| MHCICommandQueueClient & | aCmdProgressRecipient | |||
| ) | [pure virtual] | |||
Adds an initialisation command to the end of the command queue. Ownership of the command data is transfered from the caller (even in the event of an ..Add.. method leaving).
Initialisation commands are only accepted and sent after the Command Queue has been reset but before it has been started.
| CHCICommandBase * aCommandData | The data to be added to a command queue item which will be be placed on the queue. Ownership is passed. |
| MHCICommandQueueClient & aCmdProgressRecipient | The interface which will get notified about the command's progress. |
| TUint | MhcqAddPriorityCommandL | ( | CHCICommandQItem * | aQueItem | ) | [pure virtual] |
Adds a pre-allocated priority command item to the head of the command queue. Ownership of the command item is transferred from the caller (even in the event of an ..Add.. method leaving).
Use this function if you pre-allocated a CHCICommandQItem. Use this for ensuring that a command can get accepted by the command queue in low memory conditions.
| CHCICommandQItem * aQueItem | The command queue item to be added to the queue. Ownership is passed. |
| TUint | MhcqAddPriorityCommandL | ( | CHCICommandBase * | aCommandData, |
| MHCICommandQueueClient & | aCmdProgressRecipient | |||
| ) | [pure virtual] | |||
Adds a priority command to the head of the command queue. Ownership of the command data is transfered from the caller (even in the event of an ..Add.. method leaving).
| CHCICommandBase * aCommandData | The data to be added to a command queue item which will be be placed on the queue. Ownership is passed. |
| MHCICommandQueueClient & aCmdProgressRecipient | The interface which will get notified about the command's progress. |
| TAny * | MhcqQdpPluginInterface | ( | TUid | aUid | ) | const [pure virtual] |
This accesses CHCICmdQueueDecisionPlugin::Interface allowing clients of the Command Queue to request additional interfaces from the QDP
This function will panic if a client attempts to get hold of MHCICmdQueueDeicisionInterface, which is exclusive to the Command Queue.
| TUid aUid | UID of interface to request from the QDP |
| void | MhcqRemoveAllCommands | ( | const MHCICommandQueueClient & | aCmdOriginator | ) | [pure virtual] |
Removes from the Command Queue of all commands a given client has added to the queue.
This should always be called by a MHCICommandQueueClient that has added commands to the Command Queue before it is deleted.
Commands that are pending and have not yet been sent may never get sent.
Pointers to the CHCICommandQItem may (or may not) be valid.
| const MHCICommandQueueClient & aCmdOriginator | The client of commands that are to be purged from the Command Queue. |
| TInt | MhcqRemoveCommand | ( | TUint | aCommandId, |
| const MHCICommandQueueClient & | aCmdOriginator | |||
| ) | [pure virtual] | |||
Removes the command, which has ID aCommandId, from the queue of commands that haven't been sent to the Bluetooth controller yet.
| TUint aCommandId | the ID of the command to remove. |
| const MHCICommandQueueClient & aCmdOriginator | The client that added the command in the first place. This means one client can't remove the commands of another client. |
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.