-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgroup__messagecapi.html
262 lines (245 loc) · 12.2 KB
/
group__messagecapi.html
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EOS.IO: Message C API</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EOS.IO
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Message C API<div class="ingroups"><a class="el" href="group__contractdev.html">How To Write Contracts</a> » <a class="el" href="group__messageapi.html">Message API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Define API for querying message properties.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga95a7d555722669cdeb72d6d6d1236893"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#ga95a7d555722669cdeb72d6d6d1236893">readMessage</a> (void *msg, <a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> len)</td></tr>
<tr class="separator:ga95a7d555722669cdeb72d6d6d1236893"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4e5f3cd4b54bccaa36e755caecda727"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#gaa4e5f3cd4b54bccaa36e755caecda727">messageSize</a> ()</td></tr>
<tr class="separator:gaa4e5f3cd4b54bccaa36e755caecda727"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga993633916da61f395c03440e17d720ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#ga993633916da61f395c03440e17d720ff">requireNotice</a> (<a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a>)</td></tr>
<tr class="separator:ga993633916da61f395c03440e17d720ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed0ef9b019ed08c7cc0241c5b4169f13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#gaed0ef9b019ed08c7cc0241c5b4169f13">requireAuth</a> (<a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> name)</td></tr>
<tr class="separator:gaed0ef9b019ed08c7cc0241c5b4169f13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f06c06adc584456cf30e8086d6b55b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#ga1f06c06adc584456cf30e8086d6b55b1">currentCode</a> ()</td></tr>
<tr class="separator:ga1f06c06adc584456cf30e8086d6b55b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae2a6ebaf48fe7c69f847ae18f109d09a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#gae2a6ebaf48fe7c69f847ae18f109d09a">assert</a> (<a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> test, const char *cstr)</td></tr>
<tr class="separator:gae2a6ebaf48fe7c69f847ae18f109d09a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga34bcb797186fc81170ac182f8bba1e7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a2518c21789dfad901bbf283f9ea4247f">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messagecapi.html#ga34bcb797186fc81170ac182f8bba1e7d">now</a> ()</td></tr>
<tr class="separator:ga34bcb797186fc81170ac182f8bba1e7d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae2a6ebaf48fe7c69f847ae18f109d09a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae2a6ebaf48fe7c69f847ae18f109d09a">◆ </a></span>assert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void assert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> </td>
<td class="paramname"><em>test</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cstr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Aborts processing of this message and unwinds all pending changes</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">test</td><td>- 0 to abort, 1 to ignore </td></tr>
<tr><td class="paramname">cstr</td><td>- a null terminated message to explain the reason for failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1f06c06adc584456cf30e8086d6b55b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f06c06adc584456cf30e8086d6b55b1">◆ </a></span>currentCode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> currentCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the account which specifes the code that is being run </dd></dl>
</div>
</div>
<a id="gaa4e5f3cd4b54bccaa36e755caecda727"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4e5f3cd4b54bccaa36e755caecda727">◆ </a></span>messageSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> messageSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is useful for dynamicly sized messages</p>
<dl class="section return"><dt>Returns</dt><dd>the length of the current message's data field </dd></dl>
</div>
</div>
<a id="ga34bcb797186fc81170ac182f8bba1e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga34bcb797186fc81170ac182f8bba1e7d">◆ </a></span>now()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a2518c21789dfad901bbf283f9ea4247f">Time</a> now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the time in seconds from 1970 of the last accepted block (not the block including this message) </p>
</div>
</div>
<a id="ga95a7d555722669cdeb72d6d6d1236893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95a7d555722669cdeb72d6d6d1236893">◆ </a></span>readMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> readMessage </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a06896e8c53f721507066c079052171f8">uint32_t</a> </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>- a pointer where up to len bytes of the current message will be coppied </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes copied to msg </dd></dl>
</div>
</div>
<a id="gaed0ef9b019ed08c7cc0241c5b4169f13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed0ef9b019ed08c7cc0241c5b4169f13">◆ </a></span>requireAuth()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void requireAuth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Verifies that name exists in the set of provided auths on a message. Throws if not found </p>
</div>
</div>
<a id="ga993633916da61f395c03440e17d720ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga993633916da61f395c03440e17d720ff">◆ </a></span>requireNotice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void requireNotice </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ad67b43dc23285b01176f4c181c59fc23">AccountName</a> </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Verifies that name exists in the set of notified accounts on a message. Throws if not found </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>