|

Message.hpp

Go to the documentation of this file.

#ifndef IONFLUX_TOOLS_MESSAGE
#define IONFLUX_TOOLS_MESSAGE
/* ==========================================================================
 * Ionflux Tools
 * Copyright (c) 2004 Joern P. Meier
 * mail@ionflux.org
 * --------------------------------------------------------------------------
 * Message.hpp                    Network message.
 * ==========================================================================
 * 
 * This file is part of Ionflux Tools.
 * 
 * Ionflux Tools 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.
 * 
 * Ionflux Tools 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 Ionflux Tools; if not, write to the Free Software Foundation, 
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * ========================================================================== */

#include <string>
#include <iostream>
#include <sstream>
#include <vector>
#include "ionflux/tools.hpp"
#include "ionflux/Reporter.hpp"
#include "ionflux/Tree.hpp"
#include "ionflux/MessageDump.hpp"

namespace Ionflux
{

namespace Tools
{

class MessageDump;

class Message
: public Tree
{
    protected:
        std::string magicWord;
        int protocolVersion;
        int protocolVersionLower;
        int protocolVersionUpper;
        int uid;
        int type;
        unsigned int flags;
        unsigned int size;
        std::string checksum;
        std::string username;
        std::string userSecret;
        std::string sessionSecret;
        std::string serialized;
        MessageDump *target;
        unsigned int maxSize;
        
        virtual bool unpack();
        
    public:
        static const std::string DEFAULT_MAGIC_WORD;
        static const int DEFAULT_PROTOCOL_VERSION;
        static const int UID_NOT_SET;
        static const int TYPE_NOT_SET;
        static const int FLAG_COMPRESS;
        static const int HEADER_SIZE;
        static const unsigned int DEFAULT_MAX_SIZE;
        
        Message();
        
        virtual ~Message();
        
        virtual void clearData();
        
        virtual void clearAll();
        
        virtual void serialize(std::string &buffer);
        
        virtual bool append(const std::string& bytes);
        
        virtual void dump(const std::string& bytes);
        
        virtual void setMagicWord(const std::string &newMagicWord);
        
        virtual void setProtocolVersion(int newProtocolVersion);
        
        virtual void setAcceptableProtocolVersion(int newProtocolVersionLower, 
            int newProtocolVersionUpper);
        
        virtual void setUID(int newUID);
        
        virtual void setType(int newType);
        
        virtual void setFlags(unsigned int newFlags);
        
        virtual void setUsername(const std::string &newUsername);
        
        virtual void setUserSecret(const std::string &newUserSecret);
        
        virtual void setSessionSecret(const std::string &newSessionSecret);
        
        virtual void setTarget(MessageDump *newTarget);
        
        virtual void setMaxSize(unsigned int newMaxSize);
        
        virtual std::string getMagicWord();
        
        virtual int getProtocolVersion();
        
        virtual int getUID();
        
        virtual int getType();
        
        virtual unsigned int getFlags();
        
        virtual unsigned int getSize();
        
        virtual std::string getUsername();
        
        virtual void getUserSecret(std::string &userSecretBuffer);
        
        virtual void getSessionSecret(std::string &sessionSecretBuffer);
        
        virtual unsigned int getNumBytesMissing();
        
        virtual unsigned int getMaxSize();
};

}

}

#endif

---