espressif/FreeRTOS
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS.git synced 2025-06-26 11:42:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update comments about NetworkContext definition (#461)

Browse Source 
Small change that simply specifies why the NetworkContext must be defined by each compilation unit along with details on how to include it to your project.

Co-authored-by: Cobus van Eeden <35851496+cobusve@users.noreply.github.com>
This commit is contained in:
Oscar Michael Abrina
2020-12-11 11:09:03 -08:00
committed by GitHub
parent d264c1f153
commit 1c2c671e7a
19 changed files with 136 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
FreeRTOS-Plus/Demo/AWS/Mqtt_Demo_Helpers/mqtt_demo_helpers.c
View File

@ -202,7 +202,13 @@ typedef struct PublishPackets
/*-----------------------------------------------------------*/
/* Each compilation unit must define the NetworkContext struct. */
/**
* @brief Each compilation unit that consumes the NetworkContext must define it.
* It should contain a single pointer to the type of your desired transport.
* When using multiple transports in the same compilation unit, define this pointer as void *.
*
* @note Transport stacks are defined in FreeRTOS-Plus/Source/Application-Protocols/network_transport.
*/
struct NetworkContext
{
TlsTransportParams_t * pParams;