|
1
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
6
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
7
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
8
|
<title>LDClient: LDClient.network.data.Payload Class Reference</title>
|
|
9
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
10
|
<script type="text/javascript" src="jquery.js"></script>
|
|
11
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
12
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
13
|
<script type="text/javascript" src="resize.js"></script>
|
|
14
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
15
|
<script type="text/javascript" src="navtree.js"></script>
|
|
16
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
17
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
18
|
<script type="text/javascript" src="search/search.js"></script>
|
|
19
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
20
|
</head>
|
|
21
|
<body>
|
|
22
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
23
|
<div id="titlearea">
|
|
24
|
<table cellspacing="0" cellpadding="0">
|
|
25
|
<tbody>
|
|
26
|
<tr id="projectrow">
|
|
27
|
<td id="projectalign">
|
|
28
|
<div id="projectname">LDClient<span id="projectnumber"> v.1</span>
|
|
29
|
</div>
|
|
30
|
<div id="projectbrief">Client application for the detection of Lauterbach debugger devices</div>
|
|
31
|
</td>
|
|
32
|
</tr>
|
|
33
|
</tbody>
|
|
34
|
</table>
|
|
35
|
</div>
|
|
36
|
<!-- end header part -->
|
|
37
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
38
|
<script type="text/javascript">
|
|
39
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
40
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
41
|
/* @license-end */
|
|
42
|
</script>
|
|
43
|
<script type="text/javascript" src="menudata.js"></script>
|
|
44
|
<script type="text/javascript" src="menu.js"></script>
|
|
45
|
<script type="text/javascript">
|
|
46
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
47
|
$(function() {
|
|
48
|
initMenu('',true,false,'search.php','Search');
|
|
49
|
$(document).ready(function() { init_search(); });
|
|
50
|
});
|
|
51
|
/* @license-end */
|
|
52
|
</script>
|
|
53
|
<div id="main-nav"></div>
|
|
54
|
</div><!-- top -->
|
|
55
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
56
|
<div id="nav-tree">
|
|
57
|
<div id="nav-tree-contents">
|
|
58
|
<div id="nav-sync" class="sync"></div>
|
|
59
|
</div>
|
|
60
|
</div>
|
|
61
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
62
|
class="ui-resizable-handle">
|
|
63
|
</div>
|
|
64
|
</div>
|
|
65
|
<script type="text/javascript">
|
|
66
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
67
|
$(document).ready(function(){initNavTree('class_l_d_client_1_1network_1_1data_1_1_payload.html',''); initResizable(); });
|
|
68
|
/* @license-end */
|
|
69
|
</script>
|
|
70
|
<div id="doc-content">
|
|
71
|
<!-- window showing the filter options -->
|
|
72
|
<div id="MSearchSelectWindow"
|
|
73
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
74
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
75
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
76
|
</div>
|
|
77
|
|
|
78
|
<!-- iframe showing the search results (closed by default) -->
|
|
79
|
<div id="MSearchResultsWindow">
|
|
80
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
81
|
name="MSearchResults" id="MSearchResults">
|
|
82
|
</iframe>
|
|
83
|
</div>
|
|
84
|
|
|
85
|
<div class="header">
|
|
86
|
<div class="summary">
|
|
87
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
88
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
89
|
<a href="#properties">Properties</a> |
|
|
90
|
<a href="class_l_d_client_1_1network_1_1data_1_1_payload-members.html">List of all members</a> </div>
|
|
91
|
<div class="headertitle"><div class="title">LDClient.network.data.Payload Class Reference</div></div>
|
|
92
|
</div><!--header-->
|
|
93
|
<div class="contents">
|
|
94
|
|
|
95
|
<p>This class represents a single payload that is sent to the server.
|
|
96
|
<a href="class_l_d_client_1_1network_1_1data_1_1_payload.html#details">More...</a></p>
|
|
97
|
<table class="memberdecls">
|
|
98
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
99
|
Public Member Functions</h2></td></tr>
|
|
100
|
<tr class="memitem:ad81cd8c8c44f80a75d0fbea3aa8d0148"><td class="memItemLeft" align="right" valign="top">override string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html#ad81cd8c8c44f80a75d0fbea3aa8d0148">ToString</a> ()</td></tr>
|
|
101
|
<tr class="memdesc:ad81cd8c8c44f80a75d0fbea3aa8d0148"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of the payload. <a href="class_l_d_client_1_1network_1_1data_1_1_payload.html#ad81cd8c8c44f80a75d0fbea3aa8d0148">More...</a><br /></td></tr>
|
|
102
|
<tr class="separator:ad81cd8c8c44f80a75d0fbea3aa8d0148"><td class="memSeparator" colspan="2"> </td></tr>
|
|
103
|
<tr class="memitem:acd1a2d92945c91d22c262ce7b5a75d57"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html#acd1a2d92945c91d22c262ce7b5a75d57">ParseToJson</a> ()</td></tr>
|
|
104
|
<tr class="memdesc:acd1a2d92945c91d22c262ce7b5a75d57"><td class="mdescLeft"> </td><td class="mdescRight">Parses (converts) the payload into JSON format. <a href="class_l_d_client_1_1network_1_1data_1_1_payload.html#acd1a2d92945c91d22c262ce7b5a75d57">More...</a><br /></td></tr>
|
|
105
|
<tr class="separator:acd1a2d92945c91d22c262ce7b5a75d57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
106
|
</table><table class="memberdecls">
|
|
107
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
108
|
Static Public Member Functions</h2></td></tr>
|
|
109
|
<tr class="memitem:a481fbe5952888d2dd7b6df0ff67ef056"><td class="memItemLeft" align="right" valign="top">static string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html#a481fbe5952888d2dd7b6df0ff67ef056">ParseToJson</a> (<a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html">Payload</a> payload)</td></tr>
|
|
110
|
<tr class="memdesc:a481fbe5952888d2dd7b6df0ff67ef056"><td class="mdescLeft"> </td><td class="mdescRight">Serializes a given payload into JSON format. <a href="class_l_d_client_1_1network_1_1data_1_1_payload.html#a481fbe5952888d2dd7b6df0ff67ef056">More...</a><br /></td></tr>
|
|
111
|
<tr class="separator:a481fbe5952888d2dd7b6df0ff67ef056"><td class="memSeparator" colspan="2"> </td></tr>
|
|
112
|
</table><table class="memberdecls">
|
|
113
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
|
|
114
|
Properties</h2></td></tr>
|
|
115
|
<tr class="memitem:ab1d3b30416e011f29b7e82f284495f65"><td class="memItemLeft" align="right" valign="top"><a id="ab1d3b30416e011f29b7e82f284495f65" name="ab1d3b30416e011f29b7e82f284495f65"></a>
|
|
116
|
string? </td><td class="memItemRight" valign="bottom"><b>UserName</b><code> [get, set]</code></td></tr>
|
|
117
|
<tr class="memdesc:ab1d3b30416e011f29b7e82f284495f65"><td class="mdescLeft"> </td><td class="mdescRight">Username of the currently logged user. <br /></td></tr>
|
|
118
|
<tr class="separator:ab1d3b30416e011f29b7e82f284495f65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
119
|
<tr class="memitem:acbcdcd13f4cfd6074cabcbe1f39e9b72"><td class="memItemLeft" align="right" valign="top"><a id="acbcdcd13f4cfd6074cabcbe1f39e9b72" name="acbcdcd13f4cfd6074cabcbe1f39e9b72"></a>
|
|
120
|
string? </td><td class="memItemRight" valign="bottom"><b>HostName</b><code> [get, set]</code></td></tr>
|
|
121
|
<tr class="memdesc:acbcdcd13f4cfd6074cabcbe1f39e9b72"><td class="mdescLeft"> </td><td class="mdescRight">Hostname of the pc. <br /></td></tr>
|
|
122
|
<tr class="separator:acbcdcd13f4cfd6074cabcbe1f39e9b72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
123
|
<tr class="memitem:ad79e14f0c9936a6e6581d72fca767297"><td class="memItemLeft" align="right" valign="top"><a id="ad79e14f0c9936a6e6581d72fca767297" name="ad79e14f0c9936a6e6581d72fca767297"></a>
|
|
124
|
string? </td><td class="memItemRight" valign="bottom"><b>TimeStamp</b><code> [get, set]</code></td></tr>
|
|
125
|
<tr class="memdesc:ad79e14f0c9936a6e6581d72fca767297"><td class="mdescLeft"> </td><td class="mdescRight">Timestamp (when a debugger was plugged/unplugged). <br /></td></tr>
|
|
126
|
<tr class="separator:ad79e14f0c9936a6e6581d72fca767297"><td class="memSeparator" colspan="2"> </td></tr>
|
|
127
|
<tr class="memitem:ad8926696e666228bfb9164fcbf430da5"><td class="memItemLeft" align="right" valign="top"><a id="ad8926696e666228bfb9164fcbf430da5" name="ad8926696e666228bfb9164fcbf430da5"></a>
|
|
128
|
<a class="el" href="class_l_d_client_1_1network_1_1data_1_1_debugger_info.html">DebuggerInfo</a>? </td><td class="memItemRight" valign="bottom"><b>HeadDevice</b><code> [get, set]</code></td></tr>
|
|
129
|
<tr class="memdesc:ad8926696e666228bfb9164fcbf430da5"><td class="mdescLeft"> </td><td class="mdescRight">Information about the head of the debugger. <br /></td></tr>
|
|
130
|
<tr class="separator:ad8926696e666228bfb9164fcbf430da5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
131
|
<tr class="memitem:a82af1fdf887d86f81acfec3b51936208"><td class="memItemLeft" align="right" valign="top"><a id="a82af1fdf887d86f81acfec3b51936208" name="a82af1fdf887d86f81acfec3b51936208"></a>
|
|
132
|
<a class="el" href="class_l_d_client_1_1network_1_1data_1_1_debugger_info.html">DebuggerInfo</a>? </td><td class="memItemRight" valign="bottom"><b>BodyDevice</b><code> [get, set]</code></td></tr>
|
|
133
|
<tr class="memdesc:a82af1fdf887d86f81acfec3b51936208"><td class="mdescLeft"> </td><td class="mdescRight">Information about the body of the debugger. <br /></td></tr>
|
|
134
|
<tr class="separator:a82af1fdf887d86f81acfec3b51936208"><td class="memSeparator" colspan="2"> </td></tr>
|
|
135
|
<tr class="memitem:a47489fcc58ebc325d36de38db4d4e481"><td class="memItemLeft" align="right" valign="top"><a id="a47489fcc58ebc325d36de38db4d4e481" name="a47489fcc58ebc325d36de38db4d4e481"></a>
|
|
136
|
<a class="el" href="namespace_l_d_client_1_1network_1_1data.html#a0c6d481eff113dd190f5a162b6464e60">ConnectionStatus</a> </td><td class="memItemRight" valign="bottom"><b>Status</b><code> [get, set]</code></td></tr>
|
|
137
|
<tr class="memdesc:a47489fcc58ebc325d36de38db4d4e481"><td class="mdescLeft"> </td><td class="mdescRight">Status of the debugger (connected/disconnected). <br /></td></tr>
|
|
138
|
<tr class="separator:a47489fcc58ebc325d36de38db4d4e481"><td class="memSeparator" colspan="2"> </td></tr>
|
|
139
|
</table>
|
|
140
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
141
|
<div class="textblock"><p >This class represents a single payload that is sent to the server. </p>
|
|
142
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
143
|
<a id="acd1a2d92945c91d22c262ce7b5a75d57" name="acd1a2d92945c91d22c262ce7b5a75d57"></a>
|
|
144
|
<h2 class="memtitle"><span class="permalink"><a href="#acd1a2d92945c91d22c262ce7b5a75d57">◆ </a></span>ParseToJson() <span class="overload">[1/2]</span></h2>
|
|
145
|
|
|
146
|
<div class="memitem">
|
|
147
|
<div class="memproto">
|
|
148
|
<table class="memname">
|
|
149
|
<tr>
|
|
150
|
<td class="memname">string LDClient.network.data.Payload.ParseToJson </td>
|
|
151
|
<td>(</td>
|
|
152
|
<td class="paramname"></td><td>)</td>
|
|
153
|
<td></td>
|
|
154
|
</tr>
|
|
155
|
</table>
|
|
156
|
</div><div class="memdoc">
|
|
157
|
|
|
158
|
<p>Parses (converts) the payload into JSON format. </p>
|
|
159
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
160
|
|
|
161
|
</div>
|
|
162
|
</div>
|
|
163
|
<a id="a481fbe5952888d2dd7b6df0ff67ef056" name="a481fbe5952888d2dd7b6df0ff67ef056"></a>
|
|
164
|
<h2 class="memtitle"><span class="permalink"><a href="#a481fbe5952888d2dd7b6df0ff67ef056">◆ </a></span>ParseToJson() <span class="overload">[2/2]</span></h2>
|
|
165
|
|
|
166
|
<div class="memitem">
|
|
167
|
<div class="memproto">
|
|
168
|
<table class="mlabels">
|
|
169
|
<tr>
|
|
170
|
<td class="mlabels-left">
|
|
171
|
<table class="memname">
|
|
172
|
<tr>
|
|
173
|
<td class="memname">static string LDClient.network.data.Payload.ParseToJson </td>
|
|
174
|
<td>(</td>
|
|
175
|
<td class="paramtype"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html">Payload</a> </td>
|
|
176
|
<td class="paramname"><em>payload</em></td><td>)</td>
|
|
177
|
<td></td>
|
|
178
|
</tr>
|
|
179
|
</table>
|
|
180
|
</td>
|
|
181
|
<td class="mlabels-right">
|
|
182
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
183
|
</tr>
|
|
184
|
</table>
|
|
185
|
</div><div class="memdoc">
|
|
186
|
|
|
187
|
<p>Serializes a given payload into JSON format. </p>
|
|
188
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
189
|
<table class="params">
|
|
190
|
<tr><td class="paramname">payload</td><td>payload to be serialized into JSON</td></tr>
|
|
191
|
</table>
|
|
192
|
</dd>
|
|
193
|
</dl>
|
|
194
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
195
|
|
|
196
|
</div>
|
|
197
|
</div>
|
|
198
|
<a id="ad81cd8c8c44f80a75d0fbea3aa8d0148" name="ad81cd8c8c44f80a75d0fbea3aa8d0148"></a>
|
|
199
|
<h2 class="memtitle"><span class="permalink"><a href="#ad81cd8c8c44f80a75d0fbea3aa8d0148">◆ </a></span>ToString()</h2>
|
|
200
|
|
|
201
|
<div class="memitem">
|
|
202
|
<div class="memproto">
|
|
203
|
<table class="memname">
|
|
204
|
<tr>
|
|
205
|
<td class="memname">override string LDClient.network.data.Payload.ToString </td>
|
|
206
|
<td>(</td>
|
|
207
|
<td class="paramname"></td><td>)</td>
|
|
208
|
<td></td>
|
|
209
|
</tr>
|
|
210
|
</table>
|
|
211
|
</div><div class="memdoc">
|
|
212
|
|
|
213
|
<p>Returns a string representation of the payload. </p>
|
|
214
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
215
|
|
|
216
|
</div>
|
|
217
|
</div>
|
|
218
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
219
|
<li>network/data/Payload.cs</li>
|
|
220
|
</ul>
|
|
221
|
</div><!-- contents -->
|
|
222
|
</div><!-- doc-content -->
|
|
223
|
<!-- start footer part -->
|
|
224
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
225
|
<ul>
|
|
226
|
<li class="navelem"><a class="el" href="namespace_l_d_client.html">LDClient</a></li><li class="navelem"><a class="el" href="namespace_l_d_client_1_1network.html">network</a></li><li class="navelem"><a class="el" href="namespace_l_d_client_1_1network_1_1data.html">data</a></li><li class="navelem"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html">Payload</a></li>
|
|
227
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
|
|
228
|
</ul>
|
|
229
|
</div>
|
|
230
|
</body>
|
|
231
|
</html>
|