iot_network.h

Go to the documentation of this file.

/*
 * FreeRTOS Platform V1.1.2
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef IOT_NETWORK_H_
#define IOT_NETWORK_H_

/* Standard includes. */
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

typedef enum IotNetworkError
{
    IOT_NETWORK_SUCCESS = 0,   
    IOT_NETWORK_FAILURE,       
    IOT_NETWORK_BAD_PARAMETER, 
    IOT_NETWORK_NO_MEMORY,     
    IOT_NETWORK_SYSTEM_ERROR   
} IotNetworkError_t;

/* @[declare_platform_network_receivecallback] */
typedef void ( * IotNetworkReceiveCallback_t )( void * pConnection,
                                                void * pContext );
/* @[declare_platform_network_receivecallback] */

typedef struct IotNetworkInterface
{
    /* @[declare_platform_network_create] */
    IotNetworkError_t ( * create )( void * pConnectionInfo,
                                    void * pCredentialInfo,
                                    void ** pConnection );
    /* @[declare_platform_network_create] */

    /* @[declare_platform_network_setreceivecallback] */
    IotNetworkError_t ( * setReceiveCallback )( void * pConnection,
                                                IotNetworkReceiveCallback_t receiveCallback,
                                                void * pContext );
    /* @[declare_platform_network_setreceivecallback] */

    /* @[declare_platform_network_send] */
    size_t ( * send )( void * pConnection,
                       const uint8_t * pMessage,
                       size_t messageLength );
    /* @[declare_platform_network_send] */

    /* @[declare_platform_network_receive] */
    size_t ( * receive )( void * pConnection,
                          uint8_t * pBuffer,
                          size_t bytesRequested );
    /* @[declare_platform_network_receive] */

    /* @[declare_platform_network_receiveupto] */
    size_t ( * receiveUpto )( void * pConnection,
                              uint8_t * pBuffer,
                              size_t bufferSize );
    /* @[declare_platform_network_receiveupto] */

    /* @[declare_platform_network_close] */
    IotNetworkError_t ( * close )( void * pConnection );
    /* @[declare_platform_network_close] */

    /* @[declare_platform_network_destroy] */
    IotNetworkError_t ( * destroy )( void * pConnection );
    /* @[declare_platform_network_destroy] */
} IotNetworkInterface_t;

typedef struct IotNetworkServerInfo
{
    const char * pHostName; 
    uint16_t port;          
} IotNetworkServerInfo_t;

typedef struct IotNetworkCredentials
{
    const char * pAlpnProtos;

    size_t maxFragmentLength;

    bool disableSni;

    const char * pRootCa;     
    size_t rootCaSize;        
    const char * pClientCert; 
    size_t clientCertSize;    
    const char * pPrivateKey; 
    size_t privateKeySize;    
} IotNetworkCredentials_t;

#endif /* ifndef IOT_NETWORK_H_ */