summaryrefslogtreecommitdiffstats
path: root/classuscxml_1_1_h_t_t_p_server.html
blob: d6f7eeb90dd06e2e2f68cf2250cb586d559692dd (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
189
190
191
192
<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.10"/>
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
        <title>uSCXML: uscxml::HTTPServer Class Reference</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
        <script type="text/javascript" src="doxy-boot.js"></script>
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">uSCXML 2.0.0</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part --><!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>uscxml</b></li><li class="navelem"><a class="el" href="classuscxml_1_1_h_t_t_p_server.html">HTTPServer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classuscxml_1_1_h_t_t_p_server-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">uscxml::HTTPServer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuscxml_1_1_h_t_t_p_server_1_1_callback_data.html">CallbackData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_reply.html">Reply</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_request.html">Request</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_s_s_l_config.html">SSLConfig</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_w_s_frame.html">WSFrame</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a3f9a8345644423d865a4f25c06788dae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f9a8345644423d865a4f25c06788dae"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>ServerType</b> { <b>HTTPS</b>, 
<b>HTTP</b>, 
<b>WebSockets</b>
 }<tr class="separator:a3f9a8345644423d865a4f25c06788dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad053a0882f6119b4a95f31b1964f7ab2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad053a0882f6119b4a95f31b1964f7ab2"></a>
static <a class="el" href="classuscxml_1_1_h_t_t_p_server.html">HTTPServer</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getInstance</b> (unsigned short port, unsigned short wsPort, <a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_s_s_l_config.html">SSLConfig</a> *sslConf=NULL)</td></tr>
<tr class="separator:ad053a0882f6119b4a95f31b1964f7ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10a942a812f3524eade22b35259c705f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10a942a812f3524eade22b35259c705f"></a>
static <a class="el" href="classuscxml_1_1_h_t_t_p_server.html">HTTPServer</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getInstance</b> ()</td></tr>
<tr class="separator:a10a942a812f3524eade22b35259c705f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a612e978e3c8b2919ecdab6722f642b7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a612e978e3c8b2919ecdab6722f642b7b"></a>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>getBaseURL</b> (ServerType type=HTTP)</td></tr>
<tr class="separator:a612e978e3c8b2919ecdab6722f642b7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a366ccc59f65db60cf5877a533283f934"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a366ccc59f65db60cf5877a533283f934"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>reply</b> (const <a class="el" href="classuscxml_1_1_h_t_t_p_server_1_1_reply.html">Reply</a> &amp;reply)</td></tr>
<tr class="separator:a366ccc59f65db60cf5877a533283f934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa46c9cf56cd64ef04cecdd4ab1b49e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa46c9cf56cd64ef04cecdd4ab1b49e6"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>wsSend</b> (struct evws_connection *conn, enum evws_opcode opcode, const char *data, uint64_t length)</td></tr>
<tr class="separator:afa46c9cf56cd64ef04cecdd4ab1b49e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab00438f21be8d80abf355101f9d2325c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab00438f21be8d80abf355101f9d2325c"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>wsBroadcast</b> (const char *uri, enum evws_opcode opcode, const char *data, uint64_t length)</td></tr>
<tr class="separator:ab00438f21be8d80abf355101f9d2325c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54462027c81b847022edea6263ceca21"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54462027c81b847022edea6263ceca21"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server.html#a54462027c81b847022edea6263ceca21">registerServlet</a> (const std::string &amp;path, <a class="el" href="classuscxml_1_1_h_t_t_p_servlet.html">HTTPServlet</a> *servlet)</td></tr>
<tr class="memdesc:a54462027c81b847022edea6263ceca21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a servlet, returns false if path is already taken. <br /></td></tr>
<tr class="separator:a54462027c81b847022edea6263ceca21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f98f043180abeb6e2a64907864211d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f98f043180abeb6e2a64907864211d0"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>unregisterServlet</b> (<a class="el" href="classuscxml_1_1_h_t_t_p_servlet.html">HTTPServlet</a> *servlet)</td></tr>
<tr class="separator:a2f98f043180abeb6e2a64907864211d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad833a570b4dd456911ce1cc1f1d68b8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad833a570b4dd456911ce1cc1f1d68b8b"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_h_t_t_p_server.html#ad833a570b4dd456911ce1cc1f1d68b8b">registerServlet</a> (const std::string &amp;path, <a class="el" href="classuscxml_1_1_web_socket_servlet.html">WebSocketServlet</a> *servlet)</td></tr>
<tr class="memdesc:ad833a570b4dd456911ce1cc1f1d68b8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a servlet, returns false if path is already taken. <br /></td></tr>
<tr class="separator:ad833a570b4dd456911ce1cc1f1d68b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd8662e3cffadbebdf7324c6841b76e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cd8662e3cffadbebdf7324c6841b76e"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>unregisterServlet</b> (<a class="el" href="classuscxml_1_1_web_socket_servlet.html">WebSocketServlet</a> *servlet)</td></tr>
<tr class="separator:a4cd8662e3cffadbebdf7324c6841b76e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa9086c45128f6cb5d1d90bad5ba2b5a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9086c45128f6cb5d1d90bad5ba2b5a3"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>HTTPServlet</b></td></tr>
<tr class="separator:aa9086c45128f6cb5d1d90bad5ba2b5a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a573a05b8ca48320d3196c4c3670fdbc8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a573a05b8ca48320d3196c4c3670fdbc8"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>WebSocketServlet</b></td></tr>
<tr class="separator:a573a05b8ca48320d3196c4c3670fdbc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>server/<a class="el" href="_h_t_t_p_server_8h_source.html">HTTPServer.h</a></li>
<li>server/<a class="el" href="_h_t_t_p_server_8cpp.html">HTTPServer.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<!-- <hr class="footer"/><address class="footer"><small>
Generated on Thu May 19 2016 10:34:10 for uSCXML by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address> -->
</body>
</html>