Source: ../../libxipc/xrl.hh

Annotated List Files Globals Hierarchy Index

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-

// Copyright (c) 2001,2002 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/libxipc/xrl.hh,v 1.1.1.1 2002/12/11 23:56:04 hodson Exp $

#ifndef __XRL_H__
#define __XRL_H__

#include <string>

#include "libxorp/exceptions.hh"
#include "xrlatom.hh"
#include "xrlargs.hh"

/**
 * XORP IPC request.
 */
class Xrl {
public:
    //    class InvalidString {};

    /**
     * Construct an Xrl.
     */
    Xrl(const string&	protocol, 
	const string&	protocol_target, 
	const string&	command, 
	const XrlArgs&	args) 
	: _protocol(protocol), _target(protocol_target), _command(command),
	  _args(args) {}

    /**
     * Construct an Xrl (with implicit finder protocol).
     */
    Xrl(const string&	target, 
	const string&	command, 
	const XrlArgs&	args) 
	: _protocol(_finder_protocol), _target(target), _command(command),
	  _args(args) {}

    /**
     * Construct an Xrl that does not have an argument list.
     */
    Xrl(const string& protocol, 
	const string& protocol_target, 
	const string& command) 
	: _protocol(protocol), _target(protocol_target), _command(command) {}

    /**
     * Construct an Xrl that does not have an argument list.
     */
    Xrl(const string& target, 
	const string& command) 
	: _protocol(_finder_protocol), _target(target), _command(command) {}

    /**
     * Construct an Xrl object from the string representation of Xrl.
     */
    Xrl(const char* xrl_c_str) throw (InvalidString);

    Xrl() {}
    ~Xrl() {}

    /* Render Xrl as a string */
    string str() const;

    /**
     * @return the protocol associated with XRL.
     */
    const string& protocol() const { return _protocol; }

    /**
     * @return the name of the XRL target entity.
     */
    const string& target() const { return _target; }

    /**
     * @return the name of the command
     */
    const string& command() const { return _command; }

    /**
     * Retrieve list of arguments associated with the XRL.
     */
    XrlArgs& args() { return _args; }

    /**
     * Retrieve list of arguments associated with the XRL.
     */
    const XrlArgs& const_args() const { return _args; }

    /**
     * Test the equivalence of two XRL's.
     *
     * @return true if the XRL's are equivalent.
     */
    bool operator==(const Xrl& x) const;

    /**
     * @return true if Xrl is resolved, ie protocol == finder.
     */
    inline bool is_resolved() const {
	// This value is ripe for caching.
	return strcasecmp(_protocol.c_str(), _finder_protocol.c_str());
    }
private:
    string	_protocol;
    string	_target;   // if protocol != finder, target = protocol params
    string	_command;
    XrlArgs	_args;

    static const string _finder_protocol;
};

typedef Xrl XrlTemplate;

#endif // __XRL_H__