redis.clients.jedis

Class PushConsumerChainImpl

java.lang.Object

redis.clients.jedis.PushConsumerChainImpl

All Implemented Interfaces:

PushConsumerChain

@Experimental
public final class PushConsumerChainImpl
extends java.lang.Object
implements PushConsumerChain

A chain of PushConsumers that processes events in order.

Uses a PushConsumerContext object for tracking the processed state.

Field Summary

Fields

Modifier and Type	Field and Description
static PushConsumer	PUBSUB_CONSUMER PushConsumer that marks pub/sub related events to be propagated to the caller.

Method Summary

Modifier and Type	Method and Description
PushConsumerChain	add(PushConsumer consumer) Add a consumer to the end of the chain.
java.util.List<PushConsumer>	getConsumers() Return an unmodifiable list of consumers in the chain.
static PushConsumerChainImpl	of(PushConsumer... consumers) Create a chain with the specified consumers.
PushMessage	process(PushMessage message) Process the push message Returning null means the message was consumed.

Methods inherited from class java.lang.Object

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

Field Detail

PUBSUB_CONSUMER

public static final PushConsumer PUBSUB_CONSUMER

PushConsumer that marks pub/sub related events to be propagated to the caller.

NOTE: If a new pub/sub push type is added to PushMessageTypes, the switch in isPubSubType(byte[]) must be updated. PushConsumerChainImplTest discovers pub/sub constants reflectively and will fail until the new type is handled here.

Method Detail

of

public static PushConsumerChainImpl of(PushConsumer... consumers)

Create a chain with the specified consumers.

Parameters:

consumers - The consumers to add to the chain

Returns:

A new consumer chain with the specified consumers

add

public PushConsumerChain add(PushConsumer consumer)

Add a consumer to the end of the chain.

Parameters:

consumer - The consumer to add

Returns:

this chain for method chaining

getConsumers

public java.util.List<PushConsumer> getConsumers()

Return an unmodifiable list of consumers in the chain.

Specified by:

getConsumers in interface PushConsumerChain

Returns:

list of consumers in the chain

process

public PushMessage process(PushMessage message)

Description copied from interface: PushConsumerChain

Process the push message

Returning null means the message was consumed.

Specified by:

process in interface PushConsumerChain

Parameters:

message - message to process

Returns:

message, or null if the message was consumed