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">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>peekabot: src/client/OperationStatus.hh Source File</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.1 -->
11
<div class="navigation" id="top">
14
<li><a href="main.html"><span>Main Page</span></a></li>
15
<li><a href="pages.html"><span>Related 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>
22
<li><a href="files.html"><span>File List</span></a></li>
26
<div class="headertitle">
27
<h1>src/client/OperationStatus.hh</h1> </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 2007-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_CLIENT_OPERATION_STATUS_HH_INCLUDED</span>
41
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define PEEKABOT_CLIENT_OPERATION_STATUS_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 <string></span>
45
<a name="l00016"></a>00016 <span class="preprocessor">#include <boost/utility.hpp></span>
46
<a name="l00017"></a>00017 <span class="preprocessor">#include <boost/thread/mutex.hpp></span>
47
<a name="l00018"></a>00018 <span class="preprocessor">#include <boost/thread/condition.hpp></span>
48
<a name="l00019"></a>00019
49
<a name="l00020"></a>00020
50
<a name="l00021"></a>00021 <span class="keyword">namespace </span>peekabot
51
<a name="l00022"></a>00022 {
52
<a name="l00023"></a>00023 <span class="keyword">namespace </span>client
53
<a name="l00024"></a>00024 {
54
<a name="l00028"></a>00028 <span class="keyword">enum</span> OperationOutcome
55
<a name="l00029"></a>00029 {
56
<a name="l00033"></a>00033 OUTCOME_PENDING = 0,
57
<a name="l00034"></a>00034
58
<a name="l00038"></a>00038 OPERATION_SUCCEEDED = 1,
59
<a name="l00039"></a>00039
60
<a name="l00043"></a>00043 OPERATION_FAILED = 2
61
<a name="l00044"></a>00044 };
62
<a name="l00045"></a>00045
63
<a name="l00046"></a>00046
64
<a name="l00061"></a>00061 <span class="keyword">class </span>OperationStatus : <span class="keyword">public</span> boost::noncopyable
65
<a name="l00062"></a>00062 {
66
<a name="l00063"></a>00063 <span class="keyword">public</span>:
67
<a name="l00064"></a>00064 OperationStatus();
68
<a name="l00065"></a>00065
69
<a name="l00066"></a>00066
70
<a name="l00067"></a>00067 <span class="keyword">virtual</span> ~OperationStatus();
71
<a name="l00068"></a>00068
72
<a name="l00069"></a>00069
73
<a name="l00073"></a>00073 OperationOutcome get_outcome() <span class="keyword">const</span>;
74
<a name="l00074"></a>00074
75
<a name="l00075"></a>00075
76
<a name="l00087"></a>00087 <span class="keywordtype">void</span> set_outcome(
77
<a name="l00088"></a>00088 OperationOutcome outcome,
78
<a name="l00089"></a>00089 <span class="keyword">const</span> std::string &error_msg = <span class="stringliteral">""</span>);
79
<a name="l00090"></a>00090
80
<a name="l00091"></a>00091
81
<a name="l00099"></a>00099 std::string get_error_msg() <span class="keyword">const</span>;
82
<a name="l00100"></a>00100
83
<a name="l00101"></a>00101
84
<a name="l00109"></a>00109 <span class="keywordtype">bool</span> wait_until_completed() <span class="keyword">const</span>;
85
<a name="l00110"></a>00110
86
<a name="l00111"></a>00111
87
<a name="l00116"></a>00116 <span class="keywordtype">void</span> wake() <span class="keyword">const</span>;
88
<a name="l00117"></a>00117
89
<a name="l00129"></a>00129 <span class="keywordtype">void</span> client_disconnected();
90
<a name="l00130"></a>00130
91
<a name="l00131"></a>00131 <span class="keyword">private</span>:
92
<a name="l00135"></a>00135 <span class="keyword">mutable</span> boost::mutex m_mutex;
93
<a name="l00136"></a>00136
94
<a name="l00142"></a>00142 OperationOutcome m_outcome;
95
<a name="l00143"></a>00143
96
<a name="l00148"></a>00148 std::string m_error_msg;
97
<a name="l00149"></a>00149
98
<a name="l00157"></a>00157 <span class="keyword">mutable</span> boost::condition m_outcome_cond;
99
<a name="l00158"></a>00158
100
<a name="l00167"></a>00167 <span class="keyword">volatile</span> <span class="keywordtype">bool</span> m_client_was_disconnected;
101
<a name="l00168"></a>00168 };
102
<a name="l00169"></a>00169 }
103
<a name="l00170"></a>00170 }
104
<a name="l00171"></a>00171
105
<a name="l00172"></a>00172 <span class="preprocessor">#endif // PEEKABOT_CLIENT_OPERATION_STATUS_HH_INCLUDED</span>
108
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 30 2011 for peekabot by
109
<a href="http://www.doxygen.org/index.html">
110
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
added
removed
doc/0.8.x/OperationStatus_8hh_source.html
