Skip to content

Commit 32fa29f

Browse files
committed
Update pushRx documentation
1 parent dc66ca3 commit 32fa29f

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

src/NimBLEStream.cpp

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,8 @@ size_t NimBLEStream::pushRx(const uint8_t* data, size_t len) {
493493

494494
size_t freeSize = m_rxBuf->freeSize();
495495
if (len > freeSize) {
496-
const RxOverflowAction action = m_rxOverflowCallback ? m_rxOverflowCallback(data, len, m_rxOverflowUserArg) : DROP_NEW_DATA;
496+
const RxOverflowAction action = m_rxOverflowCallback ? m_rxOverflowCallback(data, len, m_rxOverflowUserArg)
497+
: DROP_NEW_DATA;
497498
if (action != DROP_OLDER_DATA) {
498499
NIMBLE_LOGE(LOG_TAG, "RX buffer overflow, dropping current data");
499500
return 0;
@@ -527,12 +528,13 @@ size_t NimBLEStream::pushRx(const uint8_t* data, size_t len) {
527528
* @param txBufSize Size of the TX buffer.
528529
* @param rxBufSize Size of the RX buffer.
529530
* @return true if initialization was successful, false otherwise.
530-
* @details The provided characteristic must have the NOTIFY property set for write operations
531-
* to work and the WRITE or WRITE_NR property set for read operations to work.
532-
* The stream will manage setting its own callbacks on the characteristic, but will save and call
533-
* any existing user callbacks if they were set.
534-
* The RX buffer will only be created if the characteristic has WRITE or WRITE_NR properties.
535-
* The TX buffer will only be created if the characteristic has NOTIFY properties.
531+
* @details The provided characteristic must have the NOTIFY property set to allow the server
532+
* to send data (TX) to the client, and the WRITE or WRITE_NR property set to allow the server
533+
* to receive data (RX) from the client.
534+
* The RX buffer will only be created if the characteristic has WRITE or WRITE_NR properties
535+
* (i.e. can receive data from the client).
536+
* The TX buffer will only be created if the characteristic has NOTIFY properties
537+
* (i.e. can send data to the client).
536538
*/
537539
bool NimBLEStreamServer::begin(NimBLECharacteristic* pChr, uint32_t txBufSize, uint32_t rxBufSize) {
538540
if (!NimBLEDevice::isInitialized()) {

0 commit comments

Comments
 (0)