osd-contiki/core/net/rime/runicast.h

/*
 * 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.
 *
 */

/**
 * \file
 *         Reliable unicast header file
 * \author
 *         Adam Dunkels <adam@sics.se>
 */

/**
 * \addtogroup rime
 * @{
 */

/**
 * \defgroup rimerunicast Single-hop reliable unicast
 * @{
 *
 * The reliable single-hop unicast primitive (runicast) reliably sends
 * a packet to a single-hop neighbor.  The runicast primitive uses
 * acknowledgements and retransmissions to ensure that the neighbor
 * successfully receives the packet.  When the receiver has
 * acknowledged the packet, the ruc module notifies the sending
 * application via a callback.  The ruc primitive uses the stubborn
 * single-hop unicast primitive to do retransmissions.  Thus, the ruc
 * primitive does not have to manage the details of setting up timers
 * and doing retransmissions, but can concentrate on dealing with
 * acknowledgements.
 *
 * The runicast primitive adds two packet attributes: the single-hop
 * packet type and the single-hop packet ID.  The runicast primitive
 * uses the packet ID attribute as a sequence number for matching
 * acknowledgement packets to the corresponding data packets.
 *
 * The application or protocol that uses the runicast primitive can
 * specify the maximum number of transmissions that the ruc module
 * should attempt before the packet times out.  If a packet times out,
 * the application or protocol that sent the packet is notified with a
 * callback.
 *
 *
 * \section runicast-channels Channels
 *
 * The runicast module uses 1 channel.
 *
 */

#ifndef RUNICAST_H_
#define RUNICAST_H_

#include "net/rime/stunicast.h"

struct runicast_conn;


#define RUNICAST_PACKET_ID_BITS 2

#define RUNICAST_ATTRIBUTES  { PACKETBUF_ATTR_PACKET_TYPE, PACKETBUF_ATTR_BIT }, \
                             { PACKETBUF_ATTR_PACKET_ID, PACKETBUF_ATTR_BIT * RUNICAST_PACKET_ID_BITS }, \
                             STUNICAST_ATTRIBUTES
struct runicast_callbacks {
  void (* recv)(struct runicast_conn *c, const linkaddr_t *from, uint8_t seqno);
  void (* sent)(struct runicast_conn *c, const linkaddr_t *to, uint8_t retransmissions);
  void (* timedout)(struct runicast_conn *c, const linkaddr_t *to, uint8_t retransmissions);
};

struct runicast_conn {
  struct stunicast_conn c;
  const struct runicast_callbacks *u;
  uint8_t sndnxt;
  uint8_t is_tx;
  uint8_t rxmit;
  uint8_t max_rxmit;
};

void runicast_open(struct runicast_conn *c, uint16_t channel,
	       const struct runicast_callbacks *u);
void runicast_close(struct runicast_conn *c);

int runicast_send(struct runicast_conn *c, const linkaddr_t *receiver,
		  uint8_t max_retransmissions);

uint8_t runicast_is_transmitting(struct runicast_conn *c);

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