codec_slip.h File Reference

Detailed Description

Inline SLIP encoder and decoder objects.

The inline SlipEncoder implements the Writeable interface, encodes each incoming byte, and writes the result to a different Writeable object with escape characters and inter-frame tokens.

The inline SlipDecoder does the inverse, accepting an SLIP stream one byte at a time through the Writeable interface, and forwarding the decoded result to a different Writeable object. (Often a PacketBuffer.)

In both cases, the input uses the io::Writeable API. To attach either input to an io::Readable interface, use io::BufferedCopy.

See also: IETF RFC-1055: "Serial Line Internet Protocol" https://tools.ietf.org/html/rfc1055

Definition in file codec_slip.h.

#include <satcat5/io_buffer.h>
#include <satcat5/pkt_buffer.h>

Include dependency graph for codec_slip.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	satcat5::io::SlipEncoder
	Inline SLIP encoder. More...
class	satcat5::io::SlipDecoder
	Inline SLIP decoder. More...
class	satcat5::io::SlipCodec
	Buffered SLIP encoder / decoder pair. More...
class	satcat5::io::SlipCodecInverse
	Buffered SLIP encoder / decoder pair with opposite polarity. More...

Macros
#define	SATCAT5_SLIP_BUFFSIZE   1600
#define	SATCAT5_SLIP_PACKETS   32