valis / Reference / API reference

Protocol - API reference

Exported surface for the protocol subsystem. Part of the API reference.

Package valis/src/protocol

Classes

protocol

A protocol plugin. Concrete protocols subclass this (or instantiate it with a specialised HANDLE-CONNECTION method) and register themselves on their ports. This class is the contract the registry dispatches against.

Conditions

protocol-not-implemented

Signalled when a connection reaches a protocol that has not specialised HANDLE-CONNECTION. A registered protocol is a promise to handle its ports; this condition marks a broken promise rather than letting it pass silently.

Generic functions

handle-connection

(handle-connection protocol connection)

Handle an inbound CONNECTION that arrived on one of PROTOCOL's ports. CONNECTION is an opaque, transport-level handle supplied by the listener; its concrete shape is defined where valis binds to eBPF. Specialise this on each concrete protocol to drive the exchange against the user's substrate.

protocol-description

(protocol-description object)

Undocumented: this exported symbol needs a docstring.

protocol-name

(protocol-name object)

Undocumented: this exported symbol needs a docstring.

protocol-not-implemented-protocol

(protocol-not-implemented-protocol condition)

Undocumented: this exported symbol needs a docstring.

protocol-ports

(protocol-ports object)

Undocumented: this exported symbol needs a docstring.