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.

Explore modules View classes

orionis.http.WebSocketMessage

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 Undocumented
Class Variable data Undocumented
Class Variable reason Undocumented
Class Variable type Undocumented
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.
code: int | None = (source)

Undocumented

data: str | bytes | None = (source)

Undocumented

reason: str | None = (source)

Undocumented

type: WebSocketMessageType = (source)

Undocumented

bytes: bytes = (source)

Return the original binary payload.

Returns
bytesBinary payload without a copy.
Raises
TypeErrorIf this is not a binary message.
text: str = (source)

Return the original text payload.

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