mirror of
https://github.com/FreeRTOS/FreeRTOS-Kernel.git
synced 2025-10-17 02:07:48 -04:00
Fix MISRA warnings for platform code used by MQTT demos (#337)
In addition to fixing MISRA warnings, code is updated to have complexity <= 8. Also, this adds changes from PR #313, which allows the support of simultaneous connections in the mbedTLS transport wrapper. Co-authored-by: Muneeb Ahmed <54290492+muneebahmed10@users.noreply.github.com>
This commit is contained in:
Oscar Michael Abrina
GitHub
parent
02aafc3a46
commit
5f0bf944cb
13 changed files with 1196 additions and 887 deletions
|
|
@ -19,6 +19,11 @@
|
|||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file transport_interface.h
|
||||
* @brief Transport interface definitions to send and receive data over the
|
||||
* network.
|
||||
*/
|
||||
#ifndef TRANSPORT_INTERFACE_H_
|
||||
#define TRANSPORT_INTERFACE_H_
|
||||
|
||||
|
|
@ -26,14 +31,131 @@
|
|||
#include <stddef.h>
|
||||
|
||||
/**
|
||||
* @brief The NetworkContext is an incomplete type. An implementation of this
|
||||
* interface must define NetworkContext as per the requirements. This context
|
||||
* is passed into the network interface functions.
|
||||
* @transportpage
|
||||
* @brief The transport interface definition.
|
||||
*
|
||||
* @transportsectionoverview
|
||||
*
|
||||
* The transport interface is a set of APIs that must be implemented using an
|
||||
* external transport layer protocol. The transport interface is defined in
|
||||
* @ref transport_interface.h. This interface allows protocols like MQTT and
|
||||
* HTTP to send and receive data over the transport layer. This
|
||||
* interface does not handle connection and disconnection to the server of
|
||||
* interest. The connection, disconnection, and other transport settings, like
|
||||
* timeout and TLS setup, must be handled in the user application.
|
||||
* <br>
|
||||
*
|
||||
* The functions that must be implemented are:<br>
|
||||
* - [Transport Receive](@ref TransportRecv_t)
|
||||
* - [Transport Send](@ref TransportSend_t)
|
||||
*
|
||||
* Each of the functions above take in an opaque context @ref NetworkContext_t.
|
||||
* The functions above and the context are also grouped together in the
|
||||
* @ref TransportInterface_t structure:<br><br>
|
||||
* @snippet this define_transportinterface
|
||||
* <br>
|
||||
*
|
||||
* @transportsectionimplementation
|
||||
*
|
||||
* The following steps give guidance on implementing the transport interface:
|
||||
*
|
||||
* -# Implementing @ref NetworkContext_t<br><br>
|
||||
* @snippet this define_networkcontext
|
||||
* <br>
|
||||
* @ref NetworkContext_t is the incomplete type <b>struct NetworkContext</b>.
|
||||
* The implemented struct NetworkContext must contain all of the information
|
||||
* that is needed to receive and send data with the @ref TransportRecv_t
|
||||
* and the @ref TransportSend_t implementations.<br>
|
||||
* In the case of TLS over TCP, struct NetworkContext is typically implemented
|
||||
* with the TCP socket context and a TLS context.<br><br>
|
||||
* <b>Example code:</b>
|
||||
* @code{c}
|
||||
* struct NetworkContext
|
||||
* {
|
||||
* struct MyTCPSocketContext tcpSocketContext;
|
||||
* struct MyTLSContext tlsContext;
|
||||
* };
|
||||
* @endcode
|
||||
* <br>
|
||||
* -# Implementing @ref TransportRecv_t<br><br>
|
||||
* @snippet this define_transportrecv
|
||||
* <br>
|
||||
* This function is expected to populate a buffer, with bytes received from the
|
||||
* transport, and return the number of bytes placed in the buffer.
|
||||
* In the case of TLS over TCP, @ref TransportRecv_t is typically implemented by
|
||||
* calling the TLS layer function to receive data. In case of plaintext TCP
|
||||
* without TLS, it is typically implemented by calling the TCP layer receive
|
||||
* function. @ref TransportRecv_t may be invoked multiple times by the protocol
|
||||
* library, if fewer bytes than were requested to receive are returned.
|
||||
* <br><br>
|
||||
* <b>Example code:</b>
|
||||
* @code{c}
|
||||
* int32_t myNetworkRecvImplementation( const NetworkContext_t * pNetworkContext,
|
||||
* void * pBuffer,
|
||||
* size_t bytesToRecv )
|
||||
* {
|
||||
* int32_t bytesReceived = 0;
|
||||
* bytesReceived = TLSRecv( pNetworkContext->tlsContext,
|
||||
* pBuffer,
|
||||
* bytesToRecv,
|
||||
* MY_SOCKET_TIMEOUT );
|
||||
* if( bytesReceived < 0 )
|
||||
* {
|
||||
* // Handle socket error.
|
||||
* }
|
||||
* // Handle other cases.
|
||||
*
|
||||
* return bytesReceived;
|
||||
* }
|
||||
* @endcode
|
||||
* <br>
|
||||
* -# Implementing @ref TransportSend_t<br><br>
|
||||
* @snippet this define_transportsend
|
||||
* <br>
|
||||
* This function is expected to send the bytes, in the given buffer over the
|
||||
* transport, and return the number of bytes sent.
|
||||
* In the case of TLS over TCP, @ref TransportSend_t is typically implemented by
|
||||
* calling the TLS layer function to send data. In case of plaintext TCP
|
||||
* without TLS, it is typically implemented by calling the TCP layer send
|
||||
* function. @ref TransportSend_t may be invoked multiple times by the protocol
|
||||
* library, if fewer bytes than were requested to send are returned.
|
||||
* <br><br>
|
||||
* <b>Example code:</b>
|
||||
* @code{c}
|
||||
* int32_t myNetworkSendImplementation( const NetworkContext_t * pNetworkContext,
|
||||
* const void * pBuffer,
|
||||
* size_t bytesToSend )
|
||||
* {
|
||||
* int32_t bytesSent = 0;
|
||||
* bytesSent = TLSSend( pNetworkContext->tlsContext,
|
||||
* pBuffer,
|
||||
* bytesToSend,
|
||||
* MY_SOCKET_TIMEOUT );
|
||||
* if( bytesSent < 0 )
|
||||
* {
|
||||
* // Handle socket error.
|
||||
* }
|
||||
* // Handle other cases.
|
||||
*
|
||||
* return bytesSent;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
struct NetworkContext;
|
||||
typedef struct NetworkContext NetworkContext_t;
|
||||
|
||||
/**
|
||||
* @transportstruct
|
||||
* @typedef NetworkContext_t
|
||||
* @brief The NetworkContext is an incomplete type. An implementation of this
|
||||
* interface must define struct NetworkContext for the system requirements.
|
||||
* This context is passed into the network interface functions.
|
||||
*/
|
||||
/* @[define_networkcontext] */
|
||||
struct NetworkContext;
|
||||
typedef struct NetworkContext NetworkContext_t;
|
||||
/* @[define_networkcontext] */
|
||||
|
||||
/**
|
||||
* @transportcallback
|
||||
* @brief Transport interface for receiving data on the network.
|
||||
*
|
||||
* @param[in] pNetworkContext Implementation-defined network context.
|
||||
|
|
@ -42,11 +164,14 @@ typedef struct NetworkContext NetworkContext_t;
|
|||
*
|
||||
* @return The number of bytes received or a negative error code.
|
||||
*/
|
||||
typedef int32_t ( * TransportRecv_t )( NetworkContext_t * pNetworkContext,
|
||||
/* @[define_transportrecv] */
|
||||
typedef int32_t ( * TransportRecv_t )( const NetworkContext_t * pNetworkContext,
|
||||
void * pBuffer,
|
||||
size_t bytesToRecv );
|
||||
/* @[define_transportrecv] */
|
||||
|
||||
/**
|
||||
* @transportcallback
|
||||
* @brief Transport interface for sending data over the network.
|
||||
*
|
||||
* @param[in] pNetworkContext Implementation-defined network context.
|
||||
|
|
@ -55,18 +180,23 @@ typedef int32_t ( * TransportRecv_t )( NetworkContext_t * pNetworkContext,
|
|||
*
|
||||
* @return The number of bytes sent or a negative error code.
|
||||
*/
|
||||
typedef int32_t ( * TransportSend_t )( NetworkContext_t * pNetworkContext,
|
||||
/* @[define_transportsend] */
|
||||
typedef int32_t ( * TransportSend_t )( const NetworkContext_t * pNetworkContext,
|
||||
const void * pBuffer,
|
||||
size_t bytesToSend );
|
||||
/* @[define_transportsend] */
|
||||
|
||||
/**
|
||||
* @transportstruct
|
||||
* @brief The transport layer interface.
|
||||
*/
|
||||
/* @[define_transportinterface] */
|
||||
typedef struct TransportInterface
|
||||
{
|
||||
TransportRecv_t recv; /**< Transport receive interface. */
|
||||
TransportSend_t send; /**< Transport send interface. */
|
||||
NetworkContext_t * pNetworkContext; /**< Implementation-defined network context. */
|
||||
} TransportInterface_t;
|
||||
/* @[define_transportinterface] */
|
||||
|
||||
#endif /* ifndef TRANSPORT_INTERFACE_H_ */
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue