Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update NOW.md

This commit is contained in:
HomeSpan 2022-10-15 17:20:38 -05:00 committed by GitHub
parent 11d37a7b39
commit ec11a56154
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/NOW.md
View File

@ -77,7 +77,7 @@ Once instances of *SpanPoint* are created, the following methods can be used to
* checks to see if a message has been received into SpanPoint's internal queue from a device with the *macAddress* specified when the relevant SpanPoint object was instantiated. If so, the message is copied into the memory pointed to by *dataBuf*, the internal queue is cleared, and the method returns **true**. If no message is available, the *dataBuf* memory is unmodified and the method returns **false** * checks to see if a message has been received into SpanPoint's internal queue from a device with the *macAddress* specified when the relevant SpanPoint object was instantiated. If so, the message is copied into the memory pointed to by *dataBuf*, the internal queue is cleared, and the method returns **true**. If no message is available, the *dataBuf* memory is unmodified and the method returns **false**
* note that the pointer *dataBuf* should always reference a data element or structure whose size equals or exceeds the *receiveSize* parameter specified when the relevant SpanPoint object was instantiated * note that the pointer *dataBuf* should always reference a data element or structure whose size equals or exceeds the *receiveSize* parameter specified when the relevant SpanPoint object was instantiated
* once the internal SpanPoint queue is full, any messages received from the same device are discarded until the queue is cleared by calling this *get()* method. Setting the optional *queueDepth* parameter to a number greater than one when the relevant SpanPoint object was instantiated allows SpanPoint to retain up to *queueDepth* messages even without a call to the this *get()* method. However, once the queue is full, additional messages received will be discarded until messages are "gotten" of the queue with the *get()* method * once the internal SpanPoint queue is full, any messages received from the same device are discarded until the queue is cleared by calling this *get()* method. Setting the optional *queueDepth* parameter to a number greater than one when the relevant SpanPoint object was instantiated allows SpanPoint to retain up to *queueDepth* messages even without a call to the *get()* method. However, once the queue is full, additional messages received will be discarded until messages are "gotten" off the queue with the *get()* method