85b494c16b
Followed by doxyen file and group tags. This patch is only a first attempt to make provide a clean structure, many more files require rework, too.
95 lines
2.9 KiB
C
95 lines
2.9 KiB
C
/*
|
|
* Copyright (c) 2007, Swedish Institute of Computer Science.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the Institute nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* This file is part of the Contiki operating system.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* Header file for Trickle (reliable single source flooding) for Rime
|
|
* \author
|
|
* Adam Dunkels <adam@sics.se>
|
|
*/
|
|
|
|
/**
|
|
* \addtogroup rime
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \defgroup trickle Reliable single-source multi-hop flooding
|
|
* @{
|
|
*
|
|
* The trickle module sends a single packet to all nodes on the network.
|
|
*
|
|
* \section channels Channels
|
|
*
|
|
* The trickle module uses 1 channel.
|
|
*
|
|
*/
|
|
|
|
#ifndef TRICKLE_H_
|
|
#define TRICKLE_H_
|
|
|
|
#include "sys/ctimer.h"
|
|
|
|
#include "net/rime/broadcast.h"
|
|
#include "net/queuebuf.h"
|
|
|
|
#define TRICKLE_ATTRIBUTES { PACKETBUF_ATTR_EPACKET_ID, PACKETBUF_ATTR_BIT * 8 },\
|
|
BROADCAST_ATTRIBUTES
|
|
|
|
struct trickle_conn;
|
|
|
|
struct trickle_callbacks {
|
|
void (* recv)(struct trickle_conn *c);
|
|
};
|
|
|
|
struct trickle_conn {
|
|
struct broadcast_conn c;
|
|
const struct trickle_callbacks *cb;
|
|
struct ctimer t, interval_timer, first_transmission_timer;
|
|
struct pt pt;
|
|
struct queuebuf *q;
|
|
clock_time_t interval;
|
|
uint8_t seqno;
|
|
uint8_t interval_scaling;
|
|
uint8_t duplicates;
|
|
};
|
|
|
|
void trickle_open(struct trickle_conn *c, clock_time_t interval,
|
|
uint16_t channel, const struct trickle_callbacks *cb);
|
|
void trickle_close(struct trickle_conn *c);
|
|
|
|
void trickle_send(struct trickle_conn *c);
|
|
|
|
#endif /* TRICKLE_H_ */
|
|
/** @} */
|
|
/** @} */
|