Ir al contenido principal

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
ParameterTypeDescription
valueint
Returnsbytes

Functions​

decode_event()​

decode_event(payload: Any) -> Optional[Any]
ParameterTypeDescription
payloadAny
ReturnsOptional[Any]

decode_frame()​

decode_frame(payload: Sequence[int], max_bytes: Optional[int] = None) -> Any
ParameterTypeDescription
payloadSequence[int]
max_bytesOptional[int] = None
ReturnsAny

decode_state()​

decode_state(payload: Any) -> types.DeviceState
ParameterTypeDescription
payloadAny
Returnstypes.DeviceState

encode_event()​

encode_event(event: core.SessionEvent) -> Any
ParameterTypeDescription
eventcore.SessionEvent
ReturnsAny

encode_frame()​

encode_frame(message: Any, max_bytes: Optional[int] = None) -> bytes
ParameterTypeDescription
messageAny
max_bytesOptional[int] = None
Returnsbytes

encode_state()​

encode_state(state: types.DeviceState) -> Any
ParameterTypeDescription
statetypes.DeviceState
ReturnsAny

error_response()​

error_response(msg_id: int, code: str, message: str) -> Any
ParameterTypeDescription
msg_idint
codestr
messagestr
ReturnsAny

event_frame()​

event_frame(session_id: str, seq: int, event: Any) -> Any
ParameterTypeDescription
session_idstr
seqint
eventAny
ReturnsAny

read_frame()​

read_frame(reader: Any) -> Any
ParameterTypeDescription
readerAny
ReturnsAny

request()​

request(msg_id: int, type_: str, payload: Optional[Any] = None) -> Any
ParameterTypeDescription
msg_idint
type_str
payloadOptional[Any] = None
ReturnsAny

response()​

response(msg_id: int, payload: Optional[Any] = None) -> Any
ParameterTypeDescription
msg_idint
payloadOptional[Any] = None
ReturnsAny

welcome_payload()​

welcome_payload(raydriver_version: str, auth_required: bool) -> Any
ParameterTypeDescription
raydriver_versionstr
auth_requiredbool
ReturnsAny

write_frame()​

write_frame(writer: Any, message: Any) -> Any
ParameterTypeDescription
writerAny
messageAny
ReturnsAny