~peekabot-devs/peekabot/peekabot.org

« back to all changes in this revision

Viewing changes to doc/0.8.x/Connection_8hh_source.html

  • Committer: Staffan Gimåker
  • Date: 2011-01-30 20:22:14 UTC
  • Revision ID: staffan@gimaker.se-20110130202214-joasm9qvwni8n0g7
Add doxygen documentation for 0.8.x.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>peekabot: src/Connection.hh Source File</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.1 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul class="tablist">
 
14
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
16
      <li><a href="annotated.html"><span>Classes</span></a></li>
 
17
      <li class="current"><a href="files.html"><span>Files</span></a></li>
 
18
    </ul>
 
19
  </div>
 
20
  <div class="tabs2">
 
21
    <ul class="tablist">
 
22
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
 
23
    </ul>
 
24
  </div>
 
25
<div class="header">
 
26
  <div class="headertitle">
 
27
<h1>src/Connection.hh</h1>  </div>
 
28
</div>
 
29
<div class="contents">
 
30
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
 
31
<a name="l00002"></a>00002 <span class="comment"> * Copyright Staffan Gimåker 2010.</span>
 
32
<a name="l00003"></a>00003 <span class="comment"> *</span>
 
33
<a name="l00004"></a>00004 <span class="comment"> * ---</span>
 
34
<a name="l00005"></a>00005 <span class="comment"> *</span>
 
35
<a name="l00006"></a>00006 <span class="comment"> * Distributed under the Boost Software License, Version 1.0.</span>
 
