SpreadMessage.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 <string>
#include <list>

#include <boost/shared_ptr.hpp>

#include "rsb/rsbexports.h"

namespace rsb {
namespace spread {

class RSB_EXPORT SpreadMessage {
public:

    enum Type {
        REGULAR = 0x0001, MEMBERSHIP = 0x0002, OTHER = 0xFFFF,
    };

    enum QOS {
        UNRELIABLE = 0x00000001,
        RELIABLE = 0x00000002,
        FIFO = 0x00000004,
        CASUAL = 0x00000008,
        AGREED = 0x00000010,
        SAFE = 0x00000020
    };

    SpreadMessage();
    SpreadMessage(const Type& mt);
    SpreadMessage(const std::string& d);
    SpreadMessage(const char* d);
    virtual ~SpreadMessage();

    void setData(const std::string& doc);
    void setData(const char* d);
    std::string getDataAsString() const;
    const char* getData() const;
    int getSize() const;
    SpreadMessage::Type getType() const;
    void setType(Type mt);
    QOS getQOS() const;
    void setQOS(const QOS& qos);

    void addGroup(const std::string& name);
    unsigned int getGroupCount() const;
    std::list<std::string>::const_iterator getGroupsBegin() const;
    std::list<std::string>::const_iterator getGroupsEnd() const;

    void reset();

private:
    std::string data;
    std::list<std::string> groups;
    Type type;
    QOS qos;
};

typedef boost::shared_ptr<SpreadMessage> SpreadMessagePtr;

}
}