NVIDIA DRIVE OS Linux API Reference

5.1.6.1 Release
For Test and Development only

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NvSciStreamEvent Struct Reference

Detailed Description

Describes a component event.

Definition at line 241 of file nvscistream.h.

Collaboration diagram for NvSciStreamEvent:

Data Fields

NvSciStreamEventType type
 Holds the type of event. More...
 
NvSciStreamSyncAttr syncAttr
 Used with SyncAttr events. More...
 
NvSciStreamSyncDesc syncDesc
 Used with SyncDesc events. More...
 
NvSciStreamElementAttr packetAttr
 Used with PacketAttrConsumer, PacketAttrProducer, and PacketAttr. More...
 
NvSciStreamPacket packetCreate
 Used with PacketCreate events. More...
 
NvSciStreamElementDesc packetElement
 Used with PacketElement events. More...
 
NvSciStreamCookie packetCookie
 Used with PacketDelete, PacketStatus, and PacketElement events. More...
 
NvSciError error
 Used with PacketStatus and ElementStatus events. More...
 
uint32_t index
 Used with events that require an index. More...
 
uint32_t count
 Used with events that require a count. More...
 

Field Documentation

uint32_t NvSciStreamEvent::count

Used with events that require a count.

For SyncCount, indicates the number of available sync desc to be queried, as SyncDesc events, by consumer or producer.

For PacketElementCountProducer, indicates the number of elements per packet producer will provide.

For PacketElementCountConsumer, indicates the number of elements per packet consumer could accept.

For PacketElementCount, indicates the number of packet elements determined by the pool.

Definition at line 360 of file nvscistream.h.

NvSciError NvSciStreamEvent::error

Used with PacketStatus and ElementStatus events.

Provides the status code.

Definition at line 336 of file nvscistream.h.

uint32_t NvSciStreamEvent::index

Used with events that require an index.

For ElementStatus, indicates the element for which the status is provided.

Definition at line 344 of file nvscistream.h.

NvSciStreamElementAttr NvSciStreamEvent::packetAttr

Used with PacketAttrConsumer, PacketAttrProducer, and PacketAttr.

Received by pool when producer and consumer specify their packet capabilities and requirements, respectively, and by the producer and consumer when the pool specifies the final packet setup.

Components in the stream may modify the attributes specified by each endpoint before they are received by the other endpoint.

In particular, multi-cast components will combine the packet requests of all consumer(s) before sending them to the producer, and IPC components which perform a copy may replace requirements on the type of memory used with their own.

The recipient owns the memory attribute handles in the event and is responsible for freeing them when no longer needed.

Definition at line 297 of file nvscistream.h.

NvSciStreamCookie NvSciStreamEvent::packetCookie

Used with PacketDelete, PacketStatus, and PacketElement events.

Identifies the packet to which the event refers.

Definition at line 329 of file nvscistream.h.

NvSciStreamPacket NvSciStreamEvent::packetCreate

Used with PacketCreate events.

Received by producer and consumer when a packet is added to the pool.

The handle provided will be valid, and should be used whenever the component references the packet in the future.

The recipient owns the memory buffer handles in the event and is responsible for freeing them when no longer needed.

Definition at line 311 of file nvscistream.h.

NvSciStreamElementDesc NvSciStreamEvent::packetElement

Used with PacketElement events.

Received by producer and consumer.

After receiving a PacketCreate event, producer and consumer will receive [number of packet elements] PacketElement events.

The buffer belongs to the handle specified.

Definition at line 322 of file nvscistream.h.

NvSciStreamSyncAttr NvSciStreamEvent::syncAttr

Used with SyncAttr events.

Received by producer and consumer, this contains the requirements for sync objects to be usable by the other endpoint(s).

Components in the stream may modify the attributes specified by each endpoint before they are received by the other endpoint. In particular, multi-cast components combine the requirements of all consumers before sending to the producer, and IPC components may replace the sync requirements if they must copy the data.

The recipient owns the memory attribute handles in the event and is responsible for freeing them when no longer needed.

Definition at line 261 of file nvscistream.h.

NvSciStreamSyncDesc NvSciStreamEvent::syncDesc

Used with SyncDesc events.

Received by producer and consumer, this contains the description of sync objects which will be used to send fences by the other endpoint(s).

As with sync attributes, components in the stream may modify the description received by the other endpoint.

The recipient owns the memory buffer handles in the event and is responsible for freeing them when no longer needed.

Definition at line 276 of file nvscistream.h.

NvSciStreamEventType NvSciStreamEvent::type

Holds the type of event.

Definition at line 243 of file nvscistream.h.


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