|
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.IApiClient Interface 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('interface_l_d_client_1_1network_1_1_i_api_client.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="interface_l_d_client_1_1network_1_1_i_api_client-members.html">List of all members</a> </div>
|
|
89
|
<div class="headertitle"><div class="title">LDClient.network.IApiClient Interface Reference</div></div>
|
|
90
|
</div><!--header-->
|
|
91
|
<div class="contents">
|
|
92
|
|
|
93
|
<p>This interface defines the functionality of an API client which is used to send information (payloads) to the server.
|
|
94
|
<a href="interface_l_d_client_1_1network_1_1_i_api_client.html#details">More...</a></p>
|
|
95
|
<table class="memberdecls">
|
|
96
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
97
|
Public Member Functions</h2></td></tr>
|
|
98
|
<tr class="memitem:a8edc6823e4fb6f476a88af2da18e3b7f"><td class="memItemLeft" align="right" valign="top">Task </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_l_d_client_1_1network_1_1_i_api_client.html#a8edc6823e4fb6f476a88af2da18e3b7f">SendPayloadAsync</a> (<a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html">Payload</a> payload)</td></tr>
|
|
99
|
<tr class="memdesc:a8edc6823e4fb6f476a88af2da18e3b7f"><td class="mdescLeft"> </td><td class="mdescRight">Sends a payload to the server (API). <a href="interface_l_d_client_1_1network_1_1_i_api_client.html#a8edc6823e4fb6f476a88af2da18e3b7f">More...</a><br /></td></tr>
|
|
100
|
<tr class="separator:a8edc6823e4fb6f476a88af2da18e3b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
101
|
<tr class="memitem:ab668a6e4e3f1d219c38f5e323d8735cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_l_d_client_1_1network_1_1_i_api_client.html#ab668a6e4e3f1d219c38f5e323d8735cb">Run</a> ()</td></tr>
|
|
102
|
<tr class="memdesc:ab668a6e4e3f1d219c38f5e323d8735cb"><td class="mdescLeft"> </td><td class="mdescRight">Runs the periodical retrieval of failed payloads stored in a file-based cache. This method is instantiated as a thread. <a href="interface_l_d_client_1_1network_1_1_i_api_client.html#ab668a6e4e3f1d219c38f5e323d8735cb">More...</a><br /></td></tr>
|
|
103
|
<tr class="separator:ab668a6e4e3f1d219c38f5e323d8735cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
104
|
</table>
|
|
105
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
106
|
<div class="textblock"><p >This interface defines the functionality of an API client which is used to send information (payloads) to the server. </p>
|
|
107
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
108
|
<a id="ab668a6e4e3f1d219c38f5e323d8735cb" name="ab668a6e4e3f1d219c38f5e323d8735cb"></a>
|
|
109
|
<h2 class="memtitle"><span class="permalink"><a href="#ab668a6e4e3f1d219c38f5e323d8735cb">◆ </a></span>Run()</h2>
|
|
110
|
|
|
111
|
<div class="memitem">
|
|
112
|
<div class="memproto">
|
|
113
|
<table class="memname">
|
|
114
|
<tr>
|
|
115
|
<td class="memname">void LDClient.network.IApiClient.Run </td>
|
|
116
|
<td>(</td>
|
|
117
|
<td class="paramname"></td><td>)</td>
|
|
118
|
<td></td>
|
|
119
|
</tr>
|
|
120
|
</table>
|
|
121
|
</div><div class="memdoc">
|
|
122
|
|
|
123
|
<p>Runs the periodical retrieval of failed payloads stored in a file-based cache. This method is instantiated as a thread. </p>
|
|
124
|
|
|
125
|
<p>Implemented in <a class="el" href="class_l_d_client_1_1network_1_1_api_client.html#ade3b671e7561fbc4c560d3e3a7a79979">LDClient.network.ApiClient</a>.</p>
|
|
126
|
|
|
127
|
</div>
|
|
128
|
</div>
|
|
129
|
<a id="a8edc6823e4fb6f476a88af2da18e3b7f" name="a8edc6823e4fb6f476a88af2da18e3b7f"></a>
|
|
130
|
<h2 class="memtitle"><span class="permalink"><a href="#a8edc6823e4fb6f476a88af2da18e3b7f">◆ </a></span>SendPayloadAsync()</h2>
|
|
131
|
|
|
132
|
<div class="memitem">
|
|
133
|
<div class="memproto">
|
|
134
|
<table class="memname">
|
|
135
|
<tr>
|
|
136
|
<td class="memname">Task LDClient.network.IApiClient.SendPayloadAsync </td>
|
|
137
|
<td>(</td>
|
|
138
|
<td class="paramtype"><a class="el" href="class_l_d_client_1_1network_1_1data_1_1_payload.html">Payload</a> </td>
|
|
139
|
<td class="paramname"><em>payload</em></td><td>)</td>
|
|
140
|
<td></td>
|
|
141
|
</tr>
|
|
142
|
</table>
|
|
143
|
</div><div class="memdoc">
|
|
144
|
|
|
145
|
<p>Sends a payload to the server (API). </p>
|
|
146
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
147
|
<table class="params">
|
|
148
|
<tr><td class="paramname">payload</td><td>instance of a payload to be sent off to the server</td></tr>
|
|
149
|
</table>
|
|
150
|
</dd>
|
|
151
|
</dl>
|
|
152
|
|
|
153
|
<p>Implemented in <a class="el" href="class_l_d_client_1_1network_1_1_api_client.html#a8e78939c5ab5b2f2f417ba280584cb55">LDClient.network.ApiClient</a>.</p>
|
|
154
|
|
|
155
|
</div>
|
|
156
|
</div>
|
|
157
|
<hr/>The documentation for this interface was generated from the following file:<ul>
|
|
158
|
<li>review/aswi2022bug-thugs/ld_client/LDClient/network/IApiClient.cs</li>
|
|
159
|
</ul>
|
|
160
|
</div><!-- contents -->
|
|
161
|
</div><!-- doc-content -->
|
|
162
|
<!-- start footer part -->
|
|
163
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
164
|
<ul>
|
|
165
|
<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="interface_l_d_client_1_1network_1_1_i_api_client.html">IApiClient</a></li>
|
|
166
|
<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>
|
|
167
|
</ul>
|
|
168
|
</div>
|
|
169
|
</body>
|
|
170
|
</html>
|