/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * 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 mapMe.h
 * @brief MAP-Me : AnchorLess Producer Mobility Management
 */

#ifndef mapMe_h
#define mapMe_h

#ifdef WITH_MAPME

#include <stdbool.h>
#include <stdint.h>

#include <src/io/hicnListener.h>

#include <hicn/hicn.h>
#include <src/utils/commands.h>

struct mapme;
typedef struct mapme MapMe;

/**
 * @function MapMe_Init
 * @abstract Initializes MAP-Me state in the forwarder.
 * @return bool - Boolean informing about the success of MAP-Me initialization.
 */
bool mapMe_Init(MapMe **mapme, Forwarder *Forwarder);

/**
 * @function messageHandler_isMapMe
 * @abstract Identifies MAP-Me messages
 * @discussion This function can be used by the forwarder to dispatch MAP-Me
 * 	message to the appropriate processing function. Ideally this would be
 *      done through hooks defined in the Init function.
 * @param [in] msgBuffer - The buffer to match
 * @return A boolean indicating whether message is a MAP-Me control message.
 */
bool mapMe_isMapMe(const uint8_t *msgBuffer);

/**
 * @function mapMe_handleMapMeMessage
 * @abstract Process a MAP-Me message.
 * @param [in] mapme - Pointer to the MAP-Me data structure.
 * @param [in] message - MAP-Me buffer
 * @param [in] conn_id - Ingress connection id
 */
void mapMe_Process(const MapMe *mapme, const uint8_t *msgBuffer,
                   unsigned conn_id);

/**
 * @function mapMe_onConnectionAdded
 * @abstract Callback following the addition of the face though the control
 * protocol.
 * @discussion This callback triggers the sending of control packets by MAP-Me.
 * @param [in] mapme - Pointer to the MAP-Me data structure.
 * @param [in] conn - The newly added connection.
 */
void mapMe_onConnectionAdded(const MapMe *mapme, const Connection *conn);

/**
 * @function mapMe_getNextHops
 * @abstract return the nexthops to forward interests defined by mapme, it
 *   covers also the case where local discovery mechanisms are trriggered.
 */
NumberSet *mapMe_getNextHops(const MapMe *mapme, FibEntry *fibEntry,
                             const Message *interest);

hicn_mapme_type_t mapMe_PktType_To_LibHicnPktType(MessagePacketType type);

MessagePacketType mapMe_LibHicnPktType_To_PktType(hicn_mapme_type_t type);

#endif /* WITH_MAPME */

#endif  // mapMe_h