jausAddress.h

/*****************************************************************************
 *  Copyright (c) 2008, University of Florida
 *  All rights reserved.
 *  
 *  This file is part of OpenJAUS.  OpenJAUS is distributed under the BSD 
 *  license.  See the LICENSE file for details.
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the University of Florida 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 COPYRIGHT HOLDERS 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 COPYRIGHT 
 *   OWNER 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.
 ****************************************************************************/
// File Name: jausAddress.h
//
// Written By: Danny Kent (jaus AT dannykent DOT com)
//
// Version: 3.3.0a
//
// Date: 08/07/08
//
// Description: This file defines the basic JausAddress of each component

#ifndef JAUS_ADDRESS_H
#define JAUS_ADDRESS_H

#include "jaus.h"

#define JAUS_INVALID_INSTANCE_ID 		0
#define JAUS_MINIMUM_INSTANCE_ID		1
#define JAUS_MAXIMUM_INSTANCE_ID		254
#define JAUS_BROADCAST_INSTANCE_ID		255

#define JAUS_INVALID_COMPONENT_ID 		0
#define JAUS_MINIMUM_COMPONENT_ID		1
#define JAUS_MAXIMUM_COMPONENT_ID		254
#define JAUS_BROADCAST_COMPONENT_ID 	255

#define JAUS_INVALID_NODE_ID 			0
#define JAUS_MINIMUM_NODE_ID			1
#define JAUS_MAXIMUM_NODE_ID			254
#define JAUS_BROADCAST_NODE_ID			255

#define JAUS_INVALID_SUBSYSTEM_ID 		0
#define JAUS_MINIMUM_SUBSYSTEM_ID		1
#define JAUS_MAXIMUM_SUBSYSTEM_ID		254
#define JAUS_BROADCAST_SUBSYSTEM_ID 	255

#define JAUS_NODE_MANAGER_COMPONENT 	1
#define JAUS_PRIMARY_NODE_MANAGER_NODE 	1

#define JAUS_ADDRESS_WILDCARD_OCTET	0

struct JausAddressStruct
{
	JausByte instance;
	JausByte component;
	JausByte node;
	JausByte subsystem;

	struct JausAddressStruct *next;
};

typedef struct JausAddressStruct *JausAddress;

JAUS_EXPORT JausAddress jausAddressCreate(void);
JAUS_EXPORT void jausAddressDestroy(JausAddress);

JAUS_EXPORT int jausAddressToString(JausAddress, char *);
JAUS_EXPORT JausAddress jausAddressClone(JausAddress src);
JAUS_EXPORT JausBoolean jausAddressCopy(JausAddress dst, JausAddress src);
JAUS_EXPORT JausBoolean jausAddressEqual(JausAddress, JausAddress);
JAUS_EXPORT JausBoolean jausAddressIsValid(JausAddress address);
JAUS_EXPORT int jausAddressHash(JausAddress address);

#endif // JAUS_ADDRESS_H