114 lines
3.9 KiB
C
114 lines
3.9 KiB
C
/**
|
|
* \addtogroup rime
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \defgroup rimestunicast Stubborn unicast
|
|
* @{
|
|
*
|
|
* The stubborn single-hop unicast primitive (stunicast) repeatedly
|
|
* sends a packet to a single-hop neighbor using the unicast
|
|
* primitive. The stunicast primitive sends and resends the packet
|
|
* until an upper layer primitive or protocol cancels the
|
|
* transmission. While it is possible for applications and protocols
|
|
* that use Rime to use the stubborn single-hop unicast primitive
|
|
* directly, the stuc primitive is primarily used by the reliable
|
|
* single-hop unicast (runicast) primitive.
|
|
*
|
|
* Before the stunicast primitive sends a packet, it allocates a queue
|
|
* buffer, to which the application data and packet attributes is
|
|
* copied, and sets a timer. When the timer expires, the stuc
|
|
* primitive copies the queue buffer to the Rime buffer and sends the
|
|
* packet using the uc primitive. The stuc primitive sets the number
|
|
* of retransmissions for a packet as a packet attribute on outgoing
|
|
* packets.
|
|
|
|
* \section channels Channels
|
|
*
|
|
* The stunicast 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: stunicast.h,v 1.2 2009/03/07 11:15:46 adamdunkels Exp $
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* Stubborn unicast header file
|
|
* \author
|
|
* Adam Dunkels <adam@sics.se>
|
|
*/
|
|
|
|
#ifndef __STUNICAST_H__
|
|
#define __STUNICAST_H__
|
|
|
|
#include "net/rime/unicast.h"
|
|
#include "net/rime/ctimer.h"
|
|
#include "net/rime/queuebuf.h"
|
|
|
|
struct stunicast_conn;
|
|
|
|
#define STUNICAST_ATTRIBUTES UNICAST_ATTRIBUTES
|
|
|
|
struct stunicast_callbacks {
|
|
void (* recv)(struct stunicast_conn *c, rimeaddr_t *from);
|
|
void (* sent)(struct stunicast_conn *c);
|
|
};
|
|
|
|
struct stunicast_conn {
|
|
struct unicast_conn c;
|
|
struct ctimer t;
|
|
struct queuebuf *buf;
|
|
const struct stunicast_callbacks *u;
|
|
rimeaddr_t receiver;
|
|
};
|
|
|
|
void stunicast_open(struct stunicast_conn *c, uint16_t channel,
|
|
const struct stunicast_callbacks *u);
|
|
void stunicast_close(struct stunicast_conn *c);
|
|
|
|
int stunicast_send_stubborn(struct stunicast_conn *c, rimeaddr_t *receiver,
|
|
clock_time_t rxmittime);
|
|
void stunicast_cancel(struct stunicast_conn *c);
|
|
|
|
int stunicast_send(struct stunicast_conn *c, rimeaddr_t *receiver);
|
|
|
|
void stunicast_set_timer(struct stunicast_conn *c, clock_time_t t);
|
|
|
|
rimeaddr_t *stunicast_receiver(struct stunicast_conn *c);
|
|
|
|
#endif /* __STUNICAST_H__ */
|
|
/** @} */
|
|
/** @} */
|