osd-contiki/core/net/rime/rimeaddr.h
nvt-se 9277f922f1 fixed some documentation typos.
also uc -> unicast, stuc -> stunicast.
2009-05-26 13:58:53 +00:00

133 lines
4.1 KiB
C

/**
* \addtogroup rime
* @{
*/
/**
* \defgroup rimeaddr Rime addresses
* @{
*
* The rimeaddr module is an abstract representation of addresses in
* Rime.
*
*/
/*
* 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: rimeaddr.h,v 1.6 2009/05/26 13:58:53 nvt-se Exp $
*/
/**
* \file
* Header file for the Rime address representation
* \author
* Adam Dunkels <adam@sics.se>
*/
#ifndef __RIMEADDR_H__
#define __RIMEADDR_H__
#include "contiki-conf.h"
#ifdef RIMEADDR_CONF_SIZE
#define RIMEADDR_SIZE RIMEADDR_CONF_SIZE
#else /* RIMEADDR_SIZE */
#define RIMEADDR_SIZE 2
#endif /* RIMEADDR_SIZE */
typedef union {
unsigned char u8[RIMEADDR_SIZE];
} rimeaddr_t;
/**
* \brief Copy a Rime address
* \param dest The destination
* \param from The source
*
* This function copies a Rime address from one location
* to another.
*
*/
void rimeaddr_copy(rimeaddr_t *dest, const rimeaddr_t *from);
/**
* \brief Compare two Rime addresses
* \param addr1 The first address
* \param addr2 The second address
* \return Non-zero if the addresses are the same, zero if they are different
*
* This function compares two Rime addresses and returns
* the result of the comparison. The function acts like
* the '==' operator and returns non-zero if the addresses
* are the same, and zero if the addresses are different.
*
*/
int rimeaddr_cmp(const rimeaddr_t *addr1, const rimeaddr_t *addr2);
/**
* \brief Set the address of the current node
* \param addr The address
*
* This function sets the Rime address of the node.
*
*/
void rimeaddr_set_node_addr(rimeaddr_t *addr);
/**
* \brief The Rime address of the node
*
* This variable contains the Rime address of the
* node. This variable should not be changed directly;
* rather, the rimeaddr_set_node_addr() function should be
* used.
*
*/
extern rimeaddr_t rimeaddr_node_addr;
/**
* \brief The null Rime address
*
* This variable contains the null Rime address. The null
* address is used in route tables to indicate that the
* table entry is unused. Nodes with no configured address
* has the null address. Nodes with their node address set
* to the null address will have problems communicating
* with other nodes.
*
*/
extern const rimeaddr_t rimeaddr_null;
#endif /* __RIMEADDR_H__ */
/** @} */
/** @} */