API reference¶

The whole public surface of zttp. It's small on purpose. Everything here is importable straight from zttp (e.g. from zttp import Connection).

Connection¶

zttp.Connection is the base: the read side, shared by every protocol. Constructing one returns the subclass for the protocol you picked: an H1Connection (the default), an H2Connection, or an H3Connection, so the send surface you get matches the protocol.

receive_data(data)

next_event()

data_to_send()

receive_data(data)

next_event()

data_to_send()

start_next_cycle()

send_request(method, target, version, headers)

send_response(status, headers=...)

send_informational(status, headers=...)

send_data(data)

end_message(trailers=...)

should_close()

upgrade()

send_window

receive_data(data)

next_event()

data_to_send()

initiate_connection()

send_request(method, target, version, headers)

initiate_upgrade_connection(method, target, headers, settings_header=...)

stream(stream_id)

close(error_code=..., last_stream_id=...)

has_pending_send()

receive_data(data)

next_event()

data_to_send()

receive_datagram(datagram, now=...)

initiate_connection()

shutdown(stream_id)

stream(stream_id)

next_timeout()

handle_timeout(now)

is_closed()

idle_timed_out()

close_info()

peer_settings()

goaway_received()

close(error_code=..., reason=...)

A Stream is the per-stream send handle on an HTTP/2 connection; see HTTP/2.

stream_id

send_window

pending_bytes

send_response(status, headers=..., end_stream=...)

send_informational(status, headers=...)

send_data(data)

end_message(trailers=...)

reset(error_code=...)

Roles and protocols¶

A Connection's role and protocol are fixed at construction:

• zttp.SERVER: you receive requests, send responses.
• zttp.CLIENT: you send requests, receive responses.
• zttp.HTTP1 (default): one message at a time; you send on the connection.
• zttp.HTTP2: multiplexed streams; you send on a Stream.
• zttp.HTTP3: the same streams over QUIC; you feed UDP datagrams with receive_datagram (see HTTP/3).

Events¶

next_event returns one of these. On HTTP/2 and HTTP/3 each also carries a .stream_id.

method

target

path

query

http_version

headers

stream_id

expect_continue

status_code

reason

http_version

headers

stream_id

data

stream_id

trailers

stream_id

HTTP/2 control events¶

An HTTP/2 connection also surfaces the protocol's control frames. zttp acts on the ones that matter on its own; they're here when you want visibility.

params

stream_id

increment

ack

data

stream_id

error_code

last_stream_id

error_code

debug

Sentinels¶

Exceptions¶