Class RNotifier

class RNotifier : public RSessionBase;

Description

A handle to a session with the extended notifier server that provides support for plug-in notifiers.

The interface allows engines or other low level components to communicate with the UI.

Derivation

• RHandleBase - A handle to an object.

• RSessionBase - Client-side handle to a session with a server.

• RNotifier - A handle to a session with the extended notifier server that provides support fo...

Members

Defined in RNotifier:

• CancelNotifier(TUid)Requests the extended notifier server to cancel the notifier identified by the s...
• Close()Closes the notifier.
• Connect()Connects to the extended notifier server, creating a session with that server. N...
• Notify(const TDesC &,const TDesC &,const TDesC &,const TDesC &,TInt &,TRequestStatus &)Launches a simple two line dialog that displays two lines of text.
• NotifyCancel()Not implemented by the server.
• RNotifier()Default constructor.
• StartNotifier(TUid,TUid,const TDesC8 &,TDes8 &)
• StartNotifier(TUid,const TDesC8 &)Requests the extended notifier server to start the notifier identified by the sp...
• StartNotifier(TUid,const TDesC8 &,TDes8 &)Requests the extended notifier server to start the notifier identified by the sp...
• StartNotifierAndGetResponse(TRequestStatus &,TUid,const TDesC8 &,TDes8 &)Requests the extended notifier server to start the notifier identified by the sp...
• UpdateNotifier(TUid,const TDesC8 &,TDes8 &)Requests the extended notifier server to update the active notifier identified b...
• UpdateNotifierAndGetResponse(TRequestStatus &,TUid,const TDesC8 &,TDes8 &)Requests the extended notifier server to update the active notifier identified b...

Inherited from RHandleBase:

• Attributes()const
• BTraceId()constReturns a unique object identifier for use with BTrace
• Duplicate(const RThread &,TOwnerType)Creates a valid handle to the kernel object for which the specified thread alrea...
• FullName()constGets the full name of the handle.
• FullName(TDes &)constGets the full name of the handle.
• Handle()constRetrieves the handle-number of the object associated with this handle.
• HandleInfo(THandleInfo *)Gets information about the handle.
• Name()constGets the name of the handle.
• Open(const TFindHandleBase &,TOwnerType)Opens a handle to a kernel side object found using a find-handle object.
• RHandleBase(TInt)Copy constructor.
• SetHandle(TInt)Sets the handle-number of this handle to the specified value.
• SetHandleNC(TInt)Sets the handle-number of this handle to the specified value, and marks it as no...
• iHandle

Inherited from RSessionBase:

• CreateSession(RServer2,const TVersion &)Creates a session with a server, specifying no message slots.
• CreateSession(RServer2,const TVersion &,TInt)Creates a session with a server.
• CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)Creates a session with a server.
• CreateSession(const TDesC &,const TVersion &)Creates a session with a server, specifying no message slots.
• CreateSession(const TDesC &,const TVersion &,TInt)Creates a session with a server.
• CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)Creates a session with a server.
• CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
• EAutoAttach
• EExplicitAttach
• Open(RMessagePtr2,TInt,TOwnerType)Opens a handle to a session using a handle number sent by a client to a server.
• Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)Opens a handle to a session using a handle number sent by a client to a server, ...
• Open(TInt,TOwnerType)Opens a handle to a session using a handle number passed as an environment data ...
• Open(TInt,const TSecurityPolicy &,TOwnerType)Opens a handle to a session using a handle number passed as an environment data ...
• Send(TInt)constIssues a blind request to the server with the specified function number, but wit...
• Send(TInt,const TIpcArgs &)constIssues a blind request to the server with the specified function number, and arg...
• SendReceive(TInt)constIssues a synchronous request to the server with the specified function number, b...
• SendReceive(TInt,TRequestStatus &)constIssues an asynchronous request to the server with the specified function number,...
• SendReceive(TInt,const TIpcArgs &)constIssues a synchronous request to the server with the specified function number an...
• SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constIssues an asynchronous request to the server with the specified function number ...
• SetReturnedHandle(TInt)Sets the handle-number of this handle to the specified value.
• SetReturnedHandle(TInt,RHandleBase &)
• SetReturnedHandle(TInt,const TSecurityPolicy &)Sets the handle-number of this session handle to the specified value after valid...
• ShareAuto()Creates a session that can be shared by other threads in the current process.
• ShareProtected()Creates a session handle that can be be passed via IPC to another process as wel...
• TAttachModeIndicates whether or not threads in the process are automatically attached to th...

IMPORT_C RNotifier();

Description

Default constructor.

IMPORT_C TInt Connect();

Description

Connects to the extended notifier server, creating a session with that server. Note: Notifier server is started during window server start-up sequence.

