iot_ble_data_transfer.h

/*
 * 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.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef IOT_BLE_DATA_TRANSFER_H
#define IOT_BLE_DATA_TRANSFER_H

#include <stdlib.h>
#include <string.h>
#include <stdbool.h>

/*
 * @brief Events related to a ble data transfer channel.
 */
typedef enum IotBleDataTransferChannelEvent
{
    IOT_BLE_DATA_TRANSFER_CHANNEL_OPENED = 0,    
    IOT_BLE_DATA_TRANSFER_CHANNEL_DATA_RECEIVED, 
    IOT_BLE_DATA_TRANSFER_CHANNEL_DATA_SENT,     
    IOT_BLE_DATA_TRANSFER_CHANNEL_CLOSED         
} IotBleDataTransferChannelEvent_t;

typedef struct IotBleDataTransferChannel IotBleDataTransferChannel_t;

typedef void ( * IotBleDataTransferChannelCallback_t ) ( IotBleDataTransferChannelEvent_t event,
                                                         IotBleDataTransferChannel_t * pChannel,
                                                         void * pContext );

bool IotBleDataTransfer_Init( void );

IotBleDataTransferChannel_t * IotBleDataTransfer_Open( uint8_t channelIdentifier );

bool IotBleDataTransfer_SetCallback( IotBleDataTransferChannel_t * pChannel,
                                     const IotBleDataTransferChannelCallback_t callback,
                                     void * pContext );

size_t IotBleDataTransfer_Send( IotBleDataTransferChannel_t * pChannel,
                                const uint8_t * const pMessage,
                                size_t messageLength );

size_t IotBleDataTransfer_Receive( IotBleDataTransferChannel_t * pChannel,
                                   uint8_t * pBuffer,
                                   size_t bytesRequested );

void IotBleDataTransfer_PeekReceiveBuffer( IotBleDataTransferChannel_t * pChannel,
                                           const uint8_t ** pBuffer,
                                           size_t * pBufferLength );

void IotBleDataTransfer_Close( IotBleDataTransferChannel_t * pChannel );


void IotBleDataTransfer_Reset( IotBleDataTransferChannel_t * pChannel );


bool IotBleDataTransfer_Cleanup( void );

#endif /* IOT_BLE_DATA_TRANSFER_H */