Package glide.api.models.configuration

Class BaseSubscriptionConfiguration

java.lang.Object

glide.api.models.configuration.BaseSubscriptionConfiguration

Direct Known Subclasses:

ClusterSubscriptionConfiguration, StandaloneSubscriptionConfiguration

public abstract class BaseSubscriptionConfiguration
extends java.lang.Object

Client subscription configuration. Could be either StandaloneSubscriptionConfiguration or ClusterSubscriptionConfiguration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseSubscriptionConfiguration.BaseSubscriptionConfigurationBuilder<B extends BaseSubscriptionConfiguration.BaseSubscriptionConfigurationBuilder<B,C>,C extends BaseSubscriptionConfiguration>	Superclass for ClusterSubscriptionConfiguration.ClusterSubscriptionConfigurationBuilder and for StandaloneSubscriptionConfiguration.StandaloneSubscriptionConfigurationBuilder.
static interface	BaseSubscriptionConfiguration.ChannelMode	A channel subscription mode.
static interface	BaseSubscriptionConfiguration.MessageCallback	Callback called for every incoming message.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Optional<BaseSubscriptionConfiguration.MessageCallback>	callback	Optional callback to accept the incoming messages.
protected java.util.Optional<java.lang.Object>	context	Optional arbitrary context, which will be passed to callback along with all received messages.

Constructor Summary

Constructors

Constructor	Description
BaseSubscriptionConfiguration(java.util.Optional<BaseSubscriptionConfiguration.MessageCallback> callback, java.util.Optional<java.lang.Object> context)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<BaseSubscriptionConfiguration.MessageCallback>	getCallback()	Optional callback to accept the incoming messages.
java.util.Optional<java.lang.Object>	getContext()	Optional arbitrary context, which will be passed to callback along with all received messages.

Methods inherited from class java.lang.Object

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

Field Detail

callback

protected final java.util.Optional<BaseSubscriptionConfiguration.MessageCallback> callback

Optional callback to accept the incoming messages. See BaseSubscriptionConfiguration.MessageCallback.
If not set, messages will be available via BaseClient.tryGetPubSubMessage() or BaseClient.getPubSubMessage().

context

protected final java.util.Optional<java.lang.Object> context

Optional arbitrary context, which will be passed to callback along with all received messages.
Could be used to distinguish clients if multiple clients use a shared callback.

Constructor Detail

BaseSubscriptionConfiguration

public BaseSubscriptionConfiguration(java.util.Optional<BaseSubscriptionConfiguration.MessageCallback> callback,
                                     java.util.Optional<java.lang.Object> context)

Method Detail

getCallback

public java.util.Optional<BaseSubscriptionConfiguration.MessageCallback> getCallback()

Optional callback to accept the incoming messages. See BaseSubscriptionConfiguration.MessageCallback.
If not set, messages will be available via BaseClient.tryGetPubSubMessage() or BaseClient.getPubSubMessage().

getContext

public java.util.Optional<java.lang.Object> getContext()

Optional arbitrary context, which will be passed to callback along with all received messages.
Could be used to distinguish clients if multiple clients use a shared callback.