Source: ../../libproto/proto_unit.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2003 International Computer Science Institute
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software")
// to deal in the Software without restriction, subject to the conditions
// listed in the XORP LICENSE file. These conditions include: you must
// preserve this copyright notice, and you cannot mention the copyright
// holders in advertising related to the Software without their permission.
// The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
// notice is a summary of the XORP LICENSE file; the license in that file is
// legally binding.
// $XORP: xorp/libproto/proto_unit.hh,v 1.2 2003/03/10 23:20:20 hodson Exp $
#ifndef __LIBPROTO_PROTO_UNIT_HH__
#define __LIBPROTO_PROTO_UNIT_HH__
#include "libxorp/xorp.h"
//
// Protocol unit generic functionality
//
//
// Constants definitions
//
//
// Structures/classes, typedefs and macros
//
/**
* @short The unique module IDs (one per protocol or module).
*
* Note: the module IDs must be consistent with the _x_module_name definition
* in file proto_unit.cc (TODO: a temporary. solution).
*/
enum x_module_id {
X_MODULE_MIN = 0,
X_MODULE_NULL = 0,
X_MODULE_FEA = 1,
X_MODULE_MFEA = 2,
X_MODULE_MLD6IGMP = 3,
X_MODULE_PIMSM = 4,
X_MODULE_PIMDM = 5,
X_MODULE_BGMP = 6,
X_MODULE_BGP = 7,
X_MODULE_OSPF = 8,
X_MODULE_RIP = 9,
X_MODULE_CLI = 10,
X_MODULE_MAX
};
class IPvX;
/**
* @short Base class for each protocol unit (node, vif, etc).
*/
class ProtoUnit {
public:
/**
* Constructor for a given address family and module ID.
*
* @param init_family the address family.
* @param init_module_id the module ID (@ref x_module_id).
*/
ProtoUnit(int init_family, x_module_id init_module_id);
/**
* Destructor
*/
virtual ~ProtoUnit();
/**
* Start the unit.
*
* This operation will fail if the unit is disabled, or is already up.
*
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int start();
/**
* Stop the unit.
*
* This operation will fail if the unit was down already.
*
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int stop();
/**
* Pending-start the unit.
*
* The pending-start state is an intermediate state between down and up.
* In this state only some operations are allowed (the allowed operations
* are unit-specific).
* This operation will fail if the unit is disabled, is up, or is
* pending-up already.
*
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int pending_start();
/**
* Pending-stop the unit.
*
* The pending-stop state is an intermediate state between up and down.
* In this state only some operations are allowed (the allowed operations
* are unit-specific).
* This operation will fail if the unit is not up.
*
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int pending_stop();
/**
* Enable the unit.
*
* If an unit is not enabled, it cannot be start, or pending-start.
*/
void enable() { _flags |= X_ENABLED; }
/**
* Disable the unit.
*
* If an unit is disabled, it cannot be start or pending-start.
* If the unit was runnning, it will be stop first.
*/
void disable() { stop(); _flags &= ~X_ENABLED; }
/**
* Get the address family.
*
* @return the address family (e.g., AF_INET or AF_INET6 for IPv4 and
* IPv6 respectively).
*/
int family() const { return (_family); }
/**
* Get the module ID.
*
* @return the module ID (@ref x_module_id).
*/
x_module_id module_id() const { return (_module_id); }
/**
* Get the current protocol version.
*
* @return the current protocol version.
*/
int proto_version() const { return (_proto_version); }
/**
* Set the current protocol version.
*
* @param v the protocol version.
*/
void set_proto_version(int v) { _proto_version = v; }
/**
* Get the default protocol version.
*
* @return the default protocol version.
*/
int proto_version_default() const { return (_proto_version_default); }
/**
* Set the default protocol version.
*
* @param v the default protocol version.
*/
void set_proto_version_default(int v) { _proto_version_default = v;}
/**
* Test if the address family of the unit is IPv4.
*
* @return true if the address family of the unit is IPv4.
*/
bool is_ipv4() const { return (_family == AF_INET); }
/**
* Test if the address family of the unit is IPv6.
*
* @return true if the address family of the unit is IPv6.
*/
bool is_ipv6() const { return (_family == AF_INET6); }
/**
* Test if the unit state is UP.
*
* @return true if the unit state is UP.
*/
bool is_up() const { return (_flags & X_UP); }
/**
* Test if the unit state is DOWN.
*
* @return true if the unit state is DOWN.
*/
bool is_down() const { return (_flags & X_DOWN); }
/**
* Test if the unit state is PENDING-UP.
*
* @return true if the unit state is PENDING-UP.
*/
bool is_pending_up() const { return (_flags & X_PENDING_UP); }
/**
* Test if the unit state is PENDING-DOWN.
*
* @return true if the unit state is PENDING-DOWN.
*/
bool is_pending_down() const { return (_flags & X_PENDING_DOWN); }
/**
* Test if the unit is enabled.
*
* @return true if the unit is enabled.
*/
bool is_enabled() const { return (_flags & X_ENABLED); }
/**
* Test if the unit is disabled.
*
* @return true if the unit is disabled.
*/
bool is_disabled() const { return (! is_enabled()); }
/**
* Test if debug mode is enabled.
*
* @return true if debug mode is enabled.
*/
bool is_debug() const { return (_debug_flag); }
/**
* Set/reset debug mode.
*
* @param v if true, set debug mode, otherwise reset it.
*/
void set_debug(bool v) { _debug_flag = v; }
/**
* Get the module name.
*
* TODO: temporary, all names are listed in "_x_module_name[][]"
* in proto_unit.cc.
*
* @return C-style string with the module name.
*/
const char *module_name() const { return (_module_name.c_str()); }
/**
* Get a string with the state of the unit.
*
* The state string is one of the following:
* "DISABLED", "DOWN", "UP", "PENDING_UP", "PENDING_DOWN", "UNKNOWN"
*
* @return C-style string with the state of the unit.
*/
const char *state_string() const;
/**
* Get the communication handler for this unit.
*
* Note: currently, the purpose of the communication handler is not clear.
*
* @return the communication handler for this unit.
*/
int comm_handler() const { return (_comm_handler); }
/**
* Set the communication handler for this unit.
*
* @param v the communication handler to set for this unit.
*/
void set_comm_handler(int v) { _comm_handler = v; }
//
// Protocol tests
//
/**
* Test if the protocol is MLD6 or IGMP.
*
* @return true if the protocol is MLD6 or IGMP.
*/
bool proto_is_mld6igmp() const { return (_module_id == X_MODULE_MLD6IGMP); }
/**
* Test if the protocol is IGMP.
*
* @return true if the protocol is IGMP.
*/
bool proto_is_igmp() const { return (proto_is_mld6igmp() && is_ipv4()); }
/**
* Test if the protocol is MLD6.
*
* @return true if the protocol is MLD6.
*/
bool proto_is_mld6() const { return (proto_is_mld6igmp() && is_ipv6()); }
/**
* Test if the protocol is PIM-SM.
*
* @return true if the protocol is PIM-SM.
*/
bool proto_is_pimsm() const { return (_module_id == X_MODULE_PIMSM); }
/**
* Test if the protocol is PIM-DM.
*
* @return true if the protocol is PIM-DM.
*/
bool proto_is_pimdm() const { return (_module_id == X_MODULE_PIMDM); }
/**
* Test if the protocol is BGMP.
*
* @return true if the protocol is BGMP.
*/
bool proto_is_bgmp() const { return (_module_id == X_MODULE_BGMP); }
/**
* Test if the protocol is BGP.
*
* @return true if the protocol is BGP.
*/
bool proto_is_bgp() const { return (_module_id == X_MODULE_BGP); }
/**
* Test if the protocol is OSPF.
*
* @return true if the protocol is OSPF.
*/
bool proto_is_ospf() const { return (_module_id == X_MODULE_OSPF); }
/**
* Test if the protocol is RIP.
*
* @return true if the protocol is RIP.
*/
bool proto_is_rip() const { return (_module_id == X_MODULE_RIP); }
private:
int _family; // The address family.
x_module_id _module_id; // The module ID (X_MODULE_*).
int _comm_handler; // The communication handler.
enum {
X_UP = 1 << 0, // Entity is UP and running.
X_DOWN = 1 << 1, // Entity is DOWN.
X_PENDING_UP = 1 << 2, // Entity is pending UP.
X_PENDING_DOWN = 1 << 3, // Entity is pending DOWN.
X_ENABLED = 1 << 4 // Entity is enabled.
};
uint32_t _flags; // Misc. flags: %X_UP, etc (see above).
int _proto_version; // Protocol version (proto. specific).
int _proto_version_default; // Default protocol version.
bool _debug_flag; // Enable/Disable debug messages.
string _module_name; // The module name.
};
//
// Global variables
//
//
// Global functions prototypes
//
/**
* Get the module name for a given address family and module ID.
*
* TODO: temporary, all names are listed in "_x_module_name[][]"
* in proto_unit.cc.
*
* @param family the address family (e.g., AF_INET or AF_INET6 for
* IPv4 and IPv6 respectively).
* @param module_id the module ID (@ref x_module_id).
* @return C-style string with the module name.
*/
const char *x_module_name(int family, x_module_id module_id);
/**
* Convert from module name to module ID.
*
* The module name must be a valid name returned by @ref x_module_name().
*
* @param module_name the module name.
* @return the module ID (@ref x_module_id) if @ref module_name is valid,
* otherwise @ref X_MODULE_NULL.
*/
x_module_id x_module_name2id(const char *module_name);
/**
* Test if a module ID is valid.
*
* A valid module ID is defined as valid if it is in the interval
* [@ref X_MODULE_MIN, @ref X_MODULE_MAX).
*
* @param module_id the module ID to test (@ref x_module_id).
* @return true if @ref module_id is valid, otherwise false.
*/
bool is_valid_module_id(x_module_id module_id);
#endif // __LIBPROTO_PROTO_UNIT_HH__
| Generated by: pavlin on possum.icir.org on Mon Mar 10 19:34:51 2003, using kdoc 2.0a54+XORP. |
