NvSciLocalEvent Struct Reference

Detailed Description

An OS-agnostic object that sends signal to another thread in the same process.

Definition at line 175 of file nvscievent.h.

Collaboration diagram for NvSciLocalEvent:

Data Fields
NvSciEventNotifier *	eventNotifier
	Event notifier associated with this local event. More...
NvSciError(*	Signal )(NvSciLocalEvent *thisLocalEvent)
	Sends an intra-process local event signal. More...
void(*	Delete )(NvSciLocalEvent *thisLocalEvent)
	Releases any resources associated with this local event. More...

Field Documentation

Delete

void(* NvSciLocalEvent::Delete) (NvSciLocalEvent *thisLocalEvent)

Releases any resources associated with this local event.

This function must be called after releasing notifier and when NvSciLocalEvent is no longer required.

Note

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

Parameters

[in]

thisLocalEvent

NvSciLocalEvent object pointer created by NvSciEventService::CreateLocalEvent().

Returns

void

Precondition

NvSciEventService::CreateLocalEvent() must be called.

Usage considerations

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

Definition at line 238 of file nvscievent.h.

eventNotifier

NvSciEventNotifier* NvSciLocalEvent::eventNotifier

Event notifier associated with this local event.

Definition at line 177 of file nvscievent.h.

Signal

NvSciError(* NvSciLocalEvent::Signal) (NvSciLocalEvent *thisLocalEvent)

Sends an intra-process local event signal.

Any thread which is blocked by local event notifier associated with local event will be unblocked by this signal.

Parameters

[in]

thisLocalEvent

NvSciLocalEvent object pointer created by NvSciEventService::CreateLocalEvent()

Returns

NvSciError, the completion code of operations:

• NvSciError_Success Indicates a successful operation.
• NvSciError_BadParameter Indicates an invalid input parameter.
• NvSciError_TryItAgain Indicates an kernel pulse queue shortage.
• NvSciError_InvalidState Indicates an invalid operation state.

Precondition

NvSciEventService::CreateLocalEvent() must be called.

Usage considerations

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

Definition at line 208 of file nvscievent.h.

---

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

• nvscievent.h