wamp_message.hpp
1 //
3 // Copyright (c) Crossbar.io Technologies GmbH and contributors
4 //
5 // Boost Software License - Version 1.0 - August 17th, 2003
6 //
7 // Permission is hereby granted, free of charge, to any person or organization
8 // obtaining a copy of the software and accompanying documentation covered by
9 // this license (the "Software") to use, reproduce, display, distribute,
10 // execute, and transmit the Software, and to prepare derivative works of the
11 // Software, and to permit third-parties to whom the Software is furnished to
12 // do so, all subject to the following:
13 //
14 // The copyright notices in the Software and this entire statement, including
15 // the above license grant, this restriction and the following disclaimer,
16 // must be included in all copies of the Software, in whole or in part, and
17 // all derivative works of the Software, unless such copies or derivative
18 // works are solely in the form of machine-executable object code generated by
19 // a source language processor.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24 // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25 // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 // DEALINGS IN THE SOFTWARE.
28 //
30 
31 #ifndef AUTOBAHN_WAMP_MESSAGE_HPP
32 #define AUTOBAHN_WAMP_MESSAGE_HPP
33 
34 #include <cstddef>
35 #include <msgpack.hpp>
36 #include <vector>
37 
38 namespace autobahn {
39 
54 {
55 public:
59  using message_fields = std::vector<msgpack::object>;
60 
61 public:
67  wamp_message(std::size_t num_fields);
68 
75  wamp_message(std::size_t num_fields, msgpack::zone&& zone);
76 
83  wamp_message(message_fields&& fields, msgpack::zone&& zone);
84 
85  wamp_message(const wamp_message& other) = delete;
86  wamp_message(wamp_message&& other);
87 
88  wamp_message& operator=(const wamp_message& other) = delete;
89  wamp_message& operator=(wamp_message&& other);
90 
99  const msgpack::object& field(std::size_t index) const;
100 
111  template <typename Type>
112  Type field(std::size_t index);
113 
122  template <typename Type>
123  void set_field(std::size_t index, const Type& type);
124 
131  bool is_field_type(std::size_t index, msgpack::type::object_type type) const;
132 
138  std::size_t size() const;
139 
145  const message_fields& fields() const;
146 
153 
159  msgpack::zone&& zone();
160 
161 private:
167  msgpack::zone m_zone;
168 
173  message_fields m_fields;
174 };
175 
177 std::ostream& operator<<(std::ostream& os, const wamp_message& message);
178 
179 } // namespace autobahn
180 
181 #include "wamp_message.ipp"
182 
183 #endif // AUTOBAHN_WAMP_MESSAGE_HPP
A class that represents a wamp message in its simplest form.
const msgpack::object & field(std::size_t index) const
Retrieves the field at the specified index.
wamp_message(std::size_t num_fields)
Constructs a wamp message with the given number of fields.
void set_field(std::size_t index, const Type &type)
Sets the field at the specified index.
std::vector< msgpack::object > message_fields
A convenience type for representing message fields.
bool is_field_type(std::size_t index, msgpack::type::object_type type) const
Determines if the field at the specified index is of the given type.
const message_fields & fields() const
The message fields.
msgpack::zone && zone()
Pilfers the message zone.
std::size_t size() const
Retrieves the number of fields in the message.