-
Notifications
You must be signed in to change notification settings - Fork 1
/
megaco_tcp.html
383 lines (234 loc) · 11.4 KB
/
megaco_tcp.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
<?xml version="1.0" encoding="utf-8"?>
<!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" xml:lang="en" lang="en">
<head>
<title>megaco_tcp</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/main.css" type="text/css" media="screen" />
<script src="js/main.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'>
<tr>
<td class="file-title"><span class="file-title-prefix">Module</span><br />megaco_tcp</td>
<td align="right">
</td>
</tr>
</table>
<div id="bodyContent">
<div id="content">
<div class="description">
<p>This module contains the public interface to the TPKT (TCP/IP) version
transport protocol for Megaco/H.248.</p>
</div>
<div class="sectiontitle">Functions</div>
<ul>
<li><a href="#blockHandlegtok">block(Handle) -> ok</a></li>
<li><a href="#closeHandlegtok">close(Handle) -> ok</a></li>
<li><a href="#connectTransportRefOptionListgtokHandleControlPiderrorReason">connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason}</a></li>
<li><a href="#get_statsgtokTotalStatserrorReason">get_stats() -> {ok, TotalStats} | {error, Reason}</a></li>
<li><a href="#listenTransportRefListenPortSpecListgtok">listen(TransportRef, ListenPortSpecList) -> ok</a></li>
<li><a href="#reset_statsgtvoid">reset_stats() -> void()</a></li>
<li><a href="#send_messageHandleMessagegtok">send_message(Handle, Message) -> ok</a></li>
<li><a href="#socketHandlegtSocket">socket(Handle) -> Socket</a></li>
<li><a href="#start_transportgtokTransportRef">start_transport() -> {ok, TransportRef}</a></li>
<li><a href="#unblockHandlegtok">unblock(Handle) -> ok</a></li>
<li><a href="#upgrade_receive_handleControlPidgtok">upgrade_receive_handle(ControlPid) -> ok</a></li>
</ul>
<div class="sectiontitle">Exports</div>
<div class="method">
<div class="title">
<a name="start_transportgtokTransportRef"></a><b>start_transport() -> {ok, TransportRef}</b>
</div>
<div class="func_types">
Types:
<p>
<b>TransportRef = pid()</b><br/>
</p>
</div>
<div class="description">
<p>This function is used for starting the TCP/IP transport service.
Use exit(TransportRef, Reason) to stop the transport service.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="listenTransportRefListenPortSpecListgtok"></a><b>listen(TransportRef, ListenPortSpecList) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>TransportRef = pid() | regname()</b><br/>
<b>OptionListPerPort = [Option]</b><br/>
<b>Option = {port, integer()} |{options, list()} |{receive_handle, term()}</b><br/>
</p>
</div>
<div class="description">
<p>This function is used for starting new TPKT listening socket
for TCP/IP. The option list contains the socket
definitions.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="connectTransportRefOptionListgtokHandleControlPiderrorReason"></a><b>connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>TransportRef = pid() | regname()</b><br/>
<b>OptionList = [Option]</b><br/>
<b>Option = {host, Ipaddr} | {port, integer()} |{options, list()} |{receive_handle, term()} |{module, atom()}</b><br/>
<b>Handle = socket_handle()</b><br/>
<b>ControlPid = pid()</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>This function is used to open a TPKT connection.</p>
<p>The <tt><![CDATA[module]]></tt> option makes it possible for the user to provide
their own callback module. The <tt><![CDATA[receive_message/4]]></tt> or
<tt><![CDATA[process_received_message/4]]></tt> functions of this module is called
when a new message is received (which one depends on the size of the
message; small - receive_message, large - process_received_message).
Default value is <em>megaco</em>.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="closeHandlegtok"></a><b>close(Handle) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>Handle = socket_handle()</b><br/>
</p>
</div>
<div class="description">
<p>This function is used for closing an active TPKT connection.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="socketHandlegtSocket"></a><b>socket(Handle) -> Socket</b>
</div>
<div class="func_types">
Types:
<p>
<b>Handle = socket_handle()</b><br/>
<b>Socket = inet_socket()</b><br/>
</p>
</div>
<div class="description">
<p>This function is used to convert a socket_handle() to
a inet_socket(). inet_socket() is a plain socket,
see the inet module for more info.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="send_messageHandleMessagegtok"></a><b>send_message(Handle, Message) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>Handle = socket_handle()</b><br/>
<b>Message = binary() | iolist()</b><br/>
</p>
</div>
<div class="description">
<p>Sends a message on a connection.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="blockHandlegtok"></a><b>block(Handle) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>Handle = socket_handle()</b><br/>
</p>
</div>
<div class="description">
<p>Stop receiving incomming messages on the socket.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="unblockHandlegtok"></a><b>unblock(Handle) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>Handle = socket_handle()</b><br/>
</p>
</div>
<div class="description">
<p>Starting to receive incomming messages from the socket again.</p>
<marker id="upgrade_receive_handle"/>
</div>
</div>
<div class="method">
<div class="title">
<a name="upgrade_receive_handleControlPidgtok"></a><b>upgrade_receive_handle(ControlPid) -> ok</b>
</div>
<div class="func_types">
Types:
<p>
<b>ControlPid = pid()</b><br/>
</p>
</div>
<div class="description">
<p>Update the receive handle of the control process (e.g. after
having changed protocol version).</p>
<marker id="stats"/>
</div>
</div>
<div class="method">
<div class="title">
<a name="get_statsgtokTotalStatserrorReason"></a><b>get_stats() -> {ok, TotalStats} | {error, Reason}<br/>get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason}<br/>get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason}</b>
</div>
<div class="func_types">
Types:
<p>
<b>TotalStats = [send_handle_stats()]</b><br/>
<b>total_stats() = {send_handle(), [stats()]}</b><br/>
<b>SendHandle = send_handle()</b><br/>
<b>SendHandleStats = [stats()]</b><br/>
<b>Counter = tcp_stats_counter()</b><br/>
<b>CounterStats = integer()</b><br/>
<b>stats() = {tcp_stats_counter(), integer()}</b><br/>
<b>tcp_stats_counter() = medGwyGatewayNumInMessages | medGwyGatewayNumInOctets | medGwyGatewayNumOutMessages | medGwyGatewayNumOutOctets | medGwyGatewayNumErrors</b><br/>
<b>Reason = term()</b><br/>
</p>
</div>
<div class="description">
<p>Retreive the TCP related (SNMP) statistics counters.</p>
</div>
</div>
<div class="method">
<div class="title">
<a name="reset_statsgtvoid"></a><b>reset_stats() -> void()<br/>reset_stats(SendHandle) -> void()</b>
</div>
<div class="func_types">
Types:
<p>
<b>SendHandle = send_handle()</b><br/>
</p>
</div>
<div class="description">
<p>Reset all TCP related (SNMP) statistics counters.</p>
</div>
</div>
<center>
<hr/>
<small>Copyright © 1991-2009
<a href="http://www.ericsson.com/technology/opensource/erlang">Ericsson AB</a><br/>
</small>
</center>
</div>
</div>
</body>
</html>