Class Subscription<T extends Serializable>

java.lang.Object

co.yellowdog.platform.clients.serversentevents.Subscription<T>

All Implemented Interfaces:

SubscriptionEventListener<T>, AutoCloseable, EventListener

public class Subscription<T extends Serializable>
extends Object
implements AutoCloseable, SubscriptionEventListener<T>

Manages multiple listeners subscribing to the same logical instance of T (as opposed to specific object instance in memory).

Method Summary

Modifier and Type	Method	Description
void	close()
String	getId()
void	join()
static <T extends Serializable> Subscription<T>	subscribeTo(SubscriptionEventListener<T> listener, Function<SubscriptionEventListener<T>,CompletableFuture<?>> producer)
void	subscriptionCancelled()	Invoked if the server cancels the subscription associated with this listener
void	subscriptionError(Throwable error)	Invoked if an error occurs on the subscription associated with this listener.
void	updated(T data)	Invoked when an updated instance of the object is received from YellowDog Platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

subscribeTo

public static <T extends Serializable>
Subscription<T> subscribeTo(SubscriptionEventListener<T> listener,
 Function<SubscriptionEventListener<T>,CompletableFuture<?>> producer)

close

public void close()

Specified by:

close in interface AutoCloseable

join

public void join()

updated

public void updated(T data)

Description copied from interface: SubscriptionEventListener

Invoked when an updated instance of the object is received from YellowDog Platform.

Specified by:

updated in interface SubscriptionEventListener<T extends Serializable>

Parameters:

data - an updated instance of the object for which the listener was registered

subscriptionError

public void subscriptionError(Throwable error)

Description copied from interface: SubscriptionEventListener

Invoked if an error occurs on the subscription associated with this listener.

Specified by:

subscriptionError in interface SubscriptionEventListener<T extends Serializable>

Parameters:

error - the error that occurred

subscriptionCancelled

public void subscriptionCancelled()

Description copied from interface: SubscriptionEventListener

Invoked if the server cancels the subscription associated with this listener

Specified by:

subscriptionCancelled in interface SubscriptionEventListener<T extends Serializable>

getId

public String getId()