com.spotify.protocol.client

Class Subscription<T>

java.lang.Object

com.spotify.protocol.client.PendingResultBase<T>

com.spotify.protocol.client.Subscription<T>

Type Parameters:

T - the data type of the subscription

All Implemented Interfaces:

PendingResult<T>

public class Subscription<T>
extends PendingResultBase<T>

Track a subscription for data of type T Set callbacks for events and subscription lifecycle. Stop subscription with cancel()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Subscription.EventCallback<T>
static interface	Subscription.LifecycleCallback

Constructor Summary

Constructors

Constructor and Description
Subscription(Types.RequestId requestId, RemoteClient remoteWampClient)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this PendingResultBase to stop receiving callbacks.
Types.RequestId	getRequestId()
Subscription<T>	setEventCallback(Subscription.EventCallback<T> eventCallback) Set callback called every time a new event is received on the Subscription
Subscription<T>	setLifecycleCallback(Subscription.LifecycleCallback lifecycleCallback) Set callback called when subscription starts and ends

Methods inherited from class com.spotify.protocol.client.PendingResultBase

await, await, deliverError, deliverResult, isCanceled, setErrorCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscription

public Subscription(Types.RequestId requestId,
                    RemoteClient remoteWampClient)

Method Detail

cancel

public void cancel()

Description copied from class: PendingResultBase

Cancel this PendingResultBase to stop receiving callbacks.

Specified by:

cancel in interface PendingResult<T>

Overrides:

cancel in class PendingResultBase<T>

getRequestId

public Types.RequestId getRequestId()

setEventCallback

public Subscription<T> setEventCallback(Subscription.EventCallback<T> eventCallback)

Set callback called every time a new event is received on the Subscription

Parameters:

eventCallback - the callback to receive events on

Returns:

itself to enable chaining of operations

setLifecycleCallback

public Subscription<T> setLifecycleCallback(Subscription.LifecycleCallback lifecycleCallback)

Set callback called when subscription starts and ends

Parameters:

lifecycleCallback - the callback to receive events on

Returns:

itself to enable chaining of operations