iot_network.h

Go to the documentation of this file.

/*
 * IoT Platform V1.1.0
 * Copyright (C) 2019 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.
 */

#ifndef IOT_NETWORK_H_
#define IOT_NETWORK_H_

/* The config header is always included first. */
#include "iot_config.h"

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

/* Platform types include. */
#include "types/iot_platform_types.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;

typedef enum IotNetworkCloseReason
{
    IOT_NETWORK_NOT_CLOSED = 0,    
    IOT_NETWORK_SERVER_CLOSED,     
    IOT_NETWORK_TRANSPORT_FAILURE, 
    IOT_NETWORK_CLIENT_CLOSED,     
    IOT_NETWORK_UNKNOWN_CLOSED     
} IotNetworkCloseReason_t;

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

/* @[declare_platform_network_closecallback] */
typedef void ( * IotNetworkCloseCallback_t )( IotNetworkConnection_t pConnection,
                                              IotNetworkCloseReason_t reason,
                                              void * pContext );
/* @[declare_platform_network_closecallback] */

/* @[declare_platform_network_create] */
typedef IotNetworkError_t ( * IotNetworkCreate_t )( IotNetworkServerInfo_t pServerInfo,
                                                    IotNetworkCredentials_t pCredentialInfo,
                                                    IotNetworkConnection_t * pConnection );
/* @[declare_platform_network_create] */

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

/* @[declare_platform_network_setclosecallback] */
typedef IotNetworkError_t ( * IotNetworkSetCloseCallback_t )( IotNetworkConnection_t pConnection,
                                                              IotNetworkCloseCallback_t closeCallback,
                                                              void * pContext );
/* @[declare_platform_network_setclosecallback] */

/* @[declare_platform_network_send] */
typedef size_t ( * IotNetworkSend_t )( IotNetworkConnection_t pConnection,
                                       const uint8_t * pMessage,
                                       size_t messageLength );
/* @[declare_platform_network_send] */

/* @[declare_platform_network_receive] */
typedef size_t ( * IotNetworkReceive_t )( IotNetworkConnection_t pConnection,
                                          uint8_t * pBuffer,
                                          size_t bytesRequested );
/* @[declare_platform_network_receive] */

/* @[declare_platform_network_close] */
typedef IotNetworkError_t ( * IotNetworkClose_t )( IotNetworkConnection_t pConnection );
/* @[declare_platform_network_close] */

/* @[declare_platform_network_destroy] */
typedef IotNetworkError_t ( * IotNetworkDestroy_t )( IotNetworkConnection_t pConnection );
/* @[declare_platform_network_destroy] */

typedef struct IotNetworkInterface
{
    IotNetworkCreate_t create;                         
    IotNetworkSetReceiveCallback_t setReceiveCallback; 
    IotNetworkSetCloseCallback_t setCloseCallback;     
    IotNetworkSend_t send;                             
    IotNetworkReceive_t receive;                       
    IotNetworkClose_t close;                           
    IotNetworkDestroy_t destroy;                       
} IotNetworkInterface_t;

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

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;    
    const char * pUserName;   
    size_t userNameSize;      
    const char * pPassword;   
    size_t passwordSize;      
};

#endif /* ifndef IOT_NETWORK_H_ */