messagein.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program 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
 *  any later version.
 *
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NET_MESSAGEIN_H
#define NET_MESSAGEIN_H
 
#include "enums/simpletypes/beingid.h"
 
#include <string>
 
#include "localconsts.h"
 
namespace Net
{
 
class MessageIn notfinal
{
    public:
        A_DELETE_COPY(MessageIn)
 
        virtual ~MessageIn();
 
        uint16_t readId() const;
 
        int getId() const noexcept2 A_WARN_UNUSED
        { return mId; }
 
        unsigned int getLength() const noexcept2 A_WARN_UNUSED
        { return mLength; }
 
        unsigned int getUnreadLength() const noexcept2 A_WARN_UNUSED
        { return mLength > mPos ? mLength - mPos : 0; }
 
        unsigned char readUInt8(const char *const str);
 
        signed char readInt8(const char *const str);
 
        int16_t readInt16(const char *const str);
 
        uint16_t readUInt16(const char *const str);
 
        int32_t readInt32(const char *const str);
 
        uint32_t readUInt32(const char *const str);
 
        int readItemId(const char *const str);
 
        int64_t readInt64(const char *const str);
 
        BeingId readBeingId(const char *const str);
 
        float readFloat(const char *const str);
 
        void readCoordinates(uint16_t &restrict x,
                             uint16_t &restrict y,
                             uint8_t &restrict direction,
                             const char *const str);
 
        void readCoordinatePair(uint16_t &restrict srcX,
                                uint16_t &restrict srcY,
                                uint16_t &restrict dstX,
                                uint16_t &restrict dstY,
                                const char *const str);
 
        void skip(const unsigned int length,
                  const char *const str);
 
        void skipToEnd(const char *const str);
 
        std::string readString(int length,
                               const char *const dstr);
 
        std::string readRawString(int length,
                                  const char *const dstr);
 
        unsigned char *readBytes(int length,
                                 const char *const dstr);
 
        static uint8_t fromServerDirection(const uint8_t serverDir)
                                           A_WARN_UNUSED;
 
        int getVersion() const noexcept2 A_WARN_UNUSED
        { return mVersion; }
 
        int getVersionMain() const noexcept2 A_WARN_UNUSED;
 
        int getVersionRe() const noexcept2 A_WARN_UNUSED;
 
        int getVersionZero() const noexcept2 A_WARN_UNUSED;
 
    protected:
        MessageIn(const char *const data, const unsigned int length);
 
        const char *mData;     
        unsigned int mLength;  
        unsigned int mPos;
        int mVersion;
        uint16_t mId;          
        bool mIgnore;
};
 
}  // namespace Net
 
#endif  // NET_MESSAGEIN_H