contiki/core/net/rime/polite-announcement.h

73 lines
2.5 KiB
C
Raw Normal View History

/**
* \addtogroup rime
* @{
*/
/**
* \defgroup rimepoliteannouncement
* @{
*
* The polite announcement module implements a periodic explicit
* announcement. THe module announces the announcements that have been
* registered with the \ref rimeannouncement "announcement module".
*
* \section channels Channels
*
* The polite announcement module uses 1 channel.
*
*/
/*
* Copyright (c) 2006, 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-announcement.h,v 1.1 2009/02/05 19:32:01 adamdunkels Exp $
*/
/**
* \file
* Neighbor discovery header file
* \author
* Adam Dunkels <adam@sics.se>
*/
#ifndef __POLITE_ANNOUNCEMENT_H__
#define __POLITE_ANNOUNCEMENT_H__
#include "net/rime/announcement.h"
#include "net/rime/ipolite.h"
void polite_announcement_init(uint16_t channel,
clock_time_t min,
clock_time_t max);
#endif /* __POLITE_ANNOUNCEMENT_H__ */
/** @} */
/** @} */