Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update core_mqtt.h #208

Merged
merged 3 commits into from
Sep 9, 2022
Merged

Update core_mqtt.h #208

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f744520
Update core_mqtt.h
jasonpcarroll Sep 9, 2022
0102b90
Merge branch 'dev' into jasonpcarroll-patch-1
AniruddhaKanhere Sep 9, 2022
16b5e4c
Update core_mqtt.h
jasonpcarroll Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions source/include/core_mqtt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ typedef struct MQTTDeserializedInfo
/**
* @brief Initialize an MQTT context.
*
* This function must be called on a #MQTTContext_t before any other function.
* This function must be called on an #MQTTContext_t before any other function.
*
* @note The #MQTTGetCurrentTimeFunc_t function for querying time must be defined. If
* there is no time implementation, it is the responsibility of the application
Expand Down Expand Up @@ -324,17 +324,9 @@ MQTTStatus_t MQTT_Init( MQTTContext_t * pContext,
/* @[declare_mqtt_init] */

/**
* @brief Initialize an MQTT context.
*
* This function must be called on a #MQTTContext_t before any other function.
* @brief Initialize an MQTT context for QoS > 0.
*
* @note The #MQTTGetCurrentTimeFunc_t function for querying time must be defined. If
* there is no time implementation, it is the responsibility of the application
* to provide a dummy function to always return 0, provide 0 timeouts for
* all calls to #MQTT_Connect, #MQTT_ProcessLoop, and #MQTT_ReceiveLoop and configure
* the #MQTT_RECV_POLLING_TIMEOUT_MS and #MQTT_SEND_RETRY_TIMEOUT_MS configurations
* to be 0. This will result in loop functions running for a single iteration, and
* #MQTT_Connect relying on #MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT to receive the CONNACK packet.
* This function must be called on an #MQTTContext_t after MQTT_Init and before any other function.
*
* @param[in] pContext The context to initialize.
* @param[in] pOutgoingPublishRecords Pointer to memory which will be used to store state of outgoing
Expand Down