File: wamp_rawsocket_transport.hpp

package info (click to toggle)
autobahn-cpp 17.5.1%2Bgit7cc5d37-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 804 kB
  • sloc: cpp: 2,133; makefile: 3
file content (232 lines) | stat: -rw-r--r-- 6,548 bytes parent folder | download | duplicates (4)
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
///////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) Crossbar.io Technologies GmbH and contributors
//
// Boost Software License - Version 1.0 - August 17th, 2003
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
///////////////////////////////////////////////////////////////////////////////

#ifndef AUTOBAHN_WAMP_NETWORK_TRANSPORT_HPP
#define AUTOBAHN_WAMP_NETWORK_TRANSPORT_HPP

#include "boost_config.hpp"
#include "wamp_transport.hpp"

#include <boost/asio/io_service.hpp>
#include <cstddef>
#include <memory>
#include <msgpack.hpp>

namespace autobahn {

class wamp_message;
class wamp_transport_handler;

/*!
 * A class that represents a rawsocket transport. It is templated based
 * on the socket type
 *
 * @tparam Socket The socket type for the transport.
 * @tparam Endpoint The endpoint type for the socket to connect to.
 */
template <typename Socket>
class wamp_rawsocket_transport :
        public wamp_transport,
        public std::enable_shared_from_this<wamp_rawsocket_transport<Socket>>
{
public:
    /*!
     * Convenience type for the socket being used.
     */
    typedef Socket socket_type;

    /*!
     * Convenience type for the endpoint being used.
     */
    typedef typename Socket::endpoint_type endpoint_type;

public:
    /*!
     * Constructs a rawsocket transport.
     *
     * @param io_service The io service to use for asynchronous operations.
     * @param remote_endpoint The remote endpoint to connect to.
     */
    wamp_rawsocket_transport(
            boost::asio::io_service& io_service,
            const endpoint_type& remote_endpoint,
            bool debug_enabled=false);

    virtual ~wamp_rawsocket_transport() override = default;

    /*
     * CONNECTION INTERFACE
     */
    /*!
     * @copydoc wamp_transport::connect()
     */
    virtual boost::future<void> connect() override;

    /*!
     * @copydoc wamp_transport::disconnect()
     */
    virtual boost::future<void> disconnect() override;

    /*!
     * @copydoc wamp_transport::is_connected()
     */
    virtual bool is_connected() const override;

    /*
     * SENDER INTERFACE
     */
    /*!
     * @copydoc wamp_transport::send_message()
     */
    virtual void send_message(wamp_message&& message) override;

    /*!
     * @copydoc wamp_transport::set_pause_handler()
     */
    virtual void set_pause_handler(pause_handler&& handler) override;

    /*!
     * @copydoc wamp_transport::set_resume_handler()
     */
    virtual void set_resume_handler(resume_handler&& handler) override;

    /*
     * RECEIVER INTERFACE
     */
    /*!
     * Pause receiving of messages. This will prevent the transport from receiving
     * any more messages until it has been resumed. This is used to excert
     * backpressure on the sending peer.
     */
    virtual void pause() override;

    /*!
     * Resume receiving of messages. The transport will now begin receiving messsages
     * again and lift backpressure from the sending peer.
     */
    virtual void resume() override;

    /*!
     * @copydoc wamp_transport::attach()
     */
    virtual void attach(
            const std::shared_ptr<wamp_transport_handler>& handler) override;

    /*!
     * @copydoc wamp_transport::detach()
     */
    virtual void detach() override;

    /*!
     * @copydoc wamp_transport::has_handler()
     */
    virtual bool has_handler() const override;

protected:
    socket_type& socket();

private:

    void handshake_reply_handler(
            const boost::system::error_code& error_code,
            std::size_t /* bytes_transferred */);

    void receive_message();

    void receive_message_header(
            const boost::system::error_code& error,
            std::size_t /* bytes transferred */);

    void receive_message_body(
            const boost::system::error_code& error,
            std::size_t /* bytes transferred */);

private:
    /*!
     * The underlying socket for the transport.
     */
    socket_type m_socket;

    /*!
     * The remote endpoint to connect the socket to.
     */
    endpoint_type m_remote_endpoint;

    /*!
     * The promise that is fulfilled when the connect attempt is complete.
     */
    boost::promise<void> m_connect;

    /*!
     * The promise that is fulfilled when the disconnect attempt is complete.
     */
    boost::promise<void> m_disconnect;

    /*!
     * The handler to be called when pausing.
     */
    pause_handler m_pause_handler;

    /*!
     * The handler to be called when resuming.
     */
    resume_handler m_resume_handler;

    /*!
     * The transport handler to be notified of events/messages.
     */
    std::shared_ptr<wamp_transport_handler> m_handler;

    /*!
     * Buffer used for sending and receiving the handshake.
     */
    uint8_t m_handshake_buffer[4];

    /*!
     * Stores the length of the next serialized message to receive.
     */
    uint32_t m_message_length;

    /*!
     * Used for unpacking serialized messages.
     */
    msgpack::unpacker m_message_unpacker;

    /*!
     * Whether or not debugging is enabled.
     */
    bool m_debug_enabled;
};

} // namespace autobahn

#include "wamp_rawsocket_transport.ipp"

#endif // AUTOBAHN_WAMP_NETWORK_TRANSPORT_HPP