SpreadConnection.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project
 *
 * Copyright (C) 2010 by Sebastian Wrede <swrede at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <boost/shared_ptr.hpp>
#include <boost/thread.hpp>
#include <boost/thread/condition.hpp>

#include <rsc/logging/Logger.h>

#include "SpreadMessage.h"
#include "rsb/rsbexports.h"

// forward declaration to avoid exposing sp.h with strange defines that prevent
// other code from compiling
typedef int mailbox;

namespace rsb {
namespace spread {

RSB_EXPORT std::string defaultHost();

RSB_EXPORT unsigned int defaultPort();

class RSB_EXPORT SpreadConnection {
public:
    SpreadConnection(const std::string& prefix,
                     const std::string& host   = defaultHost(),
                     unsigned int port         = defaultPort());
    virtual ~SpreadConnection();


    void activate();

    void deactivate();



    void send(const SpreadMessage& msg);

    void receive(SpreadMessagePtr sm);


    void interruptReceive();

    bool isActive();

    unsigned long getMsgCount();

    mailbox* getMailbox();

private:
    std::string generateId(const std::string& prefix);

    rsc::logging::LoggerPtr logger;
    volatile bool connected;
    mailbox con;
    std::string host;
    unsigned int port;
    std::string spreadname;
    std::string spreadpg;
    std::string conId;
    unsigned long msgCount;
};

typedef boost::shared_ptr<SpreadConnection> SpreadConnectionPtr;

}

}