#include <mw/eiknotapi.h>
| class MEikSrvNotifierBase2 |
| Protected Attributes | |
|---|---|
| MEikSrvNotifierManager * | iManager |
| Public Member Enumerations | |
|---|---|
| enum | TNotifierPriority { ENotifierPriorityAbsolute, ENotifierPriorityVHigh, ENotifierPriorityHigh, ENotifierPriorityLow, ..., ENotifierPriorityLowest } |
| Public Member Functions | |
|---|---|
| MEikSrvNotifierBase2() | |
| virtual | ~MEikSrvNotifierBase2() |
| pure virtual void | Cancel() |
| virtual IMPORT_C void | HandleSystemEventL(TUid) |
| pure virtual TNotifierInfo | Info() |
| virtual IMPORT_C TInt | NotifierCapabilites() |
| pure virtual TNotifierInfo | RegisterL() |
| pure virtual void | Release() |
| void | SetManager(MEikSrvNotifierManager *) |
| pure virtual TPtrC8 | StartL(const TDesC8 &) |
| pure virtual void | StartL(const TDesC8 &, TInt, const RMessagePtr2 &) |
| pure virtual TPtrC8 | UpdateL(const TDesC8 &) |
| virtual IMPORT_C void | UpdateL(const TDesC8 &, TInt, const RMessagePtr2 &) |
Interface to a plug-in server side notifier.
Any number of MEikSrvNotifierBase2 objects can be included in a single DLL. All notifiers are loaded during device startup and are not destroyed until the Uikon server closes down.
All notifiers run in the uikon server thread so are able to directly access server side status panes but cannot call any functions on REikAppUiSession.
Defines a set of notifier priorities. The use and application of these values is implementation-dependent.
| void | Cancel | ( | ) | [pure virtual] |
Cancels an active notifier.
This is called as a result of a client-side call to RNotifier::CancelNotifier().
An implementation should free any relevant resources and complete any outstanding messages, if relevant.
| IMPORT_C void | HandleSystemEventL | ( | TUid | aEvent | ) | [virtual] |
Handles a screen change event.
This function is called by the notifier manager, but only if the notifier can handle a change to the screen device, i.e. if a call to NotifierCapabilites() reports that the EScreenDeviceChangeSupported flag is set.
The default implementation is empty.
| Parameter | Description |
|---|---|
| aEvent | The Uid representing the event. |
| TNotifierInfo | Info | ( | ) | const [pure virtual] |
Gets the notifier parameters.
This is usually the same information as returned by RegisterL() but can be varied at run time.
Returns: Describes the parameters of the notifier.
| IMPORT_C TInt | NotifierCapabilites | ( | ) | [virtual] |
Gets notifier capabilities.
Calls the LAF implemented function.
| TNotifierInfo | RegisterL | ( | ) | [pure virtual] |
Performs any initialisation that this notifier may require.
The function is called when the notifier is loaded (when the plug-in DLL is loaded). It is called only once.
As a minimum, the function should return a TNotifierInfo instance describing the notifier parameters. A good implementation would be to set this into a data member, and then to return it. This is because the same information is returned by Info().
The function is safe to leave from, so it is possible, although rarely necessary, to allocate objects as you would normally do in a ConstructL() function as part of two-phase construction.
Returns: Describes the parameters of the notifier.
| void | Release | ( | ) | [pure virtual] |
Frees all resources owned by this notifier.
This function is called by the notifier framework when all resources allocated by notifiers should be freed. As a minimum, this function should delete this object (i.e. delete this;).
Note that it is important to implement this function correctly to avoid memory leaks.
Starts the notifier.
This is called as a result of a client-side call to RNotifier::StartNotifier(), which the client uses to start a notifier from which it does not expect a response.
The function is synchronous, but it should be implemented so that it completes as soon as possible, allowing the notifier framework to enforce its priority mechanism.
It is not possible to to wait for a notifier to complete before returning from this function unless the notifier is likely to finish implementing its functionality immediately.
| Parameter | Description |
|---|---|
| aBuffer | Data that can be passed from the client-side. The format and meaning of any data is implementation dependent. |
Returns: A pointer descriptor representing data that may be returned. The format and meaning of any data is implementation dependent.
| void | StartL | ( | const TDesC8 & | aBuffer, |
| TInt | aReplySlot, | |||
| const RMessagePtr2 & | aMessage | |||
| ) | [pure virtual] | |||
Starts the notifier.
This is called as a result of a client-side call to the asynchronous function RNotifier::StartNotifierAndGetResponse(). This means that the client is waiting, asynchronously, for the notifier to tell the client that it has finished its work.
It is important to return from this function as soon as possible, and derived classes may find it useful to take a copy of the reply-slot number and the RMessage object.
The implementation of a derived class must make sure that Complete() is called on the RMessage object when the notifier is deactivated.
This function may be called multiple times if more than one client starts the notifier.
| Parameter | Description |
|---|---|
| aBuffer | Data that can be passed from the client-side. The format and meaning of any data is implementation dependent. |
| aReplySlot | Identifies which message argument to use for the reply. This message argument will refer to a modifiable descriptor, a TDes8 type, into which data can be returned. The format and meaning of any returned data is implementation dependent. |
| aMessage | Encapsulates a client request. |
Updates a currently active notifier with new data.
This is called as a result of a client-side call to RNotifier::UpdateNotifier().
| Parameter | Description |
|---|---|
| aBuffer | Data that can be passed from the client-side. The format and meaning of any data is implementation dependent. |
Returns: A pointer descriptor representing data that may be returned. The format and meaning of any data is implementation dependent.
| IMPORT_C void | UpdateL | ( | const TDesC8 & | aBuffer, |
| TInt | aReplySlot, | |||
| const RMessagePtr2 & | aMessage | |||
| ) | [virtual] | |||
Updates a currently active notifier with new data.
This is called as a result of a client-side call to the asynchronous function RNotifier::UpdateNotifierAndGetResponse(). This means that the client is waiting, asynchronously, for the notifier to tell the client that it has finished its work.
It is important to return from this function as soon as possible, and derived classes may find it useful to take a copy of the reply-slot number and the RMessage object.
The implementation of a derived class must make sure that Complete() is called on the RMessage object when the notifier is deactivated.
This function may be called multiple times if more than one client updates the notifier.
| Parameter | Description |
|---|---|
| aBuffer | Data that can be passed from the client-side. The format and meaning of any data is implementation dependent. |
| aReplySlot | Identifies which message argument to use for the reply. This message argument will refer to a modifiable descriptor, a TDes8 type, into which data can be returned. The format and meaning of any returned data is implementation dependent. |
| aMessage | Encapsulates a client request. |