Notifications endpoint

This endpoint is intended for working with notifications about events associated with resources.

Information about methods of the endpoint is provided in the table below.

Methods of the notice.Notice endpoint (kl.core.Notice interface)

Method

Method purpose and parameters

Potential danger of the method

Create

Purpose

Creates a notification receiver.

Parameters

  • [out] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [out] rc – return code.

Allows the kernel memory to be used up by creating a multitude of objects within it.

SubscribeToObject

Purpose

Adds a "resource–event mask" entry to the notification receiver so that it can receive notifications about events associated with the defined resource and match the defined event mask.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the resource.
  • [in] evMask – event mask.
  • [in] evId – ID of the "resource–event mask" entry.
  • [in] flags – flags defining the parameters for the "resource–event mask" entry.
  • [out] rc – return code.

Allows the kernel memory to be used up by creating a multitude of objects within it.

UnsubscribeFromEvent

Purpose

Removes from the notification receiver "resource—event mask" entries with the specified identifier to prevent the receiver from getting notifications about events that match these entries.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] evId – ID of the "resource–event mask" entries.
  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the resource. If the resource is specified, the method deletes the "resource–event mask" entries that have the ID specified in the evId parameter and correspond to this resource.
  • [out] rc – return code.

N/A

UnsubscribeFromObject

Purpose

Removes from the notification receiver "resource—event mask" entries that match the specified resource to prevent the receiver from getting notifications about events that match these entries.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the resource.
  • [in] flags – flags defining which "resource–event mask" entries should be deleted.
  • [out] rc – return code.

N/A

GetEvent

Purpose

Extracts notifications from the receiver.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] mdelay – timeout (in milliseconds) for notifications to appear in the receiver.
  • [out] events – sequence of notifications comprised of structures containing a "resource–event mask" entry ID, mask and counter of events associated with the resource.
  • [out] rc – return code.

N/A

DropAndWake

Purpose

Resumes execution of all threads that are waiting for notifications to appear in the receiver and performs additional actions depending on the flags parameter:

  • Denies extraction of notifications from the receiver.
  • Defines the method used to reallow extraction of notifications from the receiver.
  • Deletes all "resource–event mask" entries and already received notifications from the receiver.
  • Disables the notification receiver.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] flags – flags defining additional actions.
  • [out] rc – return code.

N/A

SetObjectEvent

Purpose

Signals the occurrence of events that are related to the defined user resource and match the defined event mask.

Parameters

  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the user resource.
  • [in] evMask – mask of events to be signaled.
  • [out] rc – return code.

N/A

EditSubscriptionForEvent

Purpose

Modifies "resource–event mask" entries with the specified ID in the notification receiver.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] evId – ID of the "resource–event mask" entries that need to be modified.
  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the resource. If the resource is specified, the method modifies the "resource–event mask" entries that have the ID specified in the evId parameter and correspond to this resource.
  • [in] newId – new ID of the "resource–event mask" entries.
  • [in] newMask – new event mask.
  • [out] rc – return code.

N/A

EditSubscriptionForObject

Purpose

Modifies the "resource–event mask" entries in the notification receiver that correspond to the specified resource.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [in] object – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the resource.
  • [in] flags – flags defining which "resource–event mask" entries should be modified.
  • [in] newId – new ID of the "resource–event mask" entries.
  • [in] newMask – new event mask.
  • [out] rc – return code.

N/A

Resume

Purpose

Reallows extraction of notifications from the receiver denied by the DropAndWake method.

Parameters

  • [in] notify – value whose binary representation consists of multiple fields, including a handle field and a handle permissions mask field. The handle identifies the notification receiver.
  • [out] rc – return code.

N/A

Page top