Module frame 

The SPDY/3.1 frames and their encoding, see https://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft3-1/.

Header blocks are compressed with zlib and a preset dictionary. Each direction of a connection keeps one compression context for all its header blocks, so every frame which carries one has to pass the same Decoder or Encoder, also the ones which are otherwise ignored. The server only sends empty header blocks, the Encoder stores them uncompressed in the zlib stream instead of compressing them.

Structs

Decoder 🔒

Reads the frames of one direction of a connection.

Encoder 🔒

Writes the frames of one direction of a connection.

Headers 🔒

The headers of a stream. SPDY requires lowercase names, multiple values of a name are joined with NUL bytes.

Enums

Frame 🔒

A single SPDY frame. Only the frames and fields the server acts on are represented, see Frame::Ignored. Its debug output shows only the length of data, which may carry secrets, like typed passwords or forwarded traffic.

Constants

DATA_CHUNK_LEN 🔒

How much of a data frame the server reads at once. Larger frames get handed to their stream in parts, so that the server does not buffer them as a whole. Go clients send 32 KiB per frame.

DICTIONARY 🔒

The preset dictionary for the header compression, from the specification.

DICTIONARY_ID 🔒

The Adler-32 checksum of the dictionary, which the zlib header names.

FLAG_FIN 🔒

The flag which ends the sending side of a stream, on SYN_STREAM, SYN_REPLY, HEADERS and data frames.

GOAWAY_OK 🔒

GOAWAY status: the connection ends normally.

GOAWAY_PROTOCOL_ERROR 🔒

GOAWAY status: the client violated the protocol.

HEADER_LEN 🔒

The length of the common header of all frames.

MAX_CONTROL_FRAME_LEN 🔒

The largest control frame a client may send. The ones Kubernetes clients send carry a few short headers.

MAX_DATA_FRAME_LEN 🔒

The largest frame the protocol allows, its length has 24 bits.

MAX_HEADERS 🔒

The most headers of a stream, Kubernetes clients send up to three. Each takes more memory than the bytes of its block.

MAX_HEADER_BLOCK_LEN 🔒

The largest decompressed header block, which bounds what a small compressed block may expand to. Kubernetes clients send around a hundred bytes, a stream holds its headers as long as it is open. A larger block fails the connection, like any header block which does not decode, the compression context of the connection would be out of sync otherwise.

STATUS_CANCEL 🔒

RST_STREAM status: the stream is not needed anymore. spdystream resets with it as well, also for streams it rejects.

STATUS_PROTOCOL_ERROR 🔒

RST_STREAM status: the frame violates the protocol.

STATUS_REFUSED_STREAM 🔒

RST_STREAM status: the stream got refused before any processing.

TYPE_GOAWAY 🔒

TYPE_HEADERS 🔒

TYPE_PING 🔒

TYPE_RST_STREAM 🔒

TYPE_SYN_REPLY 🔒

TYPE_SYN_STREAM 🔒

VERSION 🔒

The protocol version of the control frames.