Package com.linecorp.armeria.common.stream

Enum Class SubscriptionOption

java.lang.Object

java.lang.Enum<SubscriptionOption>

com.linecorp.armeria.common.stream.SubscriptionOption

All Implemented Interfaces:

Serializable, Comparable<SubscriptionOption>, Constable

public enum SubscriptionOption
extends Enum<SubscriptionOption>

Options used when subscribing to a StreamMessage.

See Also:

• StreamMessage.subscribe(Subscriber, SubscriptionOption...)
• StreamMessage.subscribe(Subscriber, EventExecutor, SubscriptionOption...)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOTIFY_CANCELLATION	To get notified by Subscriber.onError(Throwable) even when the StreamMessage is cancelled.
WITH_POOLED_OBJECTS	(Advanced users only) To receive the pooled HttpData as is, without making a copy.

Method Summary

Modifier and Type	Method	Description
static SubscriptionOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SubscriptionOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOTIFY_CANCELLATION

public static final SubscriptionOption NOTIFY_CANCELLATION

To get notified by Subscriber.onError(Throwable) even when the StreamMessage is cancelled.

WITH_POOLED_OBJECTS

@UnstableApi
public static final SubscriptionOption WITH_POOLED_OBJECTS

(Advanced users only) To receive the pooled HttpData as is, without making a copy. If you don't know what this means, do not specify this when you subscribe the StreamMessage.

See Also:

• PooledObjects

Method Details

values

public static SubscriptionOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SubscriptionOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null