redis.clients.jedis

Class PushConsumerContext

java.lang.Object

redis.clients.jedis.PushConsumerContext

@Experimental
public class PushConsumerContext
extends java.lang.Object

Context object for push message processing.

Used by PushConsumerChainImpl to inspect and control message processing. The PushConsumerContext object is created for each push message and passed to all registered PushConsumer's.

Consumers can inspect the message and decide weather to :

• return to the caller and skip the rest of consumers by calling propagate()
• drop message without processing it further by calling drop() to
• inspect and let it be processed by following consumers

Constructor Summary

Constructors

Constructor and Description
PushConsumerContext(PushMessage message)

Method Summary

Modifier and Type	Method and Description
void	drop() Set whether the message should be dropped, it is not returned to caller or passed to following consumers.
PushMessage	getMessage() Get the push message being processed.
void	propagate() Set whether the message should be returned to the caller.
boolean	shouldDrop() Check if the message should be dropped and not processed further.
boolean	shouldPropagate() Check if the message should be returned to the caller.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushConsumerContext

public PushConsumerContext(PushMessage message)

Method Detail

getMessage

public PushMessage getMessage()

Get the push message being processed.

Returns:

The push message

shouldPropagate

public boolean shouldPropagate()

Check if the message should be returned to the caller.

Returns:

true if the message should be returned to the caller

propagate

public void propagate()

Set whether the message should be returned to the caller. By default, if no consumer sets this flag, the message will not be returned to the caller and will be silently consumed.

drop

public void drop()

Set whether the message should be dropped, it is not returned to caller or passed to following consumers.

shouldDrop

public boolean shouldDrop()

Check if the message should be dropped and not processed further.

Returns:

true if the message should be dropped