source: source/ariba/utility/types/LinkID.h @ 9684

// [License]
// The Ariba-Underlay Copyright
//
// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
//
// Institute of Telematics
// UniversitÀt Karlsruhe (TH)
// Zirkel 2, 76128 Karlsruhe
// Germany
//
// 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.
//
// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``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 ARIBA PROJECT 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.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the Institute of
// Telematics.
// [License]

#ifndef LINKID_H_
#define LINKID_H_

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>

#include <vector>
#include <string>

#include "ariba/utility/serialization.h"

using std::vector;

namespace ariba {
namespace utility {

/**
 * The link id identifies a link between two devices/nodes.
 *
 * Its a 32-bit value, that is composed out of two 16-bit values
 * identifing a initiator and acceptor id.
 */
class LinkID {
private:
        uint16_t local_id;
        uint16_t initiator_id;
        uint16_t acceptor_id;


        LinkID(uint16_t local_id) {
                this->local_id = local_id;
                this->initiator_id = 0;
                this->acceptor_id = 0;
        }

        /// returns the full id
        inline uint32_t getFullId() const {
                return (initiator_id << 16) + acceptor_id;
        }

        inline int compareTo( const LinkID& rhs ) const {
                // compare local id
                if (rhs.isLocal() && this->isLocal())
                        return local_id - rhs.local_id;

                // compare initiator id
                else if ((initiator_id == 0 || rhs.initiator_id == 0)
                                && (acceptor_id == rhs.acceptor_id) ) return 0;

                // compare acceptor id
                else if ((acceptor_id == 0 || rhs.acceptor_id == 0)
                                && (initiator_id == rhs.initiator_id) ) return 0;

                // compare full id
                else if (getFullId() == rhs.getFullId()) return 0;
                else if (getFullId() <  rhs.getFullId()) return -1;
                else if (getFullId() >  rhs.getFullId()) return 1;
                return -1;
        }

        static const char* getInfo( const LinkID& id );

        static bool isValid( const LinkID& id );

public:
        /// the unspecified link id
        static const LinkID UNSPECIFIED;

        /// create a new locally unique link id
        static LinkID create( const char* info = NULL );

        /// free a locally unique link id
        static void destroy( const LinkID& id );

        /// construct a unspecified id
        LinkID() {
                local_id = 0;
                initiator_id = 0;
                acceptor_id = 0;
        }

        /// copy constructor
        LinkID( const LinkID& rh );

        /// assigns another link id
        LinkID& operator=(const LinkID& rh) {
                local_id = rh.local_id;
                initiator_id = rh.initiator_id;
                acceptor_id = rh.acceptor_id;
                return *this;
        }

        /// returns true, if the local link id is known and registered
        bool isValid() const {
                return isValid(*this);
        }

        bool isUnspecified() const {
                return local_id == 0 && initiator_id == 0 && acceptor_id == 0;
        }

        /// returns true, if this is a local id only
        bool isLocal() const {
                return acceptor_id == 0 && initiator_id == 0;
        }

        /// returns true, if this is a remote id only
        bool isRemote() const {
                return local_id == 0;
        }

        /// returns true, if this is a full link id (with acceptor/initiator id)
        bool isLink() const {
                return acceptor_id != 0 && initiator_id != 0;
        }

        /// returns the local id
        uint16_t getLocalId() const {
                return local_id;
        }

        /// returns the remote id
        uint16_t getRemoteId() const {
                return local_id == initiator_id ? acceptor_id : initiator_id;
        }

        /// returns the initiators local link id
        uint16_t getInitiatorId() const {
                return initiator_id;
        }

        /// returns the acceptors local link id
        uint16_t getAcceptorId() const {
                return acceptor_id;
        }

        /// sets the local initiator id of the link
        /// if id is unspecified a new local id is used as initiator id
        void setInitiatorId( const LinkID& id = UNSPECIFIED ) {
                assert(initiator_id == 0);
                if ( id == UNSPECIFIED ) {
                        assert(local_id == 0);
                        local_id = LinkID::create().local_id;
                        initiator_id = local_id;
                } else {
                        assert(local_id == acceptor_id && id.local_id == 0 && id.initiator_id != 0);
                        initiator_id = id.initiator_id;
                }
        }

        /// sets the local acceptor id of the link
        /// if id is unspecified a new local id is used as acceptor id
        void setAcceptorId( const LinkID& id = UNSPECIFIED ) {
                assert(acceptor_id == 0);
                if ( id == UNSPECIFIED ) {
                        assert(local_id == 0);
                        local_id = LinkID::create().local_id;
                        acceptor_id = local_id;
                } else {
                        assert(local_id == initiator_id && id.local_id == 0 && id.acceptor_id != 0);
                        acceptor_id = id.acceptor_id;
                }
        }

        void combine( const LinkID& id ) {

        }

        /// returns a string representation of the link id
        std::string toString() const {
                char str[20];
                if (isLocal())
                        sprintf(str, "l%04x", local_id);
                else
                        sprintf(str, "i%04x.a%04x", initiator_id, acceptor_id );
                return std::string(str);
        }

        /// returns the info of the link id
        const char* getInfo() const {
                return getInfo(*this);
        }

        /// convenience operators
        bool operator==( const LinkID& rhs ) const { return compareTo(rhs) == 0; }
        bool operator!=( const LinkID& rhs ) const { return compareTo(rhs) != 0; }
        bool operator< ( const LinkID& rhs ) const { return compareTo(rhs) <  0; }
        bool operator<=( const LinkID& rhs ) const { return compareTo(rhs) <= 0; }
        bool operator> ( const LinkID& rhs ) const { return compareTo(rhs) >  0; }
        bool operator>=( const LinkID& rhs ) const { return compareTo(rhs) >= 0; }
};

std::ostream& operator<<(std::ostream& s, const LinkID& id );

typedef vector<LinkID> LinkIDs;

}} // namespace ariba, utility

sznBeginDefault( ariba::utility::LinkID, X ) {
        if (X.isDeserializer()) local_id = 0;
        X && initiator_id && acceptor_id;
} sznEnd();


#endif /* LINKID_H_ */