Selkies
Developer Referencesignaling_server

Peer

A connected signaling peer (the in-process server or a browser client).

Attributes

attributeuidstr

Registry key, "server-" or "client-" prefixed UUID.

attributewsWebSocketResponse

The peer's WebSocket.

attributeraddrstr

Remote address, for logging.

attributepeer_typestr

Either "server" or "client".

attributeclient_typeOptional[str]

For clients, "viewer" or "controller".

attributeclient_slotOptional[int]

Player slot number, or -1 when unassigned.

attributeclient_strict_viewerOptional[bool]

Whether the client is a strict shared viewer.

attributeclient_tokenOptional[str]
= None

Secure-mode session token; matched against the active mk token to grant a viewer read-write collaboration (websockets mk-token parity).

attributepeer_statusOptional[str]
= None

None until paired, then "session" or the room id.

attributedisplay_idstr
= 'primary'

Display this peer drives ("primary", "display2", ...); controller and slot uniqueness are scoped per display so a second display's client never evicts the primary (websockets parity).

attributedisplay_positionstr
= 'right'

Where a secondary display sits relative to the primary ("right"/"left"/"up"/"down"), carried to the server side so it lays the framebuffer out like websockets mode.

Functions

func__init__(self, uid, ws, raddr, peer_type, client_type, client_slot, client_strict_viewer, client_token=None, peer_status=None, display_id='primary', display_position='right') -> None
paramself
paramuidstr
paramwsWebSocketResponse
paramraddrstr
parampeer_typestr
paramclient_typeOptional[str]
paramclient_slotOptional[int]
paramclient_strict_viewerOptional[bool]
paramclient_tokenOptional[str]
= None
parampeer_statusOptional[str]
= None
paramdisplay_idstr
= 'primary'
paramdisplay_positionstr
= 'right'

Returns

None

On this page

Edit on GitHub