sven/libicsneo
1
0
Fork 0
mirror of https://github.com/intrepidcs/libicsneo.git synced 2026-08-05 01:18:36 +02:00
Code Issues Projects Releases Wiki Activity

Fix documentation building

Browse Source
This commit is contained in:
Paul Hollinsky
2020-08-06 16:09:29 -04:00
parent 8566f9d57d
commit 6218a5cc7e
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Usage.rst
+3 -3
View File
@@ -19,7 +19,7 @@ Additionally, `event callbacks`_ can be registered, which may remove the need to
.. _events:
Events
Events
~~~~~~~~~~~~~~~~~~~~
The API stores events in a single buffer that can has a default size of 10,000 events.
@@ -67,7 +67,7 @@ In order to access device functionality, the device must first be opened, which
The exception to this is setting the message polling status of the device.
Trying to open/close the device when the device is already open/closed will result in an error being logged on the calling thread.
Online/Offline Status
Online/Offline Status
~~~~~~~~~~~~~~~~~~~~~~~
Going online begins communication between the device and the rest of the network. In order to be online, the device must also be open.
@@ -99,4 +99,4 @@ Write Blocking Status
The write blocking status of the device determines the behavior of attempting to transmit to the device (likely via sending messages) with a large backlog of messages.
If write blocking is enabled, then the transmitting thread will wait for the entire buffer to be transmitted.
If write blocking is disabled, then the attempt to transmit will simply fail and an error will be logged on the calling thread.
If write blocking is disabled, then the attempt to transmit will simply fail and an error will be logged on the calling thread.