dabef818d3
Motivation: An index page ties all the other documentation together Modifications: Add index pages for the library targets. Correct a few minor errors in the main docs. Result: A more joined up documentation experience.
1.6 KiB
NIOExtras
A collection of helpful utilities to assist in building and debugging Swift-NIO based applications.
Overview
A collection of helpful utilities to assist in building and debugging Swift-NIO based applications. Topics covered include packet capture, the logging of channel pipeline events, frame decoding of various common forms and helpful data types.
Debugging aids include ChannelHandlers to log channel pipeline events both inbound and outbound; and a ChannelHandler to log data in packet capture format.
To support encoding and decoding helpers are provided for data frames which have fixed length; are new line terminated; contain a length prefix; or are defined by a context-length header.
To help simplify building a robust pipeline the ServerQuiescingHelper makes it easy to collect all child Channels that a given server Channel accepts.
Easy request response flows can be built using the RequestResponseHandler which takes a request and a promise which is fulfilled when an expected response is received.
Topics
Debugging Aids
DebugInboundEventsHandlerDebugOutboundEventsHandlerNIOWritePCAPHandlerNIOPCAPRingBuffer
Encoding and Decoding
FixedLengthFrameDecoderNIOJSONRPCFramingLengthFieldBasedFrameDecoderNIOLengthFieldBasedFrameDecoderErrorLengthFieldPrependerLengthFieldPrependerErrorLineBasedFrameDecoderNIOExtrasErrorsNIOExtrasError
Channel Pipeline Aids
ServerQuiescingHelperRequestResponseHandler
Data Types
NIOLengthFieldBitLength