The function must be called before any other function.

Return value

TInt KErrNone, if successful, otherwise one of the other system-wide error codes

IMPORT_C void Close();

Description

Closes the notifier.

IMPORT_C TInt StartNotifier(TUid aNotifierUid, const TDesC8 &aBuffer);

Description

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not be started immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on.

Parameters

TUid aNotifierUid The UID identifying the notifier. const TDesC8 &aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID; KErrAlreadyExists, if the notifier has already been started, or has an outstanding start request. It may also return with one of the other system-wide error codes, if the notifier cannot be started by the server due to low memory or it leaves from its server side call to StartL().

Interface status:

deprecated

use RNotifier::StartNotifierAndGetResponse(), or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier()

IMPORT_C TInt StartNotifier(TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse);

Description

Requests the extended notifier server to start the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

The notifier may not start immediately if a higher priority notifier is already active. In this case, the notifier is queued until it has the highest priority outstanding request for the channel(s) it operates on. This can also cause unexpected behaviour: the function can return before the notifier has been started with the added consequence that no response data is written.

For this reason, this function has been deprecated. Instead, use RNotifier::StartNotifierAndGetResponse(TRequestStatus &,TUid,const TDesC8 &,TDes8 &), or if there is no need to wait for a response, use the two argument overload of RNotifier::StartNotifier(TUid,const TDesC8 &).

Parameters

TUid aNotifierUid The UID identifying the notifier. const TDesC8 &aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier. TDes8 &aResponse Response data; the format and meaning of this depends on the notifier.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID; KErrAlreadyExists, if the notifier has already been started, or has an outstanding start request. It may also return with one of the other system-wide error codes, if the notifier cannot be started by the server due to low memory or it leaves from its server side call to StartL().

IMPORT_C TInt StartNotifier(TUid aNotifierDllUid, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse);

Description

Parameters

TUid aNotifierDllUid TUid aNotifierUid const TDesC8 &aBuffer TDes8 &aResponse

Return value

TInt

IMPORT_C TInt CancelNotifier(TUid aNotifierUid);

Description

Requests the extended notifier server to cancel the notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Any notifier that was queued pending the completion of aNotifierUid will be automatically started.

Parameters

TUid aNotifierUid The UID identifying the notifier.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

IMPORT_C TInt UpdateNotifier(TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse);

Description

Requests the extended notifier server to update the active notifier identified by the specified UID.

The request is synchronous; the call returns when the request is complete.

Parameters

TUid aNotifierUid The UID identifying the notifier. const TDesC8 &aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier. TDes8 &aResponse Reserved for future use.

Return value

TInt KErrNone, if successful; KErrNotFound, if there is no notifier matching the specified UID.

IMPORT_C void UpdateNotifierAndGetResponse(TRequestStatus &aRs, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse);

Description

Requests the extended notifier server to update the active notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

TRequestStatus &aRs The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes. TUid aNotifierUid The UID identifying the notifier. const TDesC8 &aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier. TDes8 &aResponse Reserved for future use.

IMPORT_C void StartNotifierAndGetResponse(TRequestStatus &aRs, TUid aNotifierUid, const TDesC8 &aBuffer, TDes8 &aResponse);

Description

Requests the extended notifier server to start the notifier identified by the specified UID.

This is an asynchronous request.It may be called multiple times for some notifier implementations; see specific notifier documentation for exact details.

Parameters

TRequestStatus &aRs The request status. On request completion, contains: KErrNone, if successful; otherwise, one of the other system wide error codes. TUid aNotifierUid The UID identifying the notifier. const TDesC8 &aBuffer Data that can be passed to the notifier; the format and meaning of this depends on the notifier. TDes8 &aResponse Response data; the format and meaning of this depends on the notifier.

IMPORT_C void Notify(const TDesC &aLine1, const TDesC &aLine2, const TDesC &aBut1, const TDesC &aBut2, TInt &aButtonVal, TRequestStatus &aStatus);

Description

Launches a simple two line dialog that displays two lines of text.

This is an asynchronous request that completes when the dialog exits.

Parameters

const TDesC16 &aLine1 A descriptor containing the first line of text to be displayed. const TDesC16 &aLine2 A descriptor containing the second line of text to be displayed. const TDesC16 &aBut1 A descriptor containing text to be displayed in the first button. const TDesC16 &aBut2 A descriptor containing text to be displayed in the (optional) second button. TInt &aButtonVal An integer value which is set when the dialog exits. It is set to: 0, if the first button is selected; 1, if the second button is selected. TRequestStatus &aStatus The request status object. If the request completes normally, this is set to KErrNone.

IMPORT_C void NotifyCancel();

Description

Not implemented by the server.