node.h

/* Copyright (c) 2005-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.com>
 *                    2012, Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef CO_NODE_H
#define CO_NODE_H

#include <co/dispatcher.h>        // base class
#include <co/connection.h>        // used in inline template method
#include <co/nodeType.h>          // for NODETYPE_NODE enum
#include <co/types.h>

namespace co
{
namespace detail { class Node; }

    class Node : public Dispatcher, public lunchbox::Referenced
    {
    public:
        CO_API Node( const uint32_t type = co::NODETYPE_NODE );

        CO_API const NodeID& getNodeID() const;


        CO_API uint32_t getType() const;

        bool operator == ( const Node* n ) const; 
        bool isBigEndian() const; 

        CO_API bool isReachable() const;

        CO_API bool isConnected() const;

        CO_API bool isListening() const;

        CO_API bool isClosed() const;

        CO_API bool isClosing() const;

        bool isLocal() const { return isListening(); }

        CO_API void addConnectionDescription( ConnectionDescriptionPtr cd );

        CO_API bool removeConnectionDescription( ConnectionDescriptionPtr cd );

        CO_API ConnectionDescriptions getConnectionDescriptions() const;

        CO_API ConnectionPtr getConnection( const bool multicast = false );

        CO_API OCommand send( const uint32_t cmd, const bool multicast = false);

        CO_API CustomOCommand send( const uint128_t& commandID,
                                    const bool multicast = false );

        CO_API int64_t getLastReceiveTime() const;

        CO_API std::string serialize() const;
        CO_API bool deserialize( std::string& data );

    protected:
        CO_API virtual ~Node();

        void _addConnectionDescription( ConnectionDescriptionPtr cd );
        bool _removeConnectionDescription( ConnectionDescriptionPtr cd );

        ConnectionPtr _getMulticast() const;

        ConnectionPtr getMulticast();

    private:
        detail::Node* const _impl;
        CO_API friend std::ostream& operator << ( std::ostream&, const Node& );

        ConnectionPtr _getConnection( const bool preferMulticast );

        void _addMulticast( NodePtr node, ConnectionPtr connection );
        void _removeMulticast( ConnectionPtr connection );
        void _connectMulticast( NodePtr node );
        void _connectMulticast( NodePtr node, ConnectionPtr connection );
        void _setListening();
        void _setClosing();
        void _setClosed();
        void _connect( ConnectionPtr connection );
        void _disconnect();
        void _setLastReceive( const int64_t time );
        friend class LocalNode;
    };

    CO_API std::ostream& operator << ( std::ostream& os, const Node& node );
}

namespace lunchbox
{
template<> inline void byteswap( co::Node*& ) { /*NOP*/ }
}

#endif // CO_NODE_H