Struct gstreamer::Task

#[repr(transparent)]
pub struct Task { /* private fields */ }

Task is used by Element and Pad to provide the data passing threads in a Pipeline.

A Pad will typically start a Task to push or pull data to/from the peer pads. Most source elements start a Task to push data. In some cases a demuxer element can start a Task to pull data from a peer element. This is typically done when the demuxer can perform random access on the upstream peer element for improved performance.

Although convenience functions exist on Pad to start/pause/stop tasks, it might sometimes be needed to create a Task manually if it is not related to a Pad.

Before the Task can be run, it needs a GRecMutex that can be set with [TaskExtManual::set_lock()][crate::prelude::TaskExtManual::set_lock()].

The task can be started, paused and stopped with TaskExt::start(), TaskExt::pause() and TaskExt::stop() respectively or with the TaskExt::set_state() function.

A Task will repeatedly call the GstTaskFunction with the user data that was provided when creating the task with [new()][Self::new()]. While calling the function it will acquire the provided lock. The provided lock is released when the task pauses or stops.

Stopping a task with TaskExt::stop() will not immediately make sure the task is not running anymore. Use TaskExt::join() to make sure the task is completely stopped and the thread is stopped.

After creating a Task, use gst_object_unref() to free its resources. This can only be done when the task is not running anymore.

Task functions can send a Message to send out-of-band data to the application. The application can receive messages from the Bus in its mainloop.

For debugging purposes, the task will configure its object name as the thread name on Linux. Please note that the object name should be configured before the task is started; changing the object name after the task has been started, has no effect on the thread name.

Implements

TaskExt, GstObjectExt, glib::ObjectExt

Implementations

impl Task

pub const NONE: Option<&'static Task> = None

pub fn cleanup_all()

Wait for all tasks to be stopped. This is mainly used internally to ensure proper cleanup of internal data structures in test suites.

MT safe.

impl Task

pub fn builder<F: FnMut(&Task) + Send + 'static>(func: F) -> TaskBuilder<F>

Trait Implementations

impl Clone for Task

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Task

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Task

type ParamSpec = ParamSpecObject

type SetValue = Task

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Task>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Task

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Task

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Task

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Task

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Task

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Task

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Task

impl IsA<Object> for Task

impl Send for Task

impl Sync for Task