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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>megaco_transport</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>megaco_transport</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
megaco_transport
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Megaco transport begaviour.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> The following functions should be exported from a
<CODE>megaco_transport</CODE> callback module:
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="Module:send_message/2"><STRONG><CODE>Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Handle = term()</CODE></STRONG><BR>
<STRONG><CODE>Msg = binary() | iolist()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
<STRONG><CODE>Error = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Send a megaco message.
<P>If the function returns <CODE>{cancel, Reason}</CODE>, this means the
transport module decided not to send the message.
This is <STRONG>not</STRONG> an error. No error messages will be issued
and no error counters incremented.
What actions this will result in depends on what kind of
message was sent.
In the case of requests, megaco will cancel the message in much
the same way as if <CODE>megaco:cancel</CODE> had been called
(after a successfull send). The information will be propagated
back to the user differently dependning on how the request(s) where
issued: For requests issued using
<A HREF="megaco.html#call">megaco:call</A>, the info
will be delivered in the return value. For requests issued
using <CODE>megaco:cast</CODE> the info will be delivered via a call
to the callback function
<A HREF="megaco_user.html#trans_reply">handle_trans_reply</A>.
In the case of reply, megaco will cancel the reply and information
of this will be returned to the user via a call to the
callback function
<A HREF="megaco_user.html#trans_ack">handle_trans_ack</A>.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Micael Karlberg - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>megaco 3.5<BR>
Copyright © 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
