updated lwmqtt

Author: 256dpi

Makefile

@@ -5,7 +5,7 @@ fmt:
 
 update:
 	rm -rf ./lwmqtt
-	git clone --branch v0.5.6 https://github.com/256dpi/lwmqtt.git ./lwmqtt
+	git clone --branch v0.6.1 https://github.com/256dpi/lwmqtt.git ./lwmqtt
 	mkdir -p ./src/lwmqtt
 	cp -r ./lwmqtt/src/*.c ./src/lwmqtt/
 	cp -r ./lwmqtt/src/*.h ./src/lwmqtt/

src/lwmqtt/helpers.c

@@ -2,9 +2,7 @@
 
 #include "helpers.h"
 
-uint8_t lwmqtt_read_bits(uint8_t byte, int pos, int num) {
-  return (byte & (uint8_t)((~(0xFF << num)) << pos)) >> pos;
-}
+uint8_t lwmqtt_read_bits(uint8_t byte, int pos, int num) { return (byte & (uint8_t)((~(0xFF << num)) << pos)) >> pos; }
 
 void lwmqtt_write_bits(uint8_t *byte, uint8_t value, int pos, int num) {
   *byte = (*byte & ~(uint8_t)((~(0xFF << num)) << pos)) | (value << pos);

src/lwmqtt/lwmqtt.h

@@ -7,6 +7,10 @@
 
 /**
  * The error type used by all exposed APIs.
+ *
+ * If a function returns an error that operates on a connected client (e.g publish, keep_alive, etc.) the caller should
+ * switch into a disconnected state, close and cleanup the current connection and start over by creating a new
+ * connection.
  */
 typedef enum {
   LWMQTT_SUCCESS = 0,
@@ -345,11 +349,12 @@ lwmqtt_err_t lwmqtt_disconnect(lwmqtt_client_t *client, uint32_t timeout);
 /**
  * Will yield control to the client and receive incoming packets from the network.
  *
- * Applications may peek on the network if there is data available to read before calling yield and potentially block
- * until the timeout is reached. Furthermore, applications may specify the amount of bytes available to read in order
- * to constrain the yield to only receive packets that are already inflight.
+ * Single-threaded applications may peek on the network and assess if data is available to read before calling yield and
+ * potentially block until the timeout is reached. Multi-threaded applications may select on the socket and block until
+ * data is available and then yield to the client if data is available. All applications may specify the amount of bytes
+ * available to read in order to constrain the yield to only receive packets that are already in-flight.
  *
- * If no availability data is given the yield will return after one packet has been successfully read or the deadline
+ * If no availability info is given the yield will return after one packet has been successfully read or the deadline
  * has been reached but no single bytes has been received.
  *
  * Note: The message callback might be called with incoming messages as part of this call.
@@ -364,6 +369,9 @@ lwmqtt_err_t lwmqtt_yield(lwmqtt_client_t *client, size_t available, uint32_t ti
 /**
  * Will yield control to the client to keep the connection alive.
  *
+ * This functions must be called at a rate slightly lower than 25% of the configured keep alive. If keep alive is zero,
+ * the function must not be called at all.
+ *
  * @param client - The client object.
  * @param timeout - The command timeout.
  * @return An error value.

src/lwmqtt/packet.c

@@ -132,11 +132,11 @@ lwmqtt_err_t lwmqtt_encode_connect(uint8_t *buf, size_t buf_len, size_t *len, lw
 
   // set username flag if present
   if (options.username.len > 0) {
-    lwmqtt_write_bits(&flags, 1, 6, 1);
+    lwmqtt_write_bits(&flags, 1, 7, 1);
 
     // set password flag if present
     if (options.password.len > 0) {
-      lwmqtt_write_bits(&flags, 1, 7, 1);
+      lwmqtt_write_bits(&flags, 1, 6, 1);
     }
   }
 

src/lwmqtt/packet.h

@@ -48,137 +48,137 @@ lwmqtt_err_t lwmqtt_detect_packet_type(uint8_t *buf, size_t buf_len, lwmqtt_pack
 lwmqtt_err_t lwmqtt_detect_remaining_length(uint8_t *buf, size_t buf_len, uint32_t *rem_len);
 
 /**
-  * Encodes a connect packet into the supplied buffer.
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param options - The options to be used to build the connect packet.
-  * @param will - The last will and testament.
-  * @return An error value.
-  */
+ * Encodes a connect packet into the supplied buffer.
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param options - The options to be used to build the connect packet.
+ * @param will - The last will and testament.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_connect(uint8_t *buf, size_t buf_len, size_t *len, lwmqtt_options_t options,
                                    lwmqtt_will_t *will);
 
 /**
-  * Decodes a connack packet from the supplied buffer.
-  *
-  * @param buf - The raw buffer data.
-  * @param buf_len - The length of the specified buffer.
-  * @param session_present - The session present flag.
-  * @param return_code - The return code.
-  * @return An error value.
-  */
+ * Decodes a connack packet from the supplied buffer.
+ *
+ * @param buf - The raw buffer data.
+ * @param buf_len - The length of the specified buffer.
+ * @param session_present - The session present flag.
+ * @param return_code - The return code.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_decode_connack(uint8_t *buf, size_t buf_len, bool *session_present,
                                    lwmqtt_return_code_t *return_code);
 
 /**
-  * Encodes a zero (disconnect, pingreq) packet into the supplied buffer.
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param packet_type - The packets type.
-  * @return An error value.
-  */
+ * Encodes a zero (disconnect, pingreq) packet into the supplied buffer.
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param packet_type - The packets type.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_zero(uint8_t *buf, size_t buf_len, size_t *len, lwmqtt_packet_type_t packet_type);
 
 /**
-  * Decodes an ack (puback, pubrec, pubrel, pubcomp, unsuback) packet from the supplied buffer.
-  *
-  * @param buf - The raw buffer data.
-  * @param buf_len - The length of the specified buffer.
-  * @param packet_type - The packet type.
-  * @param dup - The dup flag.
-  * @param packet_id - The packet id.
-  * @return An error value.
-  */
+ * Decodes an ack (puback, pubrec, pubrel, pubcomp, unsuback) packet from the supplied buffer.
+ *
+ * @param buf - The raw buffer data.
+ * @param buf_len - The length of the specified buffer.
+ * @param packet_type - The packet type.
+ * @param dup - The dup flag.
+ * @param packet_id - The packet id.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_decode_ack(uint8_t *buf, size_t buf_len, lwmqtt_packet_type_t packet_type, bool *dup,
                                uint16_t *packet_id);
 
 /**
-  * Encodes an ack (puback, pubrec, pubrel, pubcomp) packet into the supplied buffer.
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param packet_type - The packets type.
-  * @param dup - The dup flag.
-  * @param packet_id - The packet id.
-  * @return An error value.
-  */
+ * Encodes an ack (puback, pubrec, pubrel, pubcomp) packet into the supplied buffer.
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param packet_type - The packets type.
+ * @param dup - The dup flag.
+ * @param packet_id - The packet id.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_ack(uint8_t *buf, size_t buf_len, size_t *len, lwmqtt_packet_type_t packet_type, bool dup,
                                uint16_t packet_id);
 
 /**
-  * Decodes a publish packet from the supplied buffer.
-  *
-  * @param buf - The raw buffer data.
-  * @param buf_len - The length of the specified buffer.
-  * @param dup - The dup flag.
-  * @param packet_id  - The packet id.
-  * @param topic - The topic.
-  * @parma msg - The message.
-  * @return An error value.
-  */
+ * Decodes a publish packet from the supplied buffer.
+ *
+ * @param buf - The raw buffer data.
+ * @param buf_len - The length of the specified buffer.
+ * @param dup - The dup flag.
+ * @param packet_id  - The packet id.
+ * @param topic - The topic.
+ * @parma msg - The message.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_decode_publish(uint8_t *buf, size_t buf_len, bool *dup, uint16_t *packet_id, lwmqtt_string_t *topic,
                                    lwmqtt_message_t *msg);
 
 /**
-  * Encodes a publish packet into the supplied buffer.
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param dup - The dup flag.
-  * @param packet_id  - The packet id.
-  * @param topic - The topic.
-  * @param msg - The message.
-  * @return An error value.
-  */
+ * Encodes a publish packet into the supplied buffer.
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param dup - The dup flag.
+ * @param packet_id  - The packet id.
+ * @param topic - The topic.
+ * @param msg - The message.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_publish(uint8_t *buf, size_t buf_len, size_t *len, bool dup, uint16_t packet_id,
                                    lwmqtt_string_t topic, lwmqtt_message_t msg);
 
 /**
-  * Encodes a subscribe packet into the supplied buffer.
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param packet_id - The packet id.
-  * @param count - The number of members in the topic_filters and qos_levels array.
-  * @param topic_filters - The array of topic filter.
-  * @param qos_levels - The array of requested QoS levels.
-  * @return An error value.
-  */
+ * Encodes a subscribe packet into the supplied buffer.
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param packet_id - The packet id.
+ * @param count - The number of members in the topic_filters and qos_levels array.
+ * @param topic_filters - The array of topic filter.
+ * @param qos_levels - The array of requested QoS levels.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_subscribe(uint8_t *buf, size_t buf_len, size_t *len, uint16_t packet_id, int count,
                                      lwmqtt_string_t *topic_filters, lwmqtt_qos_t *qos_levels);
 
 /**
-  * Decodes a suback packet from the supplied buffer.
-  *
-  * @param buf - The raw buffer data.
-  * @param buf_len - The length of the specified buffer.
-  * @param packet_id - The packet id.
-  * @param max_count - The maximum number of members allowed in the granted_qos_levels array.
-  * @param count - The number of members in the granted_qos_levels array.
-  * @param granted_qos_levels - The granted QoS levels.
-  * @return An error value.
-  */
+ * Decodes a suback packet from the supplied buffer.
+ *
+ * @param buf - The raw buffer data.
+ * @param buf_len - The length of the specified buffer.
+ * @param packet_id - The packet id.
+ * @param max_count - The maximum number of members allowed in the granted_qos_levels array.
+ * @param count - The number of members in the granted_qos_levels array.
+ * @param granted_qos_levels - The granted QoS levels.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_decode_suback(uint8_t *buf, size_t buf_len, uint16_t *packet_id, int max_count, int *count,
                                   lwmqtt_qos_t *granted_qos_levels);
 
 /**
-  * Encodes the supplied unsubscribe data into the supplied buffer, ready for sending
-  *
-  * @param buf - The buffer into which the packet will be encoded.
-  * @param buf_len - The length of the specified buffer.
-  * @param len - The encoded length of the packet.
-  * @param packet_id - The packet id.
-  * @param count - The number of members in the topic_filters array.
-  * @param topic_filters - The array of topic filters.
-  * @return An error value.
-  */
+ * Encodes the supplied unsubscribe data into the supplied buffer, ready for sending
+ *
+ * @param buf - The buffer into which the packet will be encoded.
+ * @param buf_len - The length of the specified buffer.
+ * @param len - The encoded length of the packet.
+ * @param packet_id - The packet id.
+ * @param count - The number of members in the topic_filters array.
+ * @param topic_filters - The array of topic filters.
+ * @return An error value.
+ */
 lwmqtt_err_t lwmqtt_encode_unsubscribe(uint8_t *buf, size_t buf_len, size_t *len, uint16_t packet_id, int count,
                                        lwmqtt_string_t *topic_filters);