Introducing Google AI Edge Portal: Benchmark Edge AI at scale. Sign-up to request access during private preview.

litert::Event

#include <litert_event.h>

Defines the C++ wrapper for LiteRT events, used for synchronization.

Summary

Inherits from: internal::BaseHandle< LiteRtEvent >

Public types
`Type`	enum

Public static functions
`CreateFromEglSyncFence(const Environment & env, LiteRtEglSyncKhr egl_sync)`	`Expected< Event >` Creates an `Event` object from an EGL sync fence.
`CreateFromOpenClEvent(const Environment & env, LiteRtClEvent cl_event)`	`Expected< Event >` Creates an `Event` object from an OpenCL event.
`CreateFromSyncFenceFd(const Environment & env, int sync_fence_fd, bool owns_fd)`	`Expected< Event >` Creates an `Event` object from a sync fence file descriptor.
`CreateManaged(const Environment & env, Type type)`	`Expected< Event >` Creates a managed event of a given type.
`WrapCObject(const internal::EnvironmentHolder & env, LiteRtEvent event, OwnHandle owned)`	`Event`

Public functions
`DupFd()`	`Expected< int >` Returns a duplicate of the event's sync fence file descriptor.
`GetCustomNativeEvent()`	`Expected< void * >`
`GetEglSync()`	`Expected< LiteRtEglSyncKhr >`
`GetOpenClEvent()`	`Expected< LiteRtClEvent >` Returns the underlying OpenCL event if the event type is OpenCL.
`GetSyncFenceFd()`	`Expected< int >`
`IsSignaled()`	`Expected< bool >` Returns `true` if the event is signaled.
`Signal()`	`Expected< void >` Signals the event.
`Type() const`	`Type` Returns the underlying event type.
`Wait(int64_t timeout_in_ms)`	`Expected< void >` Waits for the event to be signaled.

 Type

Expected< Event > CreateFromEglSyncFence(
  const Environment & env,
  LiteRtEglSyncKhr egl_sync
)

Creates an Event object from an EGL sync fence.

Expected< Event > CreateFromOpenClEvent(
  const Environment & env,
  LiteRtClEvent cl_event
)

Creates an Event object from an OpenCL event.

Expected< Event > CreateFromSyncFenceFd(
  const Environment & env,
  int sync_fence_fd,
  bool owns_fd
)

Creates an Event object from a sync fence file descriptor.

Expected< Event > CreateManaged(
  const Environment & env,
  Type type
)

Creates a managed event of a given type.

Currently, only LiteRtEventTypeOpenCl is supported.

Event WrapCObject(
  const internal::EnvironmentHolder & env,
  LiteRtEvent event,
  OwnHandle owned
)

Expected< int > DupFd()

Returns a duplicate of the event's sync fence file descriptor.

Expected< void * > GetCustomNativeEvent()

Expected< LiteRtEglSyncKhr > GetEglSync()

Expected< LiteRtClEvent > GetOpenClEvent()

Returns the underlying OpenCL event if the event type is OpenCL.

Expected< int > GetSyncFenceFd()

Expected< bool > IsSignaled()

Returns true if the event is signaled.

Expected< void > Signal()

Signals the event.

Type Type() const

Returns the underlying event type.

Expected< void > Wait(
  int64_t timeout_in_ms
)

Waits for the event to be signaled.

Details

Parameters

timeout_in_ms

The timeout in milliseconds. A value of -1 indicates an indefinite wait.