puback -> publish acknowledgement

Author: sbSteveK

include/aws/mqtt/private/v5/mqtt5_client_impl.h

@@ -255,13 +255,13 @@ struct aws_mqtt5_client_operational_state {
     /*
      * One more than the most recently used control packet id.
      */
-    uint64_t next_mqtt5_puback_control_id;
+    uint64_t next_mqtt5_pub_ack_control_id;
     /* These tables are used for fast search of a packet_id and control_id pair. They both set an
-     * aws_mqtt5_manual_puback_entry as its value */
-    struct aws_hash_table manual_puback_packet_id_table;
-    struct aws_hash_table manual_puback_control_id_table;
+     * aws_mqtt5_manual_pub_ack_entry as its value */
+    struct aws_hash_table manual_pub_ack_packet_id_table;
+    struct aws_hash_table manual_pub_ack_control_id_table;
     /* This table contains control ids known to be cancelled due to client disconnect for better failure messaging */
-    struct aws_hash_table manual_puback_cancelled_control_id_table;
+    struct aws_hash_table manual_pub_ack_cancelled_control_id_table;
 
     struct aws_linked_list queued_operations;
     struct aws_mqtt5_operation *current_operation;

include/aws/mqtt/private/v5/mqtt5_options_storage.h

@@ -102,7 +102,7 @@ struct aws_mqtt5_operation_puback {
 
     struct aws_mqtt5_packet_puback_storage options_storage;
 
-    struct aws_mqtt5_manual_puback_completion_options completion_options;
+    struct aws_mqtt5_manual_publish_acknowledgement_completion_options completion_options;
 };
 
 struct aws_mqtt5_operation_disconnect {
@@ -275,7 +275,7 @@ AWS_MQTT_API void aws_mqtt5_packet_publish_view_log(
 AWS_MQTT_API struct aws_mqtt5_operation_puback *aws_mqtt5_operation_puback_new(
     struct aws_allocator *allocator,
     const struct aws_mqtt5_packet_puback_view *puback_options,
-    const struct aws_mqtt5_manual_puback_completion_options *completion_options);
+    const struct aws_mqtt5_manual_publish_acknowledgement_completion_options *completion_options);
 
 AWS_MQTT_API void aws_mqtt5_packet_puback_view_log(
     const struct aws_mqtt5_packet_puback_view *puback_view,

include/aws/mqtt/v5/mqtt5_client.h

@@ -295,13 +295,13 @@ typedef void(aws_mqtt5_publish_completion_fn)(
     void *complete_ctx);
 
 /**
- * Signature of callback invoked when a manual PUBACK operation completes.
+ * Signature of callback invoked when a manual publish acknowledgement operation completes.
  *
- * @param puback_result result of the PUBACK operation
+ * @param puback_result result of the publish acknowledgement operation
  * @param completion_user_data user data passed in with the completion options
  */
-typedef void(aws_mqtt5_manual_puback_completion_fn)(
-    enum aws_mqtt5_manual_puback_result puback_result,
+typedef void(aws_mqtt5_manual_publish_acknowledgement_completion_fn)(
+    enum aws_mqtt5_manual_publish_acknowledgement_result publish_acknowledgement_result,
     void *completion_user_data);
 
 /**
@@ -356,10 +356,10 @@ struct aws_mqtt5_publish_completion_options {
 };
 
 /**
- * Completion options for the manual puback operation
+ * Completion options for the manual publish acknowledgement operation
  */
-struct aws_mqtt5_manual_puback_completion_options {
-    aws_mqtt5_manual_puback_completion_fn *completion_callback;
+struct aws_mqtt5_manual_publish_acknowledgement_completion_options {
+    aws_mqtt5_manual_publish_acknowledgement_completion_fn *completion_callback;
     void *completion_user_data;
 };
 
@@ -757,33 +757,33 @@ int aws_mqtt5_client_publish(
     const struct aws_mqtt5_publish_completion_options *completion_options);
 
 /**
- * Takes manual control of PUBACK for the given PUBLISH packet.
+ * Takes manual control of publish acknowledgement for the given PUBLISH packet.
  *
  * This MUST only be called from within the publish received callback. A return value of 0 indicates an
  * invalid control id.
  *
- * @param client mqtt5 client that received the PUBLISH packet to take manual PUBACK control from.
- * @param publish_view the view of the PUBLISH packet that PUBACK control is taken from.
- * @return puback_control_id of the PUBLISH packet. This can be used to schedule a PUBACK for the PUBLISH packet
- * when used with the aws_mqtt5_client_invoke_puback function call.
+ * @param client mqtt5 client that received the PUBLISH packet to take manual publish acknowledgement control from.
+ * @param publish_view the view of the PUBLISH packet that publish acknowledgement control is taken from.
+ * @return pub_ack_control_id of the PUBLISH packet. This can be used to schedule a publish acknowledgement for the
+ * PUBLISH packet when used with the aws_mqtt5_client_invoke_publish_acknowledgement function call.
  */
-AWS_MQTT_API uint64_t aws_mqtt5_client_acquire_puback(
+AWS_MQTT_API uint64_t aws_mqtt5_client_acquire_publish_acknowledgement(
     struct aws_mqtt5_client *client,
     const struct aws_mqtt5_packet_publish_view *publish_view);
 
 /**
- * Send PUBACK for provided control id. Callback in completion_options will be invoked with an
- * aws_mqtt5_manual_puback_result once a PUBACK operation has been completed.
+ * Send publish acknowledgement for provided control id. Callback in completion_options will be invoked with an
+ * aws_mqtt5_manual_publish_acknowledgement_result once a publish acknowledgement operation has been completed.
  *
  * @param client mqtt5 client to queue a puback for
- * @param puback_control_id Control ID of aws_mqtt5_manual_puback_entry to send to broker/server
- * @return success/failure of starting the manual PUBACK operation.
+ * @param pub_ack_control_id Control ID of aws_mqtt5_manual_pub_ack_entry to send to broker/server
+ * @return success/failure of starting the manual publish acknowledgement operation.
  */
 AWS_MQTT_API
-int aws_mqtt5_client_invoke_puback(
+int aws_mqtt5_client_invoke_publish_acknowledgement(
     struct aws_mqtt5_client *client,
-    uint64_t puback_control_id,
-    const struct aws_mqtt5_manual_puback_completion_options *completion_options);
+    uint64_t pub_ack_control_id,
+    const struct aws_mqtt5_manual_publish_acknowledgement_completion_options *completion_options);
 
 /**
  * Queues a Subscribe operation in an mqtt5 client

include/aws/mqtt/v5/mqtt5_types.h

@@ -144,11 +144,11 @@ enum aws_mqtt5_puback_reason_code {
  * Result for manual PUBACK operations.
  *
  */
-enum aws_mqtt5_manual_puback_result {
-    AWS_MQTT5_MPR_SUCCESS = 0,
-    AWS_MQTT5_MPR_PUBACK_CANCELLED = 1,
-    AWS_MQTT5_MPR_PUBACK_INVALID = 2,
-    AWS_MQTT5_MPR_CRT_FAILURE = 3,
+enum aws_mqtt5_manual_publish_acknowledgement_result {
+    AWS_MQTT5_MPAR_SUCCESS = 0,
+    AWS_MQTT5_MPAR_PUBACK_CANCELLED = 1,
+    AWS_MQTT5_MPAR_PUBACK_INVALID = 2,
+    AWS_MQTT5_MPAR_CRT_FAILURE = 3,
 };
 
 /**
@@ -456,14 +456,14 @@ struct aws_mqtt5_packet_puback_view {
 };
 
 /**
- * This is used to track which PUBLISH packets a user has taken manual PUBACK control from.
+ * This is used to track which PUBLISH packets a user has taken manual publish acknowledgement control from.
  */
-struct aws_mqtt5_manual_puback_entry {
+struct aws_mqtt5_manual_pub_ack_entry {
     struct aws_allocator *allocator;
     struct aws_ref_count ref_count;
 
     /* control id for internal tracking */
-    uint64_t puback_control_id;
+    uint64_t pub_ack_control_id;
     /* packet_id of controlled publish */
     uint16_t packet_id;
 };