iot_platform_types.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_PLATFORM_TYPES_H_
#define IOT_PLATFORM_TYPES_H_

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

/* Linear containers (lists and queues) include for metrics types. */
#include "iot_linear_containers.h"

/*------------------------- Thread management types -------------------------*/

#define IOT_THREAD_IGNORE_PRIORITY      ( -1 )

#define IOT_THREAD_IGNORE_STACK_SIZE    ( 0 )

#ifndef IOT_THREAD_DEFAULT_PRIORITY
    #define IOT_THREAD_DEFAULT_PRIORITY    IOT_THREAD_IGNORE_PRIORITY
#endif

#ifndef IOT_THREAD_DEFAULT_STACK_SIZE
    #define IOT_THREAD_DEFAULT_STACK_SIZE    IOT_THREAD_IGNORE_STACK_SIZE
#endif

typedef _IotSystemMutex_t       IotMutex_t;

typedef _IotSystemSemaphore_t   IotSemaphore_t;

typedef void ( * IotThreadRoutine_t )( void * pArgument );

/*-------------------------- Clock and timer types --------------------------*/

typedef _IotSystemTimer_t          IotTimer_t;

/*--------------------------- Network stack types ---------------------------*/

typedef _IotNetworkServerInfo_t    IotNetworkServerInfo_t;

typedef _IotNetworkCredentials_t   IotNetworkCredentials_t;

typedef _IotNetworkConnection_t    IotNetworkConnection_t;

/*------------------------------ Metrics types ------------------------------*/

#define IOT_METRICS_IP_ADDRESS_LENGTH    54

typedef struct IotMetricsTcpConnection
{
    IotLink_t link;         
    void * pNetworkContext; 
    size_t addressLength;   
    char pRemoteAddress[ IOT_METRICS_IP_ADDRESS_LENGTH ];
} IotMetricsTcpConnection_t;

#endif /* ifndef IOT_PLATFORM_TYPES_H_ */