t_timing_event_source Interface Reference

A time sync source is a component that generates timing events for an t_timing_event_sink to consume. More...

#include <tracking/t_time_sync.h>

Collaboration diagram for t_timing_event_source:

Static Public Member Functions
static XRT_NONNULL_ALL int	t_timing_event_source_add_sink (struct t_timing_event_source *source, struct t_timing_event_sink *sink)
	Helper function for t_timing_event_source::add_sink.
static XRT_NONNULL_ALL void	t_timing_event_source_remove_sink (struct t_timing_event_source *source, struct t_timing_event_sink *sink)
	Helper function for t_timing_event_source::remove_sink.

Data Fields
int(*	add_sink )(struct t_timing_event_source *source, struct t_timing_event_sink *sink)
	Adds an event sink to this source.
void(*	remove_sink )(struct t_timing_event_source *source, struct t_timing_event_sink *sink)
	Removes an event sink from this source.

Detailed Description

A time sync source is a component that generates timing events for an t_timing_event_sink to consume.

Objects implementing t_timing_event_source should likely also implement xrt_frame_node and live within the lifetime of an xrt_frame_context.

Member Function Documentation

t_timing_event_source_add_sink()

static XRT_NONNULL_ALL int t_timing_event_source_add_sink ( struct t_timing_event_source *  source, struct t_timing_event_sink *  sink  )

inlinestatic

Helper function for t_timing_event_source::add_sink.

Adds an event sink to this source.

Parameters

source	The source to add the sink to.
sink	The sink to add to the source.

Returns

0 on success, or a negative value on failure (for example, the source is full).

References add_sink.

t_timing_event_source_remove_sink()

static XRT_NONNULL_ALL void t_timing_event_source_remove_sink ( struct t_timing_event_source *  source, struct t_timing_event_sink *  sink  )

inlinestatic

Helper function for t_timing_event_source::remove_sink.

Removes an event sink from this source.

Parameters

source	The source to remove the sink from.
sink	The sink to remove from the source.

References remove_sink.

Field Documentation

add_sink

int(* t_timing_event_source::add_sink) (struct t_timing_event_source *source, struct t_timing_event_sink *sink)

Adds an event sink to this source.

Parameters

source	The source to add the sink to.
sink	The sink to add to the source.

Returns

0 on success, or a negative value on failure (for example, the source is full).

Referenced by t_timing_event_source_add_sink().

remove_sink

void(* t_timing_event_source::remove_sink) (struct t_timing_event_source *source, struct t_timing_event_sink *sink)

Removes an event sink from this source.

Parameters

source	The source to remove the sink from.
sink	The sink to remove from the source.

Referenced by t_timing_event_source_remove_sink().

---

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

• tracking/t_time_sync.h