NvSciEventService Struct Reference

Detailed Description

An abstract interface for a program's event handling infrastructure.

An NvSciEventService is an abstraction that a library can use to interact with the event handling infrastructure of the containing program.

If a library needs to handle asynchronous events or report asynchronous events to its users, but the library does not wish to impose a threading model on its users, the library can require each user to provide an NvSciEventService when the user initializes the library (or a portion thereof).

An NvSciEventService provides two categories of services related to event handling:

(1) The ability to define "event notifiers", which are objects that can notify event handling infrastructure each time an event has occurred. Note that event notifications carry no payload; it is expected that any event payload information is conveyed separately.

(2) The ability to bind an "event handler" to each event notifier. An event handler is essentially a callback that is invoked each time the bound event notifier reports the occurrence of an event.

Definition at line 281 of file nvscievent.h.

Data Fields
NvSciError(*	CreateLocalEvent )(NvSciEventService *thisEventService, NvSciLocalEvent **newLocalEvent)
	Creates an intra-process local event with an event notifier that reports each event signaled through it. More...
void(*	Delete )(NvSciEventService *thisEventService)
	Releases any resources associated with this event service. More...

Field Documentation

CreateLocalEvent

NvSciError(* NvSciEventService::CreateLocalEvent) (NvSciEventService *thisEventService, NvSciLocalEvent **newLocalEvent)

Creates an intra-process local event with an event notifier that reports each event signaled through it.

Note

This API is for internal use only.

Parameters

[in]	thisEventService	NvSciEventService object pointer created by NvSciEventLoopServiceCreateSafe().
[out]	newLocalEvent	NvSciLocalEvent object pointer on success.

Returns

NvSciError, the completion code of operations:

• NvSciError_Success Indicates a successful operation.
• NvSciError_InsufficientMemory Indicates memory is not sufficient.
• NvSciError_BadParameter Indicates an invalid input parameter.
• NvSciError_InvalidState Indicates an invalid operation state.
• NvSciError_NotPermitted Indicates incorrect API group usage.

Precondition

NvSciEventLoopServiceCreateSafe() must be called.

Usage considerations

• Allowed context for the API call
  • Interrupt: No
  • Signal handler: No
  • Thread-safe: Yes
  • Async/Sync: Sync
• Required Privileges(QNX): None
• API Group
  • Init: Yes
  • Runtime: No
  • De-Init: No

Definition at line 365 of file nvscievent.h.

Delete

void(* NvSciEventService::Delete) (NvSciEventService *thisEventService)

Releases any resources associated with this event service.

Before this member function is called, the caller must ensure that all other member function calls on thisEventService have completed and the caller must never again invoke any member functions on thisEventService.

If there any NvSciEventNotifier objects created from this event service that have not been deleted yet, the resources allocated for this event service will not necessarily be released until all those NvSciEventNotifier objects are first deleted.

There may also be implementation-specific conditions that result in a delay in the release of resources.

Release resources associated with NvSciEventService and NvSciEventService which is created by NvSciEventLoopServiceCreateSafe().

Note

This API must be called after releasing notifier and NvSciEventService is no longer required.

This API can be called in Init mode to release resources in error handling or to test functionality.

Parameters

[in]

thisEventService

NvSciEventService object pointer created by NvSciEventLoopServiceCreateSafe().

Precondition

NvSciEventLoopServiceCreateSafe() must be called.

Usage considerations

• Allowed context for the API call
  • Interrupt: No
  • Signal handler: No
  • Thread-safe: Yes
  • Async/Sync: Sync
• Required Privileges(QNX): None
• API Group
  • Init: Yes
  • Runtime: No
  • De-Init: Yes

Definition at line 426 of file nvscievent.h.

---

The documentation for this struct was generated from the following file:

• nvscievent.h