Package com.apollographql.apollo.internal.subscription

Class RealSubscriptionManager

java.lang.Object

com.apollographql.apollo.internal.subscription.RealSubscriptionManager

All Implemented Interfaces:

SubscriptionManager

public final class RealSubscriptionManager
extends java.lang.Object
implements SubscriptionManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.apollographql.apollo.internal.subscription.SubscriptionManager

SubscriptionManager.Callback<T>

Constructor Summary

Constructors

Constructor

Description

RealSubscriptionManager(com.apollographql.apollo.api.ScalarTypeAdapters scalarTypeAdapters, SubscriptionTransport.Factory transportFactory, SubscriptionConnectionParamsProvider connectionParams, java.util.concurrent.Executor dispatcher, long connectionHeartbeatTimeoutMs, kotlin.jvm.functions.Function0<com.apollographql.apollo.cache.normalized.internal.ResponseNormalizer<java.util.Map<java.lang.String,java.lang.Object>>> responseNormalizer, boolean autoPersistSubscription)

Method Summary

Modifier and Type	Method	Description
void	addOnStateChangeListener(OnSubscriptionManagerStateChangeListener onStateChangeListener)	Adds new listener for subscription manager state changes.
SubscriptionManagerState	getState()	Returns the current state of subscription manager.
void	reconnect()	Reconnect the web socket.
void	removeOnStateChangeListener(OnSubscriptionManagerStateChangeListener onStateChangeListener)	Removes listener for subscription manager state changes.
void	start()	Set the RealSubscriptionManager to a connectible state.
void	stop()	Unsubscribe from all active subscriptions, and disconnect the web socket.
<T> void	subscribe(com.apollographql.apollo.api.Subscription<?,T,?> subscription, SubscriptionManager.Callback<T> callback)	Starts provided subscription.
void	unsubscribe(com.apollographql.apollo.api.Subscription subscription)	Stops provided subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealSubscriptionManager

public RealSubscriptionManager(@NotNull
                               com.apollographql.apollo.api.ScalarTypeAdapters scalarTypeAdapters,
                               @NotNull
                               SubscriptionTransport.Factory transportFactory,
                               @NotNull
                               SubscriptionConnectionParamsProvider connectionParams,
                               @NotNull
                               java.util.concurrent.Executor dispatcher,
                               long connectionHeartbeatTimeoutMs,
                               @NotNull
                               kotlin.jvm.functions.Function0<com.apollographql.apollo.cache.normalized.internal.ResponseNormalizer<java.util.Map<java.lang.String,java.lang.Object>>> responseNormalizer,
                               boolean autoPersistSubscription)

Method Detail

subscribe

public <T> void subscribe(@NotNull
                          com.apollographql.apollo.api.Subscription<?,T,?> subscription,
                          @NotNull
                          SubscriptionManager.Callback<T> callback)

Description copied from interface: SubscriptionManager

Starts provided subscription. Establishes connection to the subscription server if it was previously disconnected.

Specified by:

subscribe in interface SubscriptionManager

Parameters:

subscription - to start

callback - to be called on result

unsubscribe

public void unsubscribe(@NotNull
                        com.apollographql.apollo.api.Subscription subscription)

Description copied from interface: SubscriptionManager

Stops provided subscription. If there are no active subscriptions left, disconnects from the subscription server.

Specified by:

unsubscribe in interface SubscriptionManager

Parameters:

subscription - to stop

start

public void start()

Set the RealSubscriptionManager to a connectible state. It is safe to call this method at any time. Does nothing unless we are in the stopped state.

Specified by:

start in interface SubscriptionManager

stop

public void stop()

Unsubscribe from all active subscriptions, and disconnect the web socket. It will not be possible to add new subscriptions while the SubscriptionManager is stopping because we check the state in doSubscribe(Subscription, Callback). We pass true to disconnect(boolean) because we want to disconnect even if, somehow, a new subscription is added while or after we are doing the doUnsubscribe(Subscription) loop.

Specified by:

stop in interface SubscriptionManager

getState

public SubscriptionManagerState getState()

Description copied from interface: SubscriptionManager

Returns the current state of subscription manager.

Specified by:

getState in interface SubscriptionManager

Returns:

current state

addOnStateChangeListener

public void addOnStateChangeListener(@NotNull
                                     OnSubscriptionManagerStateChangeListener onStateChangeListener)

Description copied from interface: SubscriptionManager

Adds new listener for subscription manager state changes.

Specified by:

addOnStateChangeListener in interface SubscriptionManager

Parameters:

onStateChangeListener - to be called when state changed

removeOnStateChangeListener

public void removeOnStateChangeListener(@NotNull
                                        OnSubscriptionManagerStateChangeListener onStateChangeListener)

Description copied from interface: SubscriptionManager

Removes listener for subscription manager state changes.

Specified by:

removeOnStateChangeListener in interface SubscriptionManager

Parameters:

onStateChangeListener - to remove

reconnect

public void reconnect()

Description copied from interface: SubscriptionManager

Reconnect the web socket. Use this together with SubscriptionConnectionParamsProvider if you need to update connectionParams.

Specified by:

reconnect in interface SubscriptionManager