36
<a name="l00007"></a>00007 <span class="comment"> * (See accompanying file LICENSE_1_0.txt or copy at</span>
 
37
<a name="l00008"></a>00008 <span class="comment"> * http://www.boost.org/LICENSE_1_0.txt)</span>
 
38
<a name="l00009"></a>00009 <span class="comment"> */</span>
 
39
<a name="l00010"></a>00010 
 
40
<a name="l00011"></a>00011 <span class="preprocessor">#ifndef PEEKABOT_CONNECTION_HH_INCLUDED</span>
 
41
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define PEEKABOT_CONNECTION_HH_INCLUDED</span>
 
42
<a name="l00013"></a>00013 <span class="preprocessor"></span>
 
43
<a name="l00014"></a>00014 
 
44
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;string&gt;</span>
 
45
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;vector&gt;</span>
 
46
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;boost/asio.hpp&gt;</span>
 
47
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;boost/cstdint.hpp&gt;</span>
 
48
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;boost/function.hpp&gt;</span>
 
49
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
 
50
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;boost/shared_array.hpp&gt;</span>
 
51
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;boost/date_time/posix_time/ptime.hpp&gt;</span>
 
52
<a name="l00023"></a>00023 
 
53
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;serialization/MemAdapters.hh&quot;</span>
 
54
<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;Protocol.hh&quot;</span>
 
55
<a name="l00026"></a>00026 
 
56
<a name="l00027"></a>00027 
 
57
<a name="l00028"></a>00028 <span class="keyword">namespace </span>peekabot
 
58
<a name="l00029"></a>00029 {
 
59
<a name="l00030"></a>00030     <span class="keyword">class </span>Action;
 
60
<a name="l00031"></a>00031 
 
61
<a name="l00032"></a>00032     <span class="keyword">class </span>Connection
 
62
<a name="l00033"></a>00033     {
 
63
<a name="l00034"></a>00034         <span class="keyword">struct </span>ActionWriteData
 
64
<a name="l00035"></a>00035         {
 
65
<a name="l00036"></a>00036             boost::uint8_t m_ctrl_byte;
 
66
<a name="l00037"></a>00037             boost::uint32_t m_uncomp_len;
 
67
<a name="l00038"></a>00038             boost::uint32_t m_comp_len;
 
68
<a name="l00039"></a>00039             MemSerializationBuffer m_buf;
 
69
<a name="l00040"></a>00040         };
 
70
<a name="l00041"></a>00041 
 
71
<a name="l00042"></a>00042     <span class="keyword">public</span>:
 
72
<a name="l00043"></a>00043         <span class="keyword">virtual</span> ~Connection() {}
 
73
<a name="l00044"></a>00044 
 
74
<a name="l00045"></a>00045         <span class="keywordtype">void</span> connect(<span class="keyword">const</span> std::string &amp;host, <span class="keyword">const</span> std::string &amp;port);
 
75
<a name="l00046"></a>00046 
 
76
<a name="l00047"></a>00047         <span class="keywordtype">void</span> close();
 
77
<a name="l00048"></a>00048 
 
78
<a name="l00049"></a>00049         boost::asio::io_service &amp;get_io_service();
 
79
<a name="l00050"></a>00050 
 
80
<a name="l00051"></a>00051         boost::asio::ip::tcp::socket &amp;get_socket();
 
81
<a name="l00052"></a>00052 
 
82
<a name="l00053"></a>00053         <span class="keyword">const</span> boost::asio::ip::tcp::socket &amp;get_socket() <span class="keyword">const</span>;
 
83
<a name="l00054"></a>00054 
 
84
<a name="l00055"></a>00055         <span class="keywordtype">bool</span> is_authenticated() <span class="keyword">const</span>;
 
85
<a name="l00056"></a>00056 
 
86
<a name="l00057"></a>00057         <span class="keywordtype">bool</span> is_open() <span class="keyword">const</span>;
 
87
<a name="l00058"></a>00058 
 
88
<a name="l00059"></a>00059         <span class="keywordtype">bool</span> is_operational() <span class="keyword">const</span>;
 
89
<a name="l00060"></a>00060 
 
90
<a name="l00061"></a>00061         boost::posix_time::time_duration get_uptime() <span class="keyword">const</span>;
 
91
<a name="l00062"></a>00062 
 
92
<a name="l00063"></a>00063         boost::uint64_t get_bytes_sent() <span class="keyword">const</span>;
 
93
<a name="l00064"></a>00064 
 
94
<a name="l00065"></a>00065         boost::uint64_t get_bytes_received() <span class="keyword">const</span>;
 
95
<a name="l00066"></a>00066 
 
96
<a name="l00067"></a>00067         <span class="keywordtype">void</span> get_throughput(<span class="keywordtype">float</span> &amp;in, <span class="keywordtype">float</span> &amp;out) <span class="keyword">const</span>;
 
97
<a name="l00068"></a>00068 
 
98
<a name="l00069"></a>00069         <span class="keywordtype">void</span> get_remote_peekabot_version(
 
99
<a name="l00070"></a>00070             boost::uint8_t &amp;major,
 
100
<a name="l00071"></a>00071             boost::uint8_t &amp;minor,
 
101
<a name="l00072"></a>00072             boost::uint8_t &amp;rev,
 
102
<a name="l00073"></a>00073             boost::uint8_t &amp;rc);
 
103
<a name="l00074"></a>00074 
 
104
<a name="l00075"></a>00075         std::string get_remote_address() <span class="keyword">const</span>;
 
105
<a name="l00076"></a>00076 
 
106
<a name="l00077"></a>00077         <span class="keyword">virtual</span> <span class="keywordtype">void</span> start() = 0;
 
107
<a name="l00078"></a>00078 
 
108
<a name="l00079"></a>00079         <span class="keywordtype">void</span> authenticate();
 
109
<a name="l00080"></a>00080 
 
110
<a name="l00081"></a>00081         <span class="keywordtype">void</span> write_action(<span class="keyword">const</span> boost::shared_ptr&lt;Action&gt; &amp;action);
 
111
<a name="l00082"></a>00082 
 
112
<a name="l00083"></a>00083     <span class="keyword">protected</span>:
 
113
<a name="l00084"></a>00084         Connection(boost::asio::io_service &amp;io_service);
 
114
<a name="l00085"></a>00085 
 
115
<a name="l00086"></a>00086         <span class="comment">//</span>
 
116
<a name="l00087"></a>00087 
 
117
<a name="l00088"></a>00088         <span class="keywordtype">void</span> read_action();
 
118
<a name="l00089"></a>00089 
 
119
<a name="l00090"></a>00090         <span class="comment">//</span>
 
120
<a name="l00091"></a>00091 
 
121
<a name="l00092"></a>00092         <span class="keyword">virtual</span> boost::shared_ptr&lt;Connection&gt; ptr() = 0;
 
122
<a name="l00093"></a>00093 
 
123
<a name="l00094"></a>00094         <span class="keyword">virtual</span> <span class="keywordtype">void</span> action_read(
 
124
<a name="l00095"></a>00095             <span class="keyword">const</span> boost::shared_ptr&lt;Action&gt; &amp;action) = 0;
 
125
<a name="l00096"></a>00096 
 
126
<a name="l00097"></a>00097         <span class="keyword">virtual</span> <span class="keywordtype">void</span> on_authenticated() = 0;
 
127
<a name="l00098"></a>00098 
 
128
<a name="l00099"></a>00099         <span class="keyword">virtual</span> <span class="keywordtype">void</span> on_authentication_failed(
 
129
<a name="l00100"></a>00100             protocol::AuthenticationResult reason) = 0;
 
130
<a name="l00101"></a>00101 
 
131
<a name="l00102"></a>00102     <span class="keyword">private</span>:
 
132
<a name="l00103"></a>00103         <span class="keywordtype">void</span> handle_auth_write(<span class="keyword">const</span> boost::system::error_code &amp;e);
 
133
<a name="l00104"></a>00104 
 
134
<a name="l00105"></a>00105         <span class="comment">//</span>
 
135
<a name="l00106"></a>00106 
 
136
<a name="l00107"></a>00107         <span class="keywordtype">void</span> authenticate_();
 
137
<a name="l00108"></a>00108 
 
138
<a name="l00109"></a>00109         <span class="keywordtype">void</span> handle_auth_data_read(
 
139
<a name="l00110"></a>00110             <span class="keyword">const</span> boost::system::error_code &amp;e,
 
140
<a name="l00111"></a>00111             boost::shared_ptr&lt;boost::uint32_t&gt; unique_id,
 
141
<a name="l00112"></a>00112             boost::shared_ptr&lt;boost::uint32_t&gt; protocol_version);
 
142
<a name="l00113"></a>00113 
 
143
<a name="l00114"></a>00114         <span class="keywordtype">void</span> handle_auth_res_read(
 
144
<a name="l00115"></a>00115             <span class="keyword">const</span> boost::system::error_code &amp;e);
 
145
<a name="l00116"></a>00116 
 
146
<a name="l00117"></a>00117         <span class="comment">//</span>
 
147
<a name="l00118"></a>00118 
 
148
<a name="l00119"></a>00119         <span class="keywordtype">void</span> read_action_();
 
149
<a name="l00120"></a>00120 
 
150
<a name="l00121"></a>00121         <span class="keywordtype">void</span> handle_action_pre_header_read(
 
151
<a name="l00122"></a>00122             <span class="keyword">const</span> boost::system::error_code &amp;e,
 
152
<a name="l00123"></a>00123             boost::shared_ptr&lt;boost::uint8_t&gt; ctrl_byte);
 
153
<a name="l00124"></a>00124 
 
154
<a name="l00125"></a>00125         <span class="keywordtype">void</span> handle_action_header_read(
 
155
<a name="l00126"></a>00126             <span class="keyword">const</span> boost::system::error_code &amp;e,
 
156
<a name="l00127"></a>00127             boost::shared_ptr&lt;boost::uint32_t&gt; uncomp_len,
 
157
<a name="l00128"></a>00128             boost::shared_ptr&lt;boost::uint32_t&gt; comp_len);
 
158
<a name="l00129"></a>00129 
 
159
<a name="l00130"></a>00130         <span class="keywordtype">void</span> handle_action_body_read(
 
160
<a name="l00131"></a>00131             <span class="keyword">const</span> boost::system::error_code &amp;e,
 
161
<a name="l00132"></a>00132             boost::shared_array&lt;boost::uint8_t&gt; buf,
 
162
<a name="l00133"></a>00133             boost::uint32_t uncomp_len,
 
163
<a name="l00134"></a>00134             boost::uint32_t comp_len);
 
164
<a name="l00135"></a>00135 
 
165
<a name="l00136"></a>00136         <span class="comment">//</span>
 
166
<a name="l00137"></a>00137 
 
167
<a name="l00138"></a>00138         <span class="keywordtype">void</span> write_action_(boost::shared_ptr&lt;Action&gt; action);
 
168
<a name="l00139"></a>00139 
 
169
<a name="l00140"></a>00140         <span class="keywordtype">void</span> handle_action_write(
 
170
<a name="l00141"></a>00141             <span class="keyword">const</span> boost::system::error_code &amp;e,
 
171
<a name="l00142"></a>00142             boost::shared_ptr&lt;ActionWriteData&gt; awd);
 
172
<a name="l00143"></a>00143 
 
173
<a name="l00144"></a>00144     <span class="keyword">private</span>:
 
174
<a name="l00145"></a>00145         boost::asio::ip::tcp::socket m_socket;
 
175
<a name="l00146"></a>00146         boost::asio::deadline_timer m_auth_timeout;
 
176
<a name="l00147"></a>00147 
 
177
<a name="l00148"></a>00148         <span class="keywordtype">bool</span> m_is_authenticated;
 
178
<a name="l00149"></a>00149         boost::posix_time::ptime m_up_since;
 
179
<a name="l00150"></a>00150         boost::uint64_t m_bytes_sent;
 
180
<a name="l00151"></a>00151         boost::uint64_t m_bytes_recv;
 
181
<a name="l00152"></a>00152         boost::uint8_t m_remote_is_big_endian;
 
182
<a name="l00153"></a>00153         boost::uint32_t m_remote_peekabot_version;
 
183
<a name="l00154"></a>00154 
 
184
<a name="l00155"></a>00155         boost::uint8_t m_auth_res_local;
 
185
<a name="l00156"></a>00156         boost::uint8_t m_auth_res_remote;
 
186
<a name="l00157"></a>00157     };
 
187
<a name="l00158"></a>00158 }
 
188
<a name="l00159"></a>00159 
 
189
<a name="l00160"></a>00160 
 
190
<a name="l00161"></a>00161 <span class="preprocessor">#endif // PEEKABOT_CONNECTION_HH_INCLUDED</span>
 
191
</pre></div></div>
 
192
</div>
 
193
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 30 2011 for peekabot by&nbsp;
 
194
<a href="http://www.doxygen.org/index.html">
 
195
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
 
196
</body>
 
197
</html>