File: classwx_protocol_log.html

package info (click to toggle)
wxpython3.0 3.0.2.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 482,760 kB
  • ctags: 518,293
  • sloc: cpp: 2,127,226; python: 294,045; makefile: 51,942; ansic: 19,033; sh: 3,013; xml: 1,629; perl: 17
file content (197 lines) | stat: -rw-r--r-- 11,687 bytes parent folder | download | duplicates (2) 
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
193
194
195
196
197
 
<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxProtocolLog Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
 <tbody>
 <tr>
  <td id="projectlogo">
    <a href="http://www.wxwidgets.org/" target="_new">
      <img alt="wxWidgets" src="logo.png"/>
    </a>
  </td>
  <td style="padding-left: 0.5em; text-align: right;">
   <span id="projectnumber">Version: 3.0.2</span>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
  <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>Categories</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>
    </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="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classwx_protocol_log-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">wxProtocolLog Class Reference<div class="ingroups"><a class="el" href="group__group__class__net.html">Networking</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;wx/protocol/log.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class allowing to log network operations performed by <a class="el" href="classwx_protocol.html" title="Represents a protocol for use with wxURL.">wxProtocol</a>. </p>
<h2></h2>
<div><span class="lib">Library:</span>&#160;&#160;<span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxnet">wxNet</a></span></div><div><span class="category">Category:</span>&#160;&#160;<span class="category_text"><a class="el" href="group__group__class__net.html">Networking</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_protocol.html" title="Represents a protocol for use with wxURL.">wxProtocol</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a449abb899cb6413c968bbda18cef6144"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_protocol_log.html#a449abb899cb6413c968bbda18cef6144">wxProtocolLog</a> (const <a class="el" href="classwx_string.html">wxString</a> &amp;traceMask)</td></tr>
<tr class="memdesc:a449abb899cb6413c968bbda18cef6144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create object doing the logging using <a class="el" href="group__group__funcmacro__log.html#ga947e317db477914c12b13c4534867ec9" title="Log a message at wxLOG_Trace log level (see wxLogLevelValues enum).">wxLogTrace()</a> with the specified trace mask.  <a href="#a449abb899cb6413c968bbda18cef6144"></a><br/></td></tr>
<tr class="separator:a449abb899cb6413c968bbda18cef6144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addf45beaed76b87ccbf6b43022076bf6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_protocol_log.html#addf45beaed76b87ccbf6b43022076bf6">LogRequest</a> (const <a class="el" href="classwx_string.html">wxString</a> &amp;str)</td></tr>
<tr class="memdesc:addf45beaed76b87ccbf6b43022076bf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by wxProtocol-derived objects to log strings sent to the server.  <a href="#addf45beaed76b87ccbf6b43022076bf6"></a><br/></td></tr>
<tr class="separator:addf45beaed76b87ccbf6b43022076bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4d66c55be1aa518626bbc97982d756b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_protocol_log.html#af4d66c55be1aa518626bbc97982d756b">LogResponse</a> (const <a class="el" href="classwx_string.html">wxString</a> &amp;str)</td></tr>
<tr class="memdesc:af4d66c55be1aa518626bbc97982d756b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by wxProtocol-derived objects to log strings received from the server.  <a href="#af4d66c55be1aa518626bbc97982d756b"></a><br/></td></tr>
<tr class="separator:af4d66c55be1aa518626bbc97982d756b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aca6e0f45b42affec868c8f5128813967"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_protocol_log.html#aca6e0f45b42affec868c8f5128813967">DoLogString</a> (const <a class="el" href="classwx_string.html">wxString</a> &amp;str)</td></tr>
<tr class="memdesc:aca6e0f45b42affec868c8f5128813967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log the given string.  <a href="#aca6e0f45b42affec868c8f5128813967"></a><br/></td></tr>
<tr class="separator:aca6e0f45b42affec868c8f5128813967"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a449abb899cb6413c968bbda18cef6144"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">wxProtocolLog::wxProtocolLog </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td>
          <td class="paramname"><em>traceMask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create object doing the logging using <a class="el" href="group__group__funcmacro__log.html#ga947e317db477914c12b13c4534867ec9" title="Log a message at wxLOG_Trace log level (see wxLogLevelValues enum).">wxLogTrace()</a> with the specified trace mask. </p>
<p>If you override <a class="el" href="classwx_protocol_log.html#aca6e0f45b42affec868c8f5128813967" title="Log the given string.">DoLogString()</a> in your class the <em>traceMask</em> may be left empty but it must have a valid value if you rely on the default <a class="el" href="classwx_protocol_log.html#aca6e0f45b42affec868c8f5128813967" title="Log the given string.">DoLogString()</a> implementation. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aca6e0f45b42affec868c8f5128813967"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void wxProtocolLog::DoLogString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Log the given string. </p>
<p>This function is called from <a class="el" href="classwx_protocol_log.html#addf45beaed76b87ccbf6b43022076bf6" title="Called by wxProtocol-derived objects to log strings sent to the server.">LogRequest()</a> and <a class="el" href="classwx_protocol_log.html#af4d66c55be1aa518626bbc97982d756b" title="Called by wxProtocol-derived objects to log strings received from the server.">LogResponse()</a> and by default uses <a class="el" href="group__group__funcmacro__log.html#ga947e317db477914c12b13c4534867ec9" title="Log a message at wxLOG_Trace log level (see wxLogLevelValues enum).">wxLogTrace()</a> with the trace mask specified in the constructor but can be overridden to do something different by the derived classes. </p>

</div>
</div>
<a class="anchor" id="addf45beaed76b87ccbf6b43022076bf6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void wxProtocolLog::LogRequest </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called by wxProtocol-derived objects to log strings sent to the server. </p>
<p>Default implementation prepends a client-to-server marker to <em>str</em> and calls <a class="el" href="classwx_protocol_log.html#aca6e0f45b42affec868c8f5128813967" title="Log the given string.">DoLogString()</a>. </p>

</div>
</div>
<a class="anchor" id="af4d66c55be1aa518626bbc97982d756b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void wxProtocolLog::LogResponse </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called by wxProtocol-derived objects to log strings received from the server. </p>
<p>Default implementation prepends a server-to-client marker to <em>str</em> and calls <a class="el" href="classwx_protocol_log.html#aca6e0f45b42affec868c8f5128813967" title="Log the given string.">DoLogString()</a>. </p>

</div>
</div>
</div><!-- contents -->

<address class="footer">
	<small>
		Generated on Thu Nov 27 2014 13:46:53 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
	</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>