Enum SslHandler.SslEngineType

java.lang.Object

java.lang.Enum<SslHandler.SslEngineType>

io.netty.handler.ssl.SslHandler.SslEngineType

All Implemented Interfaces:

Serializable, Comparable<SslHandler.SslEngineType>

Enclosing class:

SslHandler

private static enum SslHandler.SslEngineType
extends Enum<SslHandler.SslEngineType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JDK
TCNATIVE

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ByteToMessageDecoder.Cumulator	cumulator	When using JDK SSLEngine, we use ByteToMessageDecoder.MERGE_CUMULATOR because it works only with one ByteBuffer.
(package private) final boolean	wantsDirectBuffer	true if and only if SSLEngine expects a direct buffer and so if a heap buffer is given will make an extra memory copy.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SslEngineType(boolean wantsDirectBuffer, ByteToMessageDecoder.Cumulator cumulator)

Method Summary

Modifier and Type	Method	Description
(package private) abstract ByteBuf	allocateWrapBuffer(SslHandler handler, ByteBufAllocator allocator, int pendingBytes, int numComponents)
(package private) abstract int	calculatePendingData(SslHandler handler, int guess)
(package private) abstract int	calculateRequiredOutBufSpace(SslHandler handler, int pendingBytes, int numComponents)
(package private) static SslHandler.SslEngineType	forEngine(SSLEngine engine)
(package private) abstract boolean	jdkCompatibilityMode(SSLEngine engine)
(package private) abstract SSLEngineResult	unwrap(SslHandler handler, ByteBuf in, int len, ByteBuf out)
static SslHandler.SslEngineType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SslHandler.SslEngineType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TCNATIVE

public static final SslHandler.SslEngineType TCNATIVE

JDK

public static final SslHandler.SslEngineType JDK

Field Details

wantsDirectBuffer

final boolean wantsDirectBuffer

true if and only if SSLEngine expects a direct buffer and so if a heap buffer is given will make an extra memory copy.

cumulator

final ByteToMessageDecoder.Cumulator cumulator

When using JDK SSLEngine, we use ByteToMessageDecoder.MERGE_CUMULATOR because it works only with one ByteBuffer. When using OpenSslEngine, we can use ByteToMessageDecoder.COMPOSITE_CUMULATOR because it has ReferenceCountedOpenSslEngine.unwrap(ByteBuffer[], ByteBuffer[]) which works with multiple ByteBuffers and which does not need to do extra memory copies.

Constructor Details

SslEngineType

private SslEngineType(boolean wantsDirectBuffer,
 ByteToMessageDecoder.Cumulator cumulator)

Method Details

values

public static SslHandler.SslEngineType[] values()

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

Returns:

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

valueOf

public static SslHandler.SslEngineType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

forEngine

static SslHandler.SslEngineType forEngine(SSLEngine engine)

unwrap

abstract SSLEngineResult unwrap(SslHandler handler,
 ByteBuf in,
 int len,
 ByteBuf out)
                         throws SSLException

Throws:

SSLException

calculatePendingData

abstract int calculatePendingData(SslHandler handler,
 int guess)

jdkCompatibilityMode

abstract boolean jdkCompatibilityMode(SSLEngine engine)

allocateWrapBuffer

abstract ByteBuf allocateWrapBuffer(SslHandler handler,
 ByteBufAllocator allocator,
 int pendingBytes,
 int numComponents)

calculateRequiredOutBufSpace

abstract int calculateRequiredOutBufSpace(SslHandler handler,
 int pendingBytes,
 int numComponents)