View on GitHub
Install in Dash
ByteToMessageHandler Class Reference
ByteToMessageHandler
public final class ByteToMessageHandler<Decoder> where Decoder : ByteToMessageDecoderextension ByteToMessageHandler: ChannelInboundHandlerextension ByteToMessageHandler: RemovableChannelHandlerextension ByteToMessageHandler: ChannelOutboundHandler, _ChannelOutboundHandler where Decoder: WriteObservingByteToMessageDecoderA handler which turns a given ByteToMessageDecoder into a ChannelInboundHandler that can then be added to a
ChannelPipeline.
Most importantly, ByteToMessageHandler handles the tricky buffer management for you and flattens out all
re-entrancy on channelRead that may happen in the ChannelPipeline.
-
Declaration
Swift
public typealias InboundIn = ByteBuffer -
Declaration
Swift
public typealias InboundOut = Decoder.InboundOut -
@see: ByteToMessageHandler.init(_:maximumBufferSize)
Declaration
Swift
public convenience init(_ decoder: Decoder) -
Initialize a
ByteToMessageHandler.Declaration
Swift
public init(_ decoder: Decoder, maximumBufferSize: Int? = nil)Parameters
decoderThe
ByteToMessageDecoderto decode the bytes into message.maximumBufferSizeThe maximum number of bytes to aggregate in-memory.
-
Declaration
Swift
public func handlerAdded(context: ChannelHandlerContext) -
Declaration
Swift
public func handlerRemoved(context: ChannelHandlerContext) -
Calls
decodeuntil there is nothing left to decode.Declaration
Swift
public func channelRead(context: ChannelHandlerContext, data: NIOAny) -
Call
decodeLastbefore forward the event through the pipeline.Declaration
Swift
public func channelInactive(context: ChannelHandlerContext) -
Declaration
Swift
public func userInboundEventTriggered(context: ChannelHandlerContext, event: Any) -
Declaration
Swift
public func removeHandler(context: ChannelHandlerContext, removalToken: ChannelHandlerContext.RemovalToken)
-
Declaration
Swift
public typealias OutboundIn = Decoder.OutboundIn -
Declaration
Swift
public func write(context: ChannelHandlerContext, data: NIOAny, promise: EventLoopPromise<Void>?)