Skip to main content

wire API

SDK 0.4.0. This reference describes the supported authoring interface.

ProtocolError​

The child violated the authenticated private framing contract.

read_message​

Read one capped frame; caller owns the encompassing deadline.

async def read_message(reader: asyncio.StreamReader) -> WireMessage:
...

write_message​

Write one capped frame and await backpressure within caller's deadline.

async def write_message(writer: asyncio.StreamWriter, message: WireMessage) -> None:
...