WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
alloc.hpp
1 /*
2  * Copyright (c) 2014, Peter Thorson. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the name of the WebSocket++ Project nor the
12  * names of its contributors may be used to endorse or promote products
13  * derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_MESSAGE_BUFFER_ALLOC_HPP
29 #define WEBSOCKETPP_MESSAGE_BUFFER_ALLOC_HPP
30 
31 #include <websocketpp/common/memory.hpp>
32 #include <websocketpp/frame.hpp>
33 
34 namespace websocketpp {
35 namespace message_buffer {
36 namespace alloc {
37 
38 /// A connection message manager that allocates a new message for each
39 /// request.
40 template <typename message>
41 class con_msg_manager
42  : public lib::enable_shared_from_this<con_msg_manager<message> >
43 {
44 public:
45  typedef con_msg_manager<message> type;
46  typedef lib::shared_ptr<con_msg_manager> ptr;
47  typedef lib::weak_ptr<con_msg_manager> weak_ptr;
48 
49  typedef typename message::ptr message_ptr;
50 
51  /// Get an empty message buffer
52  /**
53  * @return A shared pointer to an empty new message
54  */
55  message_ptr get_message() {
56  return message_ptr(lib::make_shared<message>(type::shared_from_this()));
57  }
58 
59  /// Get a message buffer with specified size and opcode
60  /**
61  * @param op The opcode to use
62  * @param size Minimum size in bytes to request for the message payload.
63  *
64  * @return A shared pointer to a new message with specified size.
65  */
66  message_ptr get_message(frame::opcode::value op,size_t size) {
67  return message_ptr(lib::make_shared<message>(type::shared_from_this(),op,size));
68  }
69 
70  /// Recycle a message
71  /**
72  * This method shouldn't be called. If it is, return false to indicate an
73  * error. The rest of the method recycle chain should notice this and free
74  * the memory.
75  *
76  * @param msg The message to be recycled.
77  *
78  * @return true if the message was successfully recycled, false otherwse.
79  */
80  bool recycle(message *) {
81  return false;
82  }
83 };
84 
85 /// An endpoint message manager that allocates a new manager for each
86 /// connection.
87 template <typename con_msg_manager>
89 public:
90  typedef typename con_msg_manager::ptr con_msg_man_ptr;
91 
92  /// Get a pointer to a connection message manager
93  /**
94  * @return A pointer to the requested connection message manager.
95  */
96  con_msg_man_ptr get_manager() const {
97  return con_msg_man_ptr(lib::make_shared<con_msg_manager>());
98  }
99 };
100 
101 } // namespace alloc
102 } // namespace message_buffer
103 } // namespace websocketpp
104 
105 #endif // WEBSOCKETPP_MESSAGE_BUFFER_ALLOC_HPP
con_msg_man_ptr get_manager() const
Get a pointer to a connection message manager.
Definition: pool.hpp:203
message_ptr get_message(frame::opcode::value op, size_t size)
Get a message buffer with specified size and opcode.
Definition: alloc.hpp:66
message_ptr get_message()
Get an empty message buffer.
Definition: alloc.hpp:55
void handle_accept(connection_ptr con, lib::error_code const &ec)
Handler callback for start_accept.
bool recycle(message *msg)
Recycle a message.
Definition: pool.hpp:187