/*
 * FreeRTOS BLE V2.2.0
 * 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.
 */


#ifndef IOT_BLE_MQTT_TRANSPORT_H
#define IOT_BLE_MQTT_TRANSPORT_H

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

#include "FreeRTOS.h"
#include "stream_buffer.h"

#include "iot_ble_mqtt_transport_config.h"
#include "iot_ble_mqtt_serialize.h"
#include "iot_ble_data_transfer.h"

/**
 * @brief Definition of the transport parameters for the transport interface
 * implementation that uses MQTT over BLE.
 */
typedef struct BleTransportParams
{
    IotBleDataTransferChannel_t * pChannel;
    StreamBufferHandle_t xStreamBuffer;
    StaticStreamBuffer_t xStreamBufferStruct;
    MQTTBLEPublishInfo_t publishInfo;
    TickType_t receiveTimeout;
} BleTransportParams_t;

/**
 * Forward declaration of NetworkContext.
 * Note: Do not directly include transport_interface.h header file, since in OCW console user may
 * chooes BLE without coreMQTT and coreHTTP. This can avoid the build error.
 */
struct NetworkContext;
typedef struct NetworkContext NetworkContext_t;

/**
 * @brief Initiailzes the Circular buffer to store the received data
 *
 * @param[in] pBuffer Pointer to the buffer allocated by the application and used by the transport interface to
 *            stream MQTT data.
 * @param[in] bufSize The size of the buffer allocated.
 * @param[out] pContext An opaque used by transport interface and to be passed to the MQTT library.
 * @return status of the initialization.
 */
bool IotBleMqttTransportInit( void * pBuffer,
                              size_t bufSize,
                              NetworkContext_t * pContext );

/**
 * @brief Cleans up the Circular buffer.
 *
 * @param[in] pContext An opaque used by transport interface.
 */
void IotBleMqttTransportCleanup( const NetworkContext_t * pContext );

/**
 * @brief Function to accept data from the channel
 *
 * @param[in] pContext An opaque used by transport interface.
 * @return the status of the accept
 */
MQTTBLEStatus_t IotBleMqttTransportAcceptData( const NetworkContext_t * pContext );

/**
 * @brief Transport interface write function.
 *
 * @param[in] pContext An opaque used by transport interface.
 * @param[in] pBuffer A pointer to a buffer containing data to be sent out.
 * @param[in] bytesToWrite number of bytes to write from the buffer.
 * @return the number of bytes sent.
 */
int32_t IotBleMqttTransportSend( NetworkContext_t * pContext,
                                 const void * pBuffer,
                                 size_t bytesToWrite );

/**
 * @brief Transport interface read function.
 *
 * @param[in] pContext An opaque used by transport interface.
 * @param[in] pBuffer A pointer to a buffer where incoming data will be stored.
 * @param[in] bytesToRead number of bytes to read from the transport layer.
 * @return the number of bytes successfully read.
 */
int32_t IotBleMqttTransportReceive( NetworkContext_t * pContext,
                                    void * pBuffer,
                                    size_t bytesToRead );


/**
 * @brief Sets the receive timeout for BLE transport interface.
 *
 * @param[in] pContext An opaque used by transport interface.
 * @param[in] timeoutMS Timeout value in Milliseconds.Setting a zero will make receive non-blocking.
 */
void IotBleMqttTransportSetReceiveTimeout( NetworkContext_t * pContext,
                                           uint32_t timeoutMS );

#endif /* ifndef IOT_BLE_MQTT_TRANSPORT_H */