acedia/message.hpp

/*                                                                            *\
**                          Copyright (C) 2009-2010                           **
**       Dominik Charousset < Dominik.Charousset (at) haw-hamburg.de >        **
**                                                                            **
**            MMM       MMMMMM   MMMMMMMMM MMMMMMM   MMM       MMM            **
**           MMMMM     MMMMMMMM  MMMMMMMMM MMMMMMMM  MMM      MMMMM           **
**          MMM MMM   MMM        MMMM      MMM   MMM MMM     MMM MMM          **
**         MMM   MMM  MMM        MMMMMMMMM MMM   MMM MMM    MMM   MMM         **
**        MMMMMMMMMMM MMMM   MMM MMMM      MMM   MMM MMM   MMMMMMMMMMM        **
**       MMM       MMM MMMMMMMM  MMMMMMMMM MMMMMMMM  MMM  MMM       MMM       **
**      MMM         MMM MMMMMM   MMMMMMMMM MMMMMMM   MMM MMM         MMM      **
**                                                                            **
**                                                                            **
** This file is part of the acedia library.                                   **
**                                                                            **
** This library is free software: you can redistribute it and/or modify       **
** it under the terms of the GNU Lesser General Public License as published   **
** by the Free Software Foundation, either version 3 of the License, or       **
** (at your option) any later version.                                        **
**                                                                            **
** 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 acedia. If not, see <http://www.gnu.org/licenses/>.             **
\*                                                                            */

#ifndef ACEDIA_MESSAGE_H
#define ACEDIA_MESSAGE_H

#include "any.hpp"
#include "tuple.hpp"
#include "anyarray.hpp"
#include "metaclass.hpp"
#include "exceptions.hpp"

#include <string>

namespace acedia {

    // forward declaration
    class ActorRef;
    class NetworkMessage;

    // forward declaration
    namespace details
    {
        struct MessageData;
        struct ProxyFactory
        {
            virtual ~ProxyFactory();
            virtual ActorRef get(boost::uint32_t original_actor_id) = 0;
        };
    }

    class Message : public AnyArray
    {

        friend class NetworkMessage;

    public:

        Message();

        Message(const ActorRef &sender, const ActorRef &receiver);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &value);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4, const Any &v5);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4, const Any &v5, const Any &v6);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4, const Any &v5, const Any &v6, const Any &v7);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4, const Any &v5, const Any &v6, const Any &v7, const Any &v8);

        Message(const ActorRef &sender, const ActorRef &receiver, const Any &v1, const Any &v2, const Any &v3, const Any &v4, const Any &v5, const Any &v6, const Any &v7, const Any &v8, const Any &v9);

        Message(const Message &other);

        ~Message();

        Message &operator=(const Message &other);

        bool operator==(const Message &other) const;

        inline bool operator!=(const Message &other) const
        {
            return !((*this) == other);
        }

        virtual boost::uint32_t length() const;

        ActorRef &sender() const;

        ActorRef &receiver() const;

        virtual const Any &at(boost::uint32_t pos) const;

        String toString(bool verbose = false) const;

//      String serializeToString() const;

//      static Message fromSerializedString(const String &str) throw(NotDeserializableException, boost::archive::archive_exception);

        virtual bool isMessage() const;

        String serializeToString();

        /*
         * @throws NotDeserializableException on errors
         */
        static Message deserializeFrom(const char *str, details::ProxyFactory *factory);

    private:

        details::MessageData *data; // pimpl
        Message(details::MessageData *data);
        void set(int N, const Any **values, const ActorRef &msgSender, const ActorRef &msgReceiver);

    };

} // namespace acedia

#endif

---