Skip to content

Commit 8f8ee43

Browse files
Update remote docs
1 parent 1d7f088 commit 8f8ee43

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

doc/interfaces/remote.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,21 @@ The server uses the following classes to implement the connections.
6565

6666
.. autoclass:: can.interfaces.remote.RemoteServer
6767

68-
.. method:: serve_forever
68+
.. method:: serve_forever(poll_interval=0.5)
6969

7070
Start listening for incoming connections.
7171

7272
.. method:: shutdown
7373

74-
Stop the server.
74+
Stops the serve_forever loop.
7575

76+
Blocks until the loop has finished. This must be called while
77+
serve_forever() is running in another thread, or it will
78+
deadlock.
79+
80+
.. method:: server_close
81+
82+
Clean-up the server.
7683

7784
.. autoclass:: can.interfaces.remote.server.ClientBusConnection
7885

@@ -99,4 +106,6 @@ The available events that can occurr and their specification is listed below:
99106
.. autoclass:: can.interfaces.remote.events.TransmitSuccess
100107
.. autoclass:: can.interfaces.remote.events.RemoteException
101108
.. autoclass:: can.interfaces.remote.events.FilterConfig
109+
.. autoclass:: can.interfaces.remote.events.PeriodicMessageStart
110+
.. autoclass:: can.interfaces.remote.events.PeriodicMessageStop
102111
.. autoclass:: can.interfaces.remote.events.ConnectionClosed

0 commit comments

Comments
 (0)