discovery.h

Go to the documentation of this file.

/**
 * \addtogroup agent
 * @{
 */

/**
 * \defgroup discovery Discovery modules
 *
 * @{
 */

/**
 * \file
 * \brief defines the interface for discovery modules
 * \author Georg von Zengen <vonzeng@ibr.cs.tu-bs.de>
 */

#ifndef DISCOVERY_H
#define DISCOVERY_H

#include "contiki.h"
#include "rime.h"
#include "process.h"

/**
 * Which discovery driver are we going to use?
 */
#ifdef CONF_DISCOVERY
#define DISCOVERY CONF_DISCOVERY
#else
#define DISCOVERY discovery_ipnd
#endif

PROCESS_NAME(discovery_process);

struct discovery_neighbour_list_entry {
        struct discovery_neighbour_list_entry *next;
        rimeaddr_t neighbour;
};

/** interface for discovery modules */
struct discovery_driver {
        char *name;

        /**
         * Initialize discovery module
         */
        void (* init)();

        /**
         * Ask discovery, if this node is currently in range
         * return 1 if yes,
         * return 0 otherwise
         */
        uint8_t (* is_neighbour)(rimeaddr_t * dest);

        /**
         * Enable discovery module
         */
        void (* enable)();

        /**
         * Disable discovery module
         */
        void (* disable)();

        /**
         * Pass incoming discovery beacons to the discovery module
         */
        void (* receive)(rimeaddr_t * source, uint8_t * payload, uint8_t length);

        /**
         * Bundle from node has been received, cache this node as available
         */
        void (* alive)(rimeaddr_t * source);

        /**
         * Multiple transmission attempts to this neighbour have failed
         */
        void (* dead)(rimeaddr_t * destination);

        /**
         * Starts to discover a neighbour
         */
        uint8_t (* discover)(rimeaddr_t * dest);

        /**
         * Returns the list of currently known neighbours
         */
        struct discovery_neighbour_list_entry * (* neighbours)();

        /**
         * Stops pending discoveries
         */
        void (* stop_pending)();
};

extern const struct discovery_driver DISCOVERY;

#endif
/** @} */
/** @} */