ORIONIS API REFERENCE

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.

class documentation

class HTTPWebSocket(BaseEntity): (source)

View In Hierarchy

Configure connection admission, inbound messages and browser origins.

Method __post_init__ Validate limits and copy the configured origin collection.
Instance Variable allow_origins Additional allowed browser origins. Empty allows the same origin only. A wildcard explicitly allows every origin.
Instance Variable max_connections Maximum active connections per kernel; defaults to 128.
Instance Variable max_message_size Maximum complete inbound message bytes; defaults to one MiB.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
def __post_init__(self): (source)

Validate limits and copy the configured origin collection.

Returns
NoneFreeze the validated configuration.
Raises
TypeErrorIf limits or origin entries have invalid types.
ValueErrorIf a limit is nonpositive or an origin is empty.
allow_origins: tuple[str, ...] = (source)

Additional allowed browser origins. Empty allows the same origin only. A wildcard explicitly allows every origin.

max_connections: int = (source)

Maximum active connections per kernel; defaults to 128.

max_message_size: int = (source)

Maximum complete inbound message bytes; defaults to one MiB.