PageRenderTime 26ms CodeModel.GetById 15ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/indra/llmessage/llmessagereader.h

https://bitbucket.org/lindenlab/viewer-beta/
C++ Header | 93 lines | 51 code | 14 blank | 28 comment | 0 complexity | 8bda53cac6a772a319d7fcce2997cbc0 MD5 | raw file
 1/** 
 2 * @file llmessagereader.h
 3 * @brief Declaration of LLMessageReader class.
 4 *
 5 * $LicenseInfo:firstyear=2007&license=viewerlgpl$
 6 * Second Life Viewer Source Code
 7 * Copyright (C) 2010, Linden Research, Inc.
 8 * 
 9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation;
12 * version 2.1 of the License only.
13 * 
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * Lesser General Public License for more details.
18 * 
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 * 
23 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
24 * $/LicenseInfo$
25 */
26
27#ifndef LL_LLMESSAGEREADER_H
28#define LL_LLMESSAGEREADER_H
29
30#include "stdtypes.h"
31
32class LLHost;
33class LLMessageBuilder;
34class LLMsgData;
35class LLQuaternion;
36class LLUUID;
37class LLVector3;
38class LLVector3d;
39class LLVector4;
40
41// Error return values for getSize() functions
42const S32 LL_BLOCK_NOT_IN_MESSAGE = -1;
43const S32 LL_VARIABLE_NOT_IN_BLOCK = -2;
44const S32 LL_MESSAGE_ERROR = -3;
45
46
47class LLMessageReader
48{
49 public:
50
51	virtual ~LLMessageReader();
52
53	/** All get* methods expect pointers to canonical strings. */
54	virtual void getBinaryData(const char *blockname, const char *varname, void *datap, S32 size, S32 blocknum = 0, S32 max_size = S32_MAX) = 0;
55	virtual void getBOOL(const char *block, const char *var, BOOL &data, S32 blocknum = 0) = 0;
56	virtual void getS8(const char *block, const char *var, S8 &data, S32 blocknum = 0) = 0;
57	virtual void getU8(const char *block, const char *var, U8 &data, S32 blocknum = 0) = 0;
58	virtual void getS16(const char *block, const char *var, S16 &data, S32 blocknum = 0) = 0;
59	virtual void getU16(const char *block, const char *var, U16 &data, S32 blocknum = 0) = 0;
60	virtual void getS32(const char *block, const char *var, S32 &data, S32 blocknum = 0) = 0;
61	virtual void getF32(const char *block, const char *var, F32 &data, S32 blocknum = 0) = 0;
62	virtual void getU32(const char *block, const char *var, U32 &data, S32 blocknum = 0) = 0;
63	virtual void getU64(const char *block, const char *var, U64 &data, S32 blocknum = 0) = 0;
64	virtual void getF64(const char *block, const char *var, F64 &data, S32 blocknum = 0) = 0;
65	virtual void getVector3(const char *block, const char *var, LLVector3 &vec, S32 blocknum = 0) = 0;
66	virtual void getVector4(const char *block, const char *var, LLVector4 &vec, S32 blocknum = 0) = 0;
67	virtual void getVector3d(const char *block, const char *var, LLVector3d &vec, S32 blocknum = 0) = 0;
68	virtual void getQuat(const char *block, const char *var, LLQuaternion &q, S32 blocknum = 0) = 0;
69	virtual void getUUID(const char *block, const char *var, LLUUID &uuid, S32 blocknum = 0) = 0;
70	virtual void getIPAddr(const char *block, const char *var, U32 &ip, S32 blocknum = 0) = 0;
71	virtual void getIPPort(const char *block, const char *var, U16 &port, S32 blocknum = 0) = 0;
72	virtual void getString(const char *block, const char *var, S32 buffer_size, char *buffer, S32 blocknum = 0) = 0;
73	virtual void getString(const char *block, const char *var, std::string& outstr, S32 blocknum = 0) = 0;
74
75	virtual S32	getNumberOfBlocks(const char *blockname) = 0;
76	virtual S32	getSize(const char *blockname, const char *varname) = 0;
77	virtual S32	getSize(const char *blockname, S32 blocknum, const char *varname) = 0;
78
79	virtual void clearMessage() = 0;
80
81	/** Returns pointer to canonical (prehashed) string. */
82	virtual const char* getMessageName() const = 0;
83	virtual S32 getMessageSize() const = 0;
84
85	virtual void copyToBuilder(LLMessageBuilder&) const = 0;
86
87	static void setTimeDecodes(BOOL b);
88	static BOOL getTimeDecodes();
89	static void setTimeDecodesSpamThreshold(F32 seconds);
90	static F32 getTimeDecodesSpamThreshold();
91};
92
93#endif // LL_LLMESSAGEREADER_H