WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
connection_hdl.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_COMMON_CONNECTION_HDL_HPP
29 #define WEBSOCKETPP_COMMON_CONNECTION_HDL_HPP
30 
31 #include <websocketpp/common/memory.hpp>
32 
33 namespace websocketpp {
34 
35 /// A handle to uniquely identify a connection.
36 /**
37  * This type uniquely identifies a connection. It is implemented as a weak
38  * pointer to the connection in question. This provides uniqueness across
39  * multiple endpoints and ensures that IDs never conflict or run out.
40  *
41  * It is safe to make copies of this handle, store those copies in containers,
42  * and use them from other threads.
43  *
44  * This handle can be upgraded to a full shared_ptr using
45  * `endpoint::get_con_from_hdl()` from within a handler fired by the connection
46  * that owns the handler.
47  */
48 typedef lib::weak_ptr<void> connection_hdl;
49 
50 } // namespace websocketpp
51 
52 #endif // WEBSOCKETPP_COMMON_CONNECTION_HDL_HPP
void handle_accept(connection_ptr con, lib::error_code const &ec)
Handler callback for start_accept.