NodeHandle.h

Go to the documentation of this file.

//
// Copyright (C) 2006 Institut fuer Telematik, Universitaet Karlsruhe (TH)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//

#ifndef __NODEHANDLE_H_
#define __NODEHANDLE_H_

//#include <stdint.h>
//#include <oversim_mapset.h>

#include <omnetpp.h>

#include <OverlayKey.h>
#include <TransportAddress.h>

//class hashFcn;
class IPvXAddress;

class NodeHandle : public TransportAddress
{
public://collection typedefs
    //typedef UNORDERED_SET<NodeHandle, hashFcn> Set; /**< a hash_set of NodeHandles */

protected://fields
    OverlayKey key; 
public://construction

    NodeHandle( );

    virtual ~NodeHandle( ) {};

    NodeHandle( const NodeHandle& handle );

    NodeHandle( const OverlayKey& key,
                const IPvXAddress& ip,
                int port);

    NodeHandle( const TransportAddress& ta );

    NodeHandle( const OverlayKey& key, const TransportAddress& ta );

public://static fields

    static const NodeHandle UNSPECIFIED_NODE; 
public://methods: delegates to OverlayKey and IPvXAddress

    bool operator==(const NodeHandle& rhs) const;

    bool operator!=(const NodeHandle& rhs) const;

    bool operator< (const NodeHandle& rhs) const;

    bool operator> (const NodeHandle& rhs) const;

    bool operator<=(const NodeHandle& rhs) const;

    bool operator>=(const NodeHandle& rhs) const;

public://methods: operators

    NodeHandle& operator=(const NodeHandle& rhs);

public://methods: setters and getters

    void setKey( const OverlayKey& key );

    const OverlayKey& getKey() const;

    bool isUnspecified() const;

public://methods: c++ streaming

    friend std::ostream& operator<<(std::ostream& os, const NodeHandle& n);

private://methods:

    void assertUnspecified( const NodeHandle& handle ) const;

public:

    virtual void netPack(cCommBuffer *b);

    virtual void netUnpack(cCommBuffer *b);

    virtual TransportAddress* dup() const;
};

inline void doPacking(cCommBuffer *b, NodeHandle& obj) {obj.netPack(b);}

inline void doUnpacking(cCommBuffer *b, NodeHandle& obj) {obj.netUnpack(b);}

#endif