//*****************************************************************
//
// Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
//
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
//****************************************************************

/**
 * @file caraadapter.h
 * This file contains the APIs for IP Adapter.
 */
#ifndef CA_RA_ADAPTER_H_
#define CA_RA_ADAPTER_H_

#include "cacommon.h"
#include "caadapterinterface.h"
#include "cainterface.h"
#include "cathreadpool.h"

#ifdef __cplusplus
extern "C"
{
#endif


/**
 * API to initialize RA Interface.
 * @param[in] registerCallback      Callback to register RA interfaces to
 *                                   Connectivity Abstraction Layer.
 * @param[in] networkPacketCallback Callback to notify request and
 *                                   response messages from server(s)
 *                                   started at Connectivity Abstraction Layer.
 * @param[in] netCallback           Callback to notify the network
 *                                   additions to Connectivity Abstraction
 *                                   Layer.
 * @param[in] handle                Threadpool Handle.
 * @return  ::CA_STATUS_OK or Appropriate error code.
 */
CAResult_t CAInitializeRA(CARegisterConnectivityCallback registerCallback,
                          CANetworkPacketReceivedCallback networkPacketCallback,
                          CANetworkChangeCallback netCallback,
                          ca_thread_pool_t handle);


/**
 * Start RA Interface adapter.
 * @return  ::CA_STATUS_OK or Appropriate error code.
 */
CAResult_t CAStartRA();

/**
 * Sends data to the endpoint using the adapter connectivity.
 * @param[in]   endpoint    Remote Endpoint information (like ipaddress, port,
 *                           reference uri and transport type) to which
 *                           the unicast data has to be sent.
 * @param[in]   data        Data which is required to be sent.
 * @param[in]   dataLen     Size of data to be sent.
 * @note dataLen must be > 0.
 * @return The number of bytes sent on the network, or -1 upon error.
 */
int32_t CASendRAUnicastData(const CAEndpoint_t *endpoint, const void *data,
                            uint32_t dataLen);

/**
 * Get RA Connectivity network information.
 * @param[out]   info        Local connectivity information structures.
 * @note info is allocated in this API and should be freed by the caller.
 * @param[out]   size        Number of local connectivity structures.
 * @return  ::CA_STATUS_OK or Appropriate error code.
 */
CAResult_t CAGetRAInterfaceInformation(CAEndpoint_t **info, uint32_t *size);

/**
 * Stops RA server and de-register XMPP callback listeners.
 * @return  ::CA_STATUS_OK or Appropriate error code.
 */
CAResult_t CAStopRA();

/**
 * Terminate the RA connectivity adapter.
 * Configuration information will be deleted from further use.
 */
void CATerminateRA();

/**
 * Set Remote Access information for XMPP Client.
 * @param[in]   caraInfo            remote access info.
 *
 * @return  ::CA_STATUS_OK.
 */
CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo);

/**
 * These functions are not applicable to Remote Access adapter.
 */
int32_t CASendRAMulticastData(const CAEndpoint_t *endpoint,
                 const void *data, uint32_t dataLen);

/**
 * Start listening server for receiving search requests.
 * @return  ::CA_NOT_SUPPORTED.
 */
CAResult_t CAStartRAListeningServer();

/**
 * Start discovery servers for receiving advertisements.
 * @return  ::CA_NOT_SUPPORTED.
 */
CAResult_t CAStartRADiscoveryServer();

/**
 * Read Synchronous API callback.
 * @return  ::CA_NOT_SUPPORTED.
 */
CAResult_t CAReadRAData();

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif  //CA_RA_ADAPTER_H_