Polite broadcast primitive

This commit is contained in:
adamdunkels 2007-05-15 07:41:22 +00:00
parent 5728570aa4
commit f539f4efd8
2 changed files with 229 additions and 0 deletions

140
core/net/rime/polite.c Normal file
View file

@ -0,0 +1,140 @@
/**
* \addtogroup rimepolite
* @{
*/
/*
* 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.
*
* $Id: polite.c,v 1.1 2007/05/15 07:41:22 adamdunkels Exp $
*/
/**
* \file
* Polite Anonymous best effort local area BroadCast (polite)
* \author
* Adam Dunkels <adam@sics.se>
*/
#include "net/rime.h"
#include "net/rime/polite.h"
#include "lib/rand.h"
#include <string.h>
#define MAX(a,b) ((a)>(b)?(a):(b))
/*---------------------------------------------------------------------------*/
static void
recv(struct abc_conn *abc)
{
struct polite_conn *c = (struct polite_conn *)abc;
if(c->q != NULL &&
rimebuf_datalen() == queuebuf_datalen(c->q) &&
memcmp(rimebuf_dataptr(), queuebuf_dataptr(c->q),
MAX(c->hdrsize, rimebuf_datalen())) == 0) {
/* We received a copy of our own packet, so we do not send out
packet. */
queuebuf_free(c->q);
c->q = NULL;
ctimer_stop(&c->t);
if(c->cb->dropped) {
c->cb->dropped(c);
}
}
if(c->cb->recv) {
c->cb->recv(c);
}
}
/*---------------------------------------------------------------------------*/
static void
send(void *ptr)
{
struct polite_conn *c = ptr;
if(c->q != NULL) {
queuebuf_to_rimebuf(c->q);
queuebuf_free(c->q);
c->q = NULL;
abc_send(&c->c);
if(c->cb->sent) {
c->cb->sent(c);
}
}
}
/*---------------------------------------------------------------------------*/
static const struct abc_callbacks abc = { recv };
/*---------------------------------------------------------------------------*/
void
polite_open(struct polite_conn *c, u16_t channel,
const struct polite_callbacks *cb)
{
abc_open(&c->c, channel, &abc);
c->cb = cb;
}
/*---------------------------------------------------------------------------*/
void
polite_close(struct polite_conn *c)
{
abc_close(&c->c);
ctimer_stop(&c->t);
if(c->q != NULL) {
queuebuf_free(c->q);
c->q = NULL;
}
}
/*---------------------------------------------------------------------------*/
int
polite_send(struct polite_conn *c, clock_time_t interval, u8_t hdrsize)
{
if(c->q != NULL) {
/* If we are already about to send a packet, we cancel the old one. */
queuebuf_free(c->q);
}
c->hdrsize = hdrsize;
c->q = queuebuf_new_from_rimebuf();
if(c->q != NULL) {
ctimer_set(&c->t, interval / 2 + (random_rand() % (interval / 2)), send, c);
return 1;
}
return 0;
}
/*---------------------------------------------------------------------------*/
void
polite_cancel(struct polite_conn *c)
{
ctimer_stop(&c->t);
if(c->q != NULL) {
queuebuf_free(c->q);
c->q = NULL;
}
}
/*---------------------------------------------------------------------------*/
/** @} */

89
core/net/rime/polite.h Normal file
View file

@ -0,0 +1,89 @@
/**
* \addtogroup rime
* @{
*/
/**
* \defgroup rimepolite Polite anonymous best effort local broadcast
* @{
*
* The polite module sends one anonymous packet that is unique within a
* time interval.
*
* \section channels Channels
*
* The polite module uses 1 channel.
*
*/
/*
* 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.
*
* $Id: polite.h,v 1.1 2007/05/15 07:41:22 adamdunkels Exp $
*/
/**
* \file
* Header file for Polite Anonymous best effort local Broadcast (polite)
* \author
* Adam Dunkels <adam@sics.se>
*/
#ifndef __POLITE_H__
#define __POLITE_H__
#include "net/rime.h"
struct polite_conn;
struct polite_callbacks {
void (* recv)(struct polite_conn *c);
void (* sent)(struct polite_conn *c);
void (* dropped)(struct polite_conn *c);
};
struct polite_conn {
struct abc_conn c;
const struct polite_callbacks *cb;
struct ctimer t;
struct queuebuf *q;
u8_t hdrsize;
};
void polite_open(struct polite_conn *c, u16_t channel,
const struct polite_callbacks *cb);
void polite_close(struct polite_conn *c);
int polite_send(struct polite_conn *c, clock_time_t interval, u8_t hdrsize);
void polite_cancel(struct polite_conn *c);
#endif /* __POLITE_H__ */
/** @} */
/** @} */