Ping (ping)¶
To send the ping request to the server. Mostly used to test the connection or to keep it alive.
-
ping
(passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶ Parameters: - passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
- req_id (Optional[int]) – [Optional] Used to map request to response.
Returns: req_id
Return type: int