raydriver.remote.protocol
Constants
AUTH
str
AUTH_FAILED
str
BAD_REQUEST
str
BAD_VERSION
str
CLIENT_LIST
str
DEFAULT_KEEPALIVE_INTERVAL
float
DEFAULT_KEEPALIVE_MISSES
int
DEVICE_LIST
str
EVENT
str
FRAME_TOO_LARGE
str
INTERNAL
str
JOB_RUNNING
str
KIND_JOB_ERROR
str
KIND_LEASE
str
KIND_PROGRESS
str
LEASE_HELD
str
LEASE_TAKEN
str
LENGTH_PREFIX
LengthPrefix
MAX_FRAME_BYTES
int
PING
str
PONG
str
PROTOCOLS
list[str]
PROTOCOL_LIST
str
PROTOCOL_VERSION
int
ProtocolError
type
REQUEST_TYPES
list[str]
SESSION_ATTACH
str
SESSION_CLOSE
str
SESSION_COMMAND
str
SESSION_DETACH
str
SESSION_LIST
str
SESSION_METHODS
list[str]
SESSION_OPEN
str
SESSION_PROPERTIES
list[str]
SESSION_PROPERTY
str
UNKNOWN_DEVICE
str
UNKNOWN_METHOD
str
UNKNOWN_PROPERTY
str
UNKNOWN_SESSION
str
UNKNOWN_TYPE
str
WELCOME
str
LengthPrefix
size
size: int
pack()
pack(value: int) -> bytes
| Parameter | Type | Description |
|---|---|---|
value | int | |
| Returns | bytes |
Functions
decode_event()
decode_event(payload: Any) -> Optional[Any]
| Parameter | Type | Description |
|---|---|---|
payload | Any | |
| Returns | Optional[Any] |
decode_frame()
decode_frame(payload: Sequence[int], max_bytes: Optional[int] = None) -> Any
| Parameter | Type | Description |
|---|---|---|
payload | Sequence[int] | |
max_bytes | Optional[int] = None | |
| Returns | Any |
decode_state()
decode_state(payload: Any) -> types.DeviceState
| Parameter | Type | Description |
|---|---|---|
payload | Any | |
| Returns | types.DeviceState |
encode_event()
encode_event(event: core.SessionEvent) -> Any
| Parameter | Type | Description |
|---|---|---|
event | core.SessionEvent | |
| Returns | Any |
encode_frame()
encode_frame(message: Any, max_bytes: Optional[int] = None) -> bytes
| Parameter | Type | Description |
|---|---|---|
message | Any | |
max_bytes | Optional[int] = None | |
| Returns | bytes |
encode_state()
encode_state(state: types.DeviceState) -> Any
| Parameter | Type | Description |
|---|---|---|
state | types.DeviceState | |
| Returns | Any |
error_response()
error_response(msg_id: int, code: str, message: str) -> Any
| Parameter | Type | Description |
|---|---|---|
msg_id | int | |
code | str | |
message | str | |
| Returns | Any |
event_frame()
event_frame(session_id: str, seq: int, event: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
session_id | str | |
seq | int | |
event | Any | |
| Returns | Any |
read_frame()
read_frame(reader: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
reader | Any | |
| Returns | Any |
request()
request(msg_id: int, type_: str, payload: Optional[Any] = None) -> Any
| Parameter | Type | Description |
|---|---|---|
msg_id | int | |
type_ | str | |
payload | Optional[Any] = None | |
| Returns | Any |
response()
response(msg_id: int, payload: Optional[Any] = None) -> Any
| Parameter | Type | Description |
|---|---|---|
msg_id | int | |
payload | Optional[Any] = None | |
| Returns | Any |
welcome_payload()
welcome_payload(raydriver_version: str, auth_required: bool) -> Any
| Parameter | Type | Description |
|---|---|---|
raydriver_version | str | |
auth_required | bool | |
| Returns | Any |
write_frame()
write_frame(writer: Any, message: Any) -> Any
| Parameter | Type | Description |
|---|---|---|
writer | Any | |
message | Any | |
| Returns | Any |