org.freedesktop.gstreamer

Class Promise

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.MiniObject

org.freedesktop.gstreamer.Promise

All Implemented Interfaces:

AutoCloseable

@Gst.Since(minor=14)
public class Promise
extends MiniObject

A miniobject for future/promise-like functionality

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstPromise.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Promise.PROMISE_CHANGE Called whenever the state of the promise is changed from PENDING to any other PromiseResult

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.MiniObject

MiniObject.Handle

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GTYPE_NAME

Constructor Summary

Constructors

Constructor and Description
Promise() Creates a new instance of promise
Promise(Promise.PROMISE_CHANGE listener) Creates a new instance of promise with a callback attached.

Method Summary

Modifier and Type	Method and Description
void	expire() Expire a promise.
Structure	getReply() Retrieve the reply set on the promise.
void	interrupt() Interrupt waiting for the result of the promise.
void	reply(Structure structure) Set a reply on the promise.
PromiseResult	waitResult() Wait for the promise to move out of the PENDING PromiseResult state.

Methods inherited from class org.freedesktop.gstreamer.MiniObject

copy, getRefCount, isWritable, makeWritable

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, dispose, equals, getPointer, getRawPointer, hashCode, invalidate, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Constructor Detail

Promise

public Promise()

Creates a new instance of promise

Promise

public Promise(Promise.PROMISE_CHANGE listener)

Creates a new instance of promise with a callback attached.

Parameters:

listener - Listener to be called whenever the state of a Promise is changed

Method Detail

waitResult

public PromiseResult waitResult()

Wait for the promise to move out of the PENDING PromiseResult state. If the promise is not in PENDING then it will immediately return.

Returns:

the PromiseResult of the promise.

reply

public void reply(Structure structure)

Set a reply on the promise. Will wake up any waiters on the promise with the REPLIED PromiseResult state. If the promise has already been interrupted than the replied will not be visible to any waiters

Parameters:

structure - the Structure to reply the promise with, caller should not use this structure afterward as it is invalidated through NativeObject.invalidate()

interrupt

public void interrupt()

Interrupt waiting for the result of the promise. Any waiters on the promise will receive the INTERRUPTED PromiseResult state.

expire

public void expire()

Expire a promise. Any waiters on the promise will received the EXPIRED PromiseResult state.

getReply

public Structure getReply()

Retrieve the reply set on the promise. The state of the promise must be in the REPLIED PromiseResult state. The return structure is owned by the promise and thus cannot be modified.

Returns:

the Structure set on the promise reply.