Netty 5.0.0.Alpha5 · io.netty5.handler.ssl.SslClientHelloHandler

Modifier and Type	Field and Description
private Buffer	handshakeBuffer
private boolean	handshakeFailed
private static final InternalLogger	logger
private ReadBufferAllocator	pendingReadBufferAllocator
private boolean	suppressRead

Access	Constructor and Description
public	SslClientHelloHandler()

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, Buffer the `Buffer` from which to read data in) Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode. Decode the from one `Buffer` to another.
protected void	handlerRemoved0(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore.
protected abstract Future<T>	lookup(ChannelHandlerContext ctx, Buffer clientHello) Kicks off a lookup for the given `ClientHello` and returns a `Future` which in turn will notify the `onLookupComplete(ChannelHandlerContext, Future)` on completion.
protected abstract void	onLookupComplete(ChannelHandlerContext ctx, Future<? extends T> future) Called upon completion of the `lookup(ChannelHandlerContext, Buffer)` `Future`.
public void	read(ChannelHandlerContext the `ChannelHandlerContext` for which the read operation is made ctx, ReadBufferAllocator The `ReadBufferAllocator` that should be used to allocate a `Buffer` if needed (for reading the data). readBufferAllocator) Overrides default io.netty5.channel.ChannelHandler.read. Called once a read operation is made from the current registered `EventLoop`.
private void	releaseHandshakeBuffer()
private void	select(final ChannelHandlerContext ctx, Buffer clientHello)

Inherited from io.netty5.handler.codec.ByteToMessageDecoder:: actualReadableBytes channelInactive channelRead channelReadComplete channelShutdown decodeLast discardSomeReadBytes handlerAdded handlerAdded0 handlerRemoved internalBuffer isSharable isSingleDecode setSingleDecode

handshakeBuffer	back to summary
private Buffer handshakeBuffer

handshakeFailed	back to summary
private boolean handshakeFailed

logger	back to summary
private static final InternalLogger logger

pendingReadBufferAllocator	back to summary
private ReadBufferAllocator pendingReadBufferAllocator

suppressRead	back to summary
private boolean suppressRead

SslClientHelloHandler	back to summary
public SslClientHelloHandler()

Method Detail

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, Buffer in) throws Exception Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode. Doc from io.netty5.handler.codec.ByteToMessageDecoder.decode. Decode the from one `Buffer` to another. This method will be called till either the input `Buffer` has nothing to read when return from this method or till nothing was read from the input `Buffer`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to in:Buffer the `Buffer` from which to read data Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, Buffer in) throws Exception

Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode.

Doc from io.netty5.handler.codec.ByteToMessageDecoder.decode.

Decode the from one Buffer to another. This method will be called till either the input Buffer has nothing to read when return from this method or till nothing was read from the input Buffer.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
in:Buffer: the Buffer from which to read data

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

handlerRemoved0 back to summary

handlerRemoved0	back to summary
protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerRemoved0. Doc from io.netty5.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception

Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Doc from io.netty5.handler.codec.ByteToMessageDecoder.handlerRemoved0.

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

lookup back to summary

lookup	back to summary
protected abstract Future<T> lookup(ChannelHandlerContext ctx, Buffer clientHello) throws Exception Kicks off a lookup for the given `ClientHello` and returns a `Future` which in turn will notify the `onLookupComplete(ChannelHandlerContext, Future)` on completion. See https://tools.ietf.org/html/rfc5246#section-7.4.1.2 struct { ProtocolVersion client_version; Random random; SessionID session_id; CipherSuite cipher_suites<2..2^16-2>; CompressionMethod compression_methods<1..2^8-1>; select (extensions_present) { case false: struct {}; case true: Extension extensions<0..2^16-1>; }; } ClientHello; See Also `onLookupComplete(ChannelHandlerContext, Future)`

protected abstract Future<T> lookup(ChannelHandlerContext ctx, Buffer clientHello) throws Exception

Kicks off a lookup for the given ClientHello and returns a Future which in turn will notify the onLookupComplete(ChannelHandlerContext, Future) on completion. See https://tools.ietf.org/html/rfc5246#section-7.4.1.2

struct {
   ProtocolVersion client_version;
   Random random;
   SessionID session_id;
   CipherSuite cipher_suites<2..2^16-2>;
   CompressionMethod compression_methods<1..2^8-1>;
   select (extensions_present) {
       case false:
           struct {};
       case true:
           Extension extensions<0..2^16-1>;
   };
} ClientHello;

See Also: onLookupComplete(ChannelHandlerContext, Future)

onLookupComplete back to summary

onLookupComplete	back to summary
protected abstract void onLookupComplete(ChannelHandlerContext ctx, Future<? extends T> future) throws Exception Called upon completion of the `lookup(ChannelHandlerContext, Buffer)` `Future`. See Also `lookup(ChannelHandlerContext, Buffer)`

protected abstract void onLookupComplete(ChannelHandlerContext ctx, Future<? extends T> future) throws Exception

Called upon completion of the lookup(ChannelHandlerContext, Buffer) Future.

See Also: lookup(ChannelHandlerContext, Buffer)

read back to summary

read	back to summary
public void read(ChannelHandlerContext ctx, ReadBufferAllocator readBufferAllocator) Overrides default io.netty5.channel.ChannelHandler.read. Doc from io.netty5.channel.ChannelHandler.read. Called once a read operation is made from the current registered `EventLoop`. If the `ChannelHandler` implementation queues the read and another read happens it is free to drop the first `ReadBufferAllocator` and just use the last one. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the read operation is made readBufferAllocator:ReadBufferAllocator The `ReadBufferAllocator` that should be used to allocate a `Buffer` if needed (for reading the data). Annotations @Override

public void read(ChannelHandlerContext ctx, ReadBufferAllocator readBufferAllocator)

Overrides default io.netty5.channel.ChannelHandler.read.

Doc from io.netty5.channel.ChannelHandler.read.

Called once a read operation is made from the current registered EventLoop. If the ChannelHandler implementation queues the read and another read happens it is free to drop the first ReadBufferAllocator and just use the last one.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the read operation is made
readBufferAllocator:ReadBufferAllocator: The ReadBufferAllocator that should be used to allocate a Buffer if needed (for reading the data).

Annotations

@Override

releaseHandshakeBuffer	back to summary
private void releaseHandshakeBuffer()

select	back to summary
private void select(final ChannelHandlerContext ctx, Buffer clientHello)

public abstract Class SslClientHelloHandler<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail