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 WebSocketMessage: (source)

View In Hierarchy

Retain an immutable message without copying its payload.

Method isBytes Identify binary data.
Method isDisconnect Identify the terminal peer event.
Method isText Identify text data.
Class Variable code Machine-readable status or error code.
Class Variable data Decoded content carried by this message or request.
Class Variable reason Human-readable reason associated with connection closure.
Class Variable type Discriminator identifying the message or schema variant.
Property bytes Return the original binary payload.
Property text Return the original text payload.
def isBytes(self) -> bool: (source)

Identify binary data.

Returns
boolWhether this message contains bytes.
def isDisconnect(self) -> bool: (source)

Identify the terminal peer event.

Returns
boolWhether this message describes a disconnect.
def isText(self) -> bool: (source)

Identify text data.

Returns
boolWhether this message contains text.

Machine-readable status or error code.

Decoded content carried by this message or request.

Human-readable reason associated with connection closure.

Discriminator identifying the message or schema variant.

Return the original binary payload.

Returns
bytesBinary payload without a copy.
Raises
TypeErrorIf this is not a binary message.

Return the original text payload.

Returns
strText payload without a copy.
Raises
TypeErrorIf this is not a text message.