orionis.realtime.errors.ProtocolError

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

exception documentation

class ProtocolError(ValueError): (source)

Report an invalid envelope or incompatible WebSocket frame.

Method	`__init__`	Retain a sanitized explanation and the appropriate close code.
Class Variable	`__slots__`	Undocumented
Instance Variable	`close_code`	Undocumented

def __init__(self, message: str = 'Invalid realtime message', close_code: int = 1002): (source) ¶

Retain a sanitized explanation and the appropriate close code.

Parameters
message:`str, optional`	Safe protocol error description.
close_code:`int, optional`	WebSocket close code; defaults to protocol violation.

Returns
`None`	Initialize a connection-level protocol failure.

Undocumented

Undocumented