Skip to content

Commit

Permalink
chore: address PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
@zfields
zfields committed Sep 8, 2023
1 parent 7df7deb commit 16c72bc
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions n_helpers.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ static const char NOTE_C_BINARY_EOP = '\n';
@brief Decode binary data received from the Notecard.
@param encData The encoded binary data to decode.
@param encLen The length of the encoded binary data.
@param encDataLen The length of the encoded binary data.
@param decBuf The target buffer for the decoded data. This can be the
same address as `encData`, allowing for in-place decoding.
@param decBufSize The size of `decBuf`.
Expand Down Expand Up @@ -217,11 +217,11 @@ uint32_t NoteBinaryCodecMaxEncodedLength(uint32_t unencodedLength)

//**************************************************************************/
/*!
@brief Get the length of the data stored on the Notecard. If there's no data
stored on the Notecard, then `*len` will return 0.
@brief Get the length of the data in the Notecard's binary store. If there's
no data on the Notecard, then `*len` will return 0.
@param len [out] The length of the decoded contents of the Notecard's binary
data store.
store.
@returns An error string on error and NULL on success.
*/
Expand Down Expand Up @@ -264,11 +264,11 @@ const char * NoteBinaryStoreDecodedLength(uint32_t *len)
//**************************************************************************/
/*!
@brief Get the required buffer length to receive the entire binary object
stored on the Notecard.
stored in the Notecard's binary store.
@param len [out] The length required to hold the entire contents of the
Notecard's binary data store. If there's no data stored on the
Notecard, then `len` will return 0.
Notecard's binary store. If there's no data on the Notecard, then
`len` will return 0.
@returns An error string on error and NULL on success.
*/
Expand Down Expand Up @@ -301,7 +301,7 @@ const char * NoteBinaryStoreEncodedLength(uint32_t *len)
}

// Examine "cobs" from the response to evaluate the space required to hold
// the COBS-encoded data to be received from the Notecard.
// the encoded data to be received from the Notecard.
long int cobs = JGetInt(rsp, "cobs");
JDelete(rsp);
*len = cobs;
Expand All @@ -311,14 +311,13 @@ const char * NoteBinaryStoreEncodedLength(uint32_t *len)

//**************************************************************************/
/*!
@brief Receive a large binary object from the Notecard's binary buffer
@brief Receive a large binary object from the Notecard's binary store.
@param buffer A buffer to hold the binary range
@param bufLen The total length of the provided buffer
@param decodedOffset The offset to the decoded binary data already residing
on the Notecard
@param decodedLen The length of the decoded data to fetch from the
Notecard.
@param buffer A buffer to hold the binary range.
@param bufLen The total length of the provided buffer.
@param decodedOffset The offset to the decoded binary data residing
in the Notecard's binary store.
@param decodedLen The length of the decoded data to fetch from the Notecard.
@returns NULL on success, else an error string pointer.
Expand Down Expand Up @@ -434,13 +433,13 @@ const char * NoteBinaryStoreReceive(uint8_t *buffer, uint32_t bufLen,

//**************************************************************************/
/*!
@brief Reset the Notecard's binary buffer.
@brief Reset the Notecard's binary store.
@returns NULL on success, else an error string pointer.
@note This operation is necessary to clear the Notecard's binary buffer after
a binary object is received from the Notecard, or if the Notecard's
binary buffer has been left in an unknown state due to an error arising
binary store has been left in an unknown state due to an error arising
from a binary transfer to the Notecard.
*/
/**************************************************************************/
Expand All @@ -459,6 +458,7 @@ const char * NoteBinaryStoreReset(void)
NOTE_C_LOG_ERROR(err);
return err;
}
JDelete(rsp);
} else {
const char *err = ERRSTR("unable to allocate request", c_mem);
NOTE_C_LOG_ERROR(err);
Expand All @@ -470,14 +470,14 @@ const char * NoteBinaryStoreReset(void)

//**************************************************************************/
/*!
@brief Transmit a large binary object to the Notecard's binary buffer
@brief Transmit a large binary object to the Notecard's binary store.
@param unencodedData A buffer with data to encode in place
@param unencodedLen The length of the data in the buffer
@param bufLen The total length of the buffer (see notes)
@param unencodedData A buffer with data to encode in place.
@param unencodedLen The length of the data in the buffer.
@param bufLen The total length of the buffer (see notes).
@param notecardOffset The offset where the data buffer should be appended
to the decoded binary data already residing on the
Notecard. This does not provide random access, but
to the decoded binary data residing in the Notecard's
binary store. This does not provide random access, but
rather ensures alignment across sequential writes.
@returns NULL on success, else an error string pointer.
Expand Down Expand Up @@ -599,9 +599,9 @@ const char * NoteBinaryStoreTransmit(uint8_t *unencodedData, uint32_t unencodedL
const char *err = ERRSTR("failed to initialize binary transaction", c_err);
NOTE_C_LOG_ERROR(err);
_UnlockNote();
// On errors, we restore the caller's input buffer by COBS
// decoding it. The caller is then able to retry transmission
// with their original pointer to this buffer.
// On errors, we restore the caller's input buffer by decoding
// it. The caller is then able to retry transmission with their
// original pointer to this buffer.
NoteBinaryCodecDecode(encodedData, encLen, encodedData, bufLen);
return err;
}
Expand All @@ -613,7 +613,7 @@ const char * NoteBinaryStoreTransmit(uint8_t *unencodedData, uint32_t unencodedL
return err;
}

// Immediately send the COBS binary.
// Immediately send the encoded binary.
const char *err = _ChunkedTransmit(encodedData, (encLen + 1), false);

// Release Notecard Mutex
Expand Down

0 comments on commit 16c72bc

Please sign in to comment.