controller
A Controller is a Connection handler that is designed to work with connections involving decoding raw bytes into input messages and encoding output messages into bytes.
Wraps 2 sinks and will automatically begin reading from the second only when the first is empty.
Wraps 2 sinks and will automatically begin reading from the second only when
the first is empty. The None from the first sink is never exposed. The
first error reported from either sink is propagated.
A pipe designed to accept a fixed number of bytes
A pipe designed to accept a fixed number of bytes
BE AWARE: when pushing buffers into this pipe, if the pipe completes, the buffer may still contain unread data meant for another consumer
The InputController maintains all state dealing with reading in messages in a controller.
The InputController maintains all state dealing with reading in messages in a controller. It handles decoding messages and properly routing data into stream
When pushing data into a stream, the controller has some very specific behavior regarding the PushResult from the stream. - Terminating the stream at any point kills the connection - Closing a stream outside of a pull callback will kill the connection without logging the error - Closing a stream inside of a pull callback will complete the stream and the controller will resset
This is thrown anytime we hit a state that shouldn't be possible.
This is thrown anytime we hit a state that shouldn't be possible. If this is ever thrown, there is a bug!
The base trait inherited by both InputController and OutputController and ultimately implemented by Controller.
The base trait inherited by both InputController and OutputController and ultimately implemented by Controller. This merely contains methods needed by both input and output controller
The OutputController maintains all state dealing with writing messages in a controller.
The OutputController maintains all state dealing with writing messages in a controller. It maintains a queue of messages pending write and properly handles writing both regular messages as well as streams.
An ADT representing the result of a pushing a message to write
A Pipe is a callback-based data transport abstraction meant for handling streams.
A Pipe is a callback-based data transport abstraction meant for handling streams. It provides backpressure feedback for both the write and read ends.
This is a special exception that Input/Output controllers look for when error handling pipes.
This is a special exception that Input/Output controllers look for when error handling pipes. In most cases they will log the error that terminated the pipe, but for this one exception, the failure will be silent. This is basically for situations where a certain amount of data is expected but for some reason the receiver decides to cancel for some business-logic reason.
A Sink is the write side of a pipe.
A Sink is the write side of a pipe. It allows you to push items to it, and will return whether or not it can accept more data. In the case where the pipe is full, the Sink will return a mutable Trigger and you can attach a callback to for when the pipe can receive more items
A Source is the read side of a pipe.
A Source is the read side of a pipe. You provide a handler for when an item is ready and the Source will call it. Note that if the underlying pipe has multiple items ready, onReady will only be called once. This is so that the consumer of the sink can implicitly apply backpressure by only pulling when it is able to
trait representing a decoded message that is actually a stream
trait representing a decoded message that is actually a stream
When a codec decodes a message that contains a stream (perhaps an http request with a very large body), the returned message MUST extend this trait, otherwise the InputController will not know to push subsequent data to the stream message and things will get all messed up.
When a user attempts to push a value into a pipe, and the pipe either fills or was already full, a Trigger is returned in the PushResult.
When a user attempts to push a value into a pipe, and the pipe either fills or was already full, a Trigger is returned in the PushResult. This is essentially just a fillable callback function that is called when the pipe either becomes empty or is closed or terminated
Notice that when the trigger is executed we don't include any information about the state of the pipe. The handler can just try pushing again to determine if the pipe is dead or not.
A Controller is a Connection handler that is designed to work with connections involving decoding raw bytes into input messages and encoding output messages into bytes.
Unlike a service, which pairs an input "request" message with an output "response" message, the controller make no such pairing. Thus a controller can be thought of as a duplex stream of messages.