ByteToMessageHandler
A handler which turns a given ByteToMessageDecoder into a ChannelInboundHandler that can then be added to a ChannelPipeline.
final class ByteToMessageHandler<Decoder> where Decoder : ByteToMessageDecoderMost importantly, ByteToMessageHandler handles the tricky buffer management for you and flattens out all re-entrancy on channelRead that may happen in the ChannelPipeline.
See also
protocol ByteToMessageDecoderByteToMessageDecoders decode bytes in a stream-like fashion fromByteBufferto another message type.protocol WriteObservingByteToMessageDecoderSome
ByteToMessageDecoders need to observewrites (which are outbound events).ByteToMessageDecoders which implement theWriteObservingByteToMessageDecoderprotocol will be notified about every outbound write.enum DecodingStateState of the current decoding process.
protocol NIOSingleStepByteToMessageDecoderA simplified version of
ByteToMessageDecoderthat can generate zero or one messages for each invocation ofdecodeordecodeLast. HavingdecodeanddecodeLastreturn an optional message avoids re-entrancy problems, since the functions relinquish exclusive access to theByteBufferwhen returning. This allows for greatly simplified processing.class NIOSingleStepByteToMessageProcessor<Decoder>NIOSingleStepByteToMessageProcessoruses aNIOSingleStepByteToMessageDecoderto produce messages from a stream of incoming bytes. It works likeByteToMessageHandlerbut may be used outside of the channel pipeline. This allows processing of wrapped protocols in a general way.protocol MessageToByteEncoderA protocol for straightforward encoders which encode custom messages to
ByteBuffers. To add aMessageToByteEncoderto aChannelPipeline, usechannel.pipeline.addHandler(MessageToByteHandler(myEncoder).class MessageToByteHandler<Encoder>A handler which turns a given
MessageToByteEncoderinto aChannelOutboundHandlerthat can then be added to aChannelPipeline.
Citizens in NIOCore
Typealiases
Type members
init(Decoder) init(Decoder, maximumBufferSize: Int?) Initialize a
ByteToMessageHandler.
Citizens in NIOCore
where Decoder:ByteToMessageDecoderConformances
protocol ChannelHandlerBase protocol for handlers that handle I/O events or intercept an I/O operation.
protocol ChannelInboundHandlerChannelHandlerwhich handles inbound I/O events for aChannel.protocol RemovableChannelHandlerA
RemovableChannelHandleris aChannelHandlerthat can be dynamically removed from aChannelPipelinewhilst theChannelis operating normally. ARemovableChannelHandleris required to remove itself from theChannelPipeline(usingChannelHandlerContext.leavePipeline) as soon as possible.
Show implementation details (2)
Hide implementation details
protocol _ChannelInboundHandlerUntyped
ChannelHandlerwhich handles inbound I/O events.protocol _EmittingChannelHandlerChannelHandler which will emit data by calling
ChannelHandlerContext.write.
Instance members
func channelInactive(context: ChannelHandlerContext) Call
decodeLastbefore forward the event through the pipeline.func channelRead(context: ChannelHandlerContext, data: NIOAny) Calls
decodeuntil there is nothing left to decode.func handlerAdded(context: ChannelHandlerContext) func handlerRemoved(context: ChannelHandlerContext) func removeHandler(context: ChannelHandlerContext, removalToken: ChannelHandlerContext.RemovalToken) func userInboundEventTriggered(context: ChannelHandlerContext, event: Any)
Instance features
func channelActive(context: ChannelHandlerContext) func channelReadComplete(context: ChannelHandlerContext) func channelRegistered(context: ChannelHandlerContext) func channelUnregistered(context: ChannelHandlerContext) func channelWritabilityChanged(context: ChannelHandlerContext) func errorCaught(context: ChannelHandlerContext, error: Error) func unwrapInboundIn(NIOAny) -> InboundIn func wrapInboundOut(InboundOut) -> NIOAny func wrapOutboundOut(OutboundOut) -> NIOAny
Citizens in NIOCore
where Decoder:WriteObservingByteToMessageDecoderConformances
protocol ChannelOutboundHandlerChannelHandlerwhich handles outbound I/O events or intercept an outbound I/O operation for aChannel.
Show implementation details (1)
Hide implementation details
protocol _ChannelOutboundHandlerUntyped
ChannelHandlerwhich handles outbound I/O events or intercept an outbound I/O operation.
Typealiases
Instance members
Instance features
func bind(context: ChannelHandlerContext, to: SocketAddress, promise: EventLoopPromise<Void>?) func close(context: ChannelHandlerContext, mode: CloseMode, promise: EventLoopPromise<Void>?) func connect(context: ChannelHandlerContext, to: SocketAddress, promise: EventLoopPromise<Void>?) func flush(context: ChannelHandlerContext) func read(context: ChannelHandlerContext) func register(context: ChannelHandlerContext, promise: EventLoopPromise<Void>?) func triggerUserOutboundEvent(context: ChannelHandlerContext, event: Any, promise: EventLoopPromise<Void>?) func unwrapOutboundIn(NIOAny) -> OutboundIn func write(context: ChannelHandlerContext, data: NIOAny, promise: EventLoopPromise<Void>?)