summaryrefslogtreecommitdiff
path: root/cpp/unpack.hpp
blob: cde45e7ea67db3cd30e3de3dd44a9e597c0b2946 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
//
// MessagePack for C++ deserializing routine
//
// Copyright (C) 2008-2009 FURUHASHI Sadayuki
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
//
#ifndef MSGPACK_UNPACK_HPP__
#define MSGPACK_UNPACK_HPP__

#include "msgpack/object.hpp"
#include "msgpack/zone.hpp"
#include <memory>
#include <stdexcept>

#ifndef MSGPACK_UNPACKER_DEFAULT_INITIAL_BUFFER_SIZE
#define MSGPACK_UNPACKER_DEFAULT_INITIAL_BUFFER_SIZE (32*1024)
#endif

namespace msgpack {


struct unpack_error : public std::runtime_error {
	unpack_error(const std::string& msg) :
		std::runtime_error(msg) { }
};


class unpacker {
public:
	unpacker(size_t initial_buffer_size = MSGPACK_UNPACKER_DEFAULT_INITIAL_BUFFER_SIZE);
	~unpacker();

public:
	/*! 1. reserve buffer. at least `len' bytes of capacity will be ready */
	void reserve_buffer(size_t len);

	/*! 2. read data to the buffer() up to buffer_capacity() bytes */
	char* buffer();
	size_t buffer_capacity() const;

	/*! 3. specify the number of bytes actually copied */
	void buffer_consumed(size_t len);

	/*! 4. repeat execute() until it retunrs false */
	bool execute();

	/*! 5.1. if execute() returns true, take out the parsed object */
	object data();

	/*! 5.2. the object is valid until the zone is deleted */
	// Note that once release_zone() from unpacker, you must delete it
	// otherwise the memrory will leak.
	zone* release_zone();

	/*! 5.3. after release_zone(), re-initialize unpacker */
	void reset();


	// Basic usage of the unpacker is as following:
	//
	// msgpack::unpacker pac;
	//
	// while( /* readable */ ) {
	//
	//     // 1.
	//     pac.reserve(1024);
	//
	//     // 2.
	//     ssize_t bytes =
	//         read(the_source, pac.buffer(), pac.buffer_capacity());
	//
	//     // error handling ...
	//
	//     // 3.
	//     pac.buffer_consumed(bytes);
	//
	//     // 4.
	//     while(pac.execute()) {
	//         // 5.1
	//         object o = pac.data();
	//
	//         // 5.2
	//         std::auto_ptr<msgpack::zone> olife( pac.release_zone() );
	//
	//         // boost::shared_ptr is also usable:
	//         // boost::shared_ptr<msgpack::zone> olife( pac.release_zone() );
	//
	//         // 5.3
	//         pac.reset();
	//
	//         // do some with the object with the old zone.
	//         do_something(o, olife);
	//     }
	// }
	//

public:
	// These functions are usable when non-MessagePack message follows after
	// MessagePack message.

	/*! get address of the buffer that is not parsed */
	char* nonparsed_buffer();
	size_t nonparsed_size() const;

	/*! skip specified size of non-parsed buffer, leaving the buffer */
	// Note that the `len' argument must be smaller than nonparsed_size()
	void skip_nonparsed_buffer(size_t len);

	/*! remove unparsed buffer from unpacker */
	// Note that reset() leaves non-parsed buffer.
	void remove_nonparsed_buffer();

private:
	char* m_buffer;
	size_t m_used;
	size_t m_free;
	size_t m_off;

	std::auto_ptr<zone> m_zone;

	void* m_ctx;

	size_t m_initial_buffer_size;

private:
	void expand_buffer(size_t len);

private:
	unpacker(const unpacker&);

public:
	static object unpack(const char* data, size_t len, zone& z, size_t* off = NULL);
};


inline void unpacker::reserve_buffer(size_t len)
{
	if(m_free >= len) { return; }
	expand_buffer(len);
}

inline char* unpacker::buffer()
	{ return m_buffer + m_used; }

inline size_t unpacker::buffer_capacity() const
	{ return m_free; }

inline void unpacker::buffer_consumed(size_t len)
{
	m_used += len;
	m_free -= len;
}


inline char* unpacker::nonparsed_buffer()
	{ return m_buffer + m_off; }

inline size_t unpacker::nonparsed_size() const
	{ return m_used - m_off; }

inline void unpacker::skip_nonparsed_buffer(size_t len)
	{ m_off += len; }

inline void unpacker::remove_nonparsed_buffer()
	{ m_used = m_off; }


inline object unpack(const char* data, size_t len, zone& z, size_t* off = NULL)
{
	return unpacker::unpack(data, len, z, off);
}


}  // namespace msgpack

#endif /* msgpack/unpack.hpp */