MEikSrvNotifierBase2 in Application Framework UIKON

class MEikSrvNotifierBase2;

Description

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.

Members

Defined in MEikSrvNotifierBase2:
Cancel(), ENotifierPriorityAbsolute, ENotifierPriorityHigh, ENotifierPriorityLow, ENotifierPriorityLowest, ENotifierPriorityVHigh, ENotifierPriorityVLow, HandleSystemEventL(), Info(), MEikSrvNotifierBase2(), MEikSrvNotifierBase2_Reserved_2(), NotifierCapabilites(), RegisterL(), Release(), StartL(), StartL(), TNotifierInfo, TNotifierPriority, UpdateL(), UpdateL(), iManager, ~MEikSrvNotifierBase2()

IMPORT_C MEikSrvNotifierBase2();

Description

virtual IMPORT_C ~MEikSrvNotifierBase2();

Description

virtual void Release()=0;

Description

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.

virtual TNotifierInfo RegisterL()=0;

Description

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.

Return value

TNotifierInfo

Describes the parameters of the notifier.

virtual TNotifierInfo Info() const=0;

Description

Gets the notifier parameters.

This is usually the same information as returned by RegisterL() but can be varied at run time.

Return value

TNotifierInfo

Describes the parameters of the notifier.

virtual TPtrC8 StartL(const TDesC8 &aBuffer)=0;

Description

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.

Parameters

const TDesC8 &aBuffer

Data that can be passed from the client-side. The format and meaning of any data is implementation dependent.

Return value

TPtrC8

A pointer descriptor representing data that may be returned. The format and meaning of any data is implementation dependent.

virtual void StartL(const TDesC8 &aBuffer, TInt aReplySlot, const RMessagePtr2 &aMessage)=0;

Description

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.

Parameters

`const TDesC8 &aBuffer`	Data that can be passed from the client-side. The format and meaning of any data is implementation dependent.
`TInt 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.
`const RMessagePtr2 &aMessage`	Encapsulates a client request.

virtual void Cancel()=0;

Description

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.

virtual TPtrC8 UpdateL(const TDesC8 &aBuffer)=0;

Description

Updates a currently active notifier with new data.

This is called as a result of a client-side call to RNotifier::UpdateNotifier().

Parameters

const TDesC8 &aBuffer

Data that can be passed from the client-side. The format and meaning of any data is implementation dependent.

Return value

TPtrC8

A pointer descriptor representing data that may be returned. The format and meaning of any data is implementation dependent.

virtual IMPORT_C void UpdateL(const TDesC8 &aBuffer, TInt aReplySlot, const RMessagePtr2 &aMessage);

Description

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.

Parameters

`const TDesC8 &aBuffer`	Data that can be passed from the client-side. The format and meaning of any data is implementation dependent.
`TInt 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.
`const RMessagePtr2 &aMessage`	Encapsulates a client request.

private: virtual IMPORT_C void MEikSrvNotifierBase2_Reserved_2();

Description

Reserved for future use

virtual IMPORT_C void HandleSystemEventL(TUid aEvent);

Description

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.

Parameters


                              TUid aEvent

The Uid representing the event.

virtual IMPORT_C TInt NotifierCapabilites();

Description

Gets notifier capabilities.

Calls the LAF implemented function.

Return value

TInt

class TNotifierInfo;

Description

Contains the notifier parameters.

Members

Defined in MEikSrvNotifierBase2::TNotifierInfo:
iChannel, iPriority, iUid

Member data

`iUid`

TUid iUid;

Description

The Uid that identifies the notifier.

`iChannel`

TUid iChannel;

Description

The Uid that identifies the channel to be used by the notifier (e.g. the screen, an LED etc)

`iPriority`

TInt iPriority;

Description

The notifier priority, typically chosen from the standard set.

Description

Defines a set of notifier priorities. The use and application of these values is implementation-dependent.

`ENotifierPriorityAbsolute`	The highest priority value.
`ENotifierPriorityVHigh`	The second highest priority value.
`ENotifierPriorityHigh`	The third highest priority value.
`ENotifierPriorityLow`	The fourth highest priority value.
`ENotifierPriorityVLow`	The fifth highest priority value.
`ENotifierPriorityLowest`	The lowest priority value.

protected: MEikSrvNotifierManager * iManager;

Class MEikSrvNotifierBase2

Description

Members

Construction and destruction