Class ProtocolDetectionResult<T>

java.lang.Object

io.netty.handler.codec.ProtocolDetectionResult<T>

Type Parameters:

T - the type of the protocol

public final class ProtocolDetectionResult<T>
extends Object

Result of detecting a protocol.

Field Summary

Fields

Modifier and Type	Field	Description
private static final ProtocolDetectionResult	INVALID
private static final ProtocolDetectionResult	NEEDS_MORE_DATA
private final T	result
private final ProtocolDetectionState	state

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ProtocolDetectionResult(ProtocolDetectionState state, T result)

Method Summary

Modifier and Type	Method	Description
static <T> ProtocolDetectionResult<T>	detected(T protocol)	Returns a ProtocolDetectionResult which holds the detected protocol.
T	detectedProtocol()	Returns the protocol if state() returns ProtocolDetectionState.DETECTED, otherwise null.
static <T> ProtocolDetectionResult<T>	invalid()	Returns a ProtocolDetectionResult that signals the data was invalid for the protocol.
static <T> ProtocolDetectionResult<T>	needsMoreData()	Returns a ProtocolDetectionResult that signals that more data is needed to detect the protocol.
ProtocolDetectionState	state()	Return the ProtocolDetectionState.

Methods inherited from class Object

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

Field Details

NEEDS_MORE_DATA

private static final ProtocolDetectionResult NEEDS_MORE_DATA

INVALID

private static final ProtocolDetectionResult INVALID

state

private final ProtocolDetectionState state

result

private final T result

Constructor Details

ProtocolDetectionResult

private ProtocolDetectionResult(ProtocolDetectionState state,
 T result)

Method Details

needsMoreData

public static <T> ProtocolDetectionResult<T> needsMoreData()

Returns a ProtocolDetectionResult that signals that more data is needed to detect the protocol.

invalid

public static <T> ProtocolDetectionResult<T> invalid()

Returns a ProtocolDetectionResult that signals the data was invalid for the protocol.

detected

public static <T> ProtocolDetectionResult<T> detected(T protocol)

Returns a ProtocolDetectionResult which holds the detected protocol.

state

public ProtocolDetectionState state()

Return the ProtocolDetectionState. If the state is ProtocolDetectionState.DETECTED you can retrieve the protocol via detectedProtocol().

detectedProtocol

public T detectedProtocol()

Returns the protocol if state() returns ProtocolDetectionState.DETECTED, otherwise null.