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
|
<HTML>
<HEAD>
<TITLE>class ChanAssist</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class ChanAssist</h1>
</TD>
<TD valign="top" align="right" colspan="1">
Object that assists a channel
<small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::ChanAssist</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ypbx___yatepbx_h.html">libs/ypbx/yatepbx.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__RefObject.html">TelEngine::RefObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__ChanAssist.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>virtual <b><A HREF="#ref1">~ChanAssist</A></b> ()
</LI>
<LI>virtual const String& <b><A HREF="#ref2">toString</A></b> () const
</LI>
<LI>virtual void <b><A HREF="#ref3">msgStartup</A></b> (Message& msg)
</LI>
<LI>virtual void <b><A HREF="#ref4">msgHangup</A></b> (Message& msg)
</LI>
<LI>virtual void <b><A HREF="#ref5">msgExecute</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref6">msgDisconnect</A></b> (Message& msg, const String& reason)
</LI>
<LI>inline ChanAssistList* <b><A HREF="#ref7">list</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref8">id</A></b> () const
</LI>
<LI>inline RefPointer<CallEndpoint> <b><A HREF="#ref10">locate</A></b> () const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static RefPointer<CallEndpoint> <b><A HREF="#ref9">locate</A></b> (const String& id)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>inline <b><A HREF="#ref11">ChanAssist</A></b> (ChanAssistList* list, const String& id)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Object that assists a channel
</p>
<A NAME="~ChanAssist"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~ChanAssist</strong> ()
<br></td><td align="right"><h3><strong>~ChanAssist</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="toString"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const String& <strong>toString</strong> ()
<br></td><td align="right"><h3><strong>toString</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Get the String value of this object
</p>
<p><b>Returns</b>: ID of the assisted channel
</p>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#toString">GenObject</A>.</p>
<A NAME="msgStartup"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>msgStartup</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgStartup</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process the chan.startup message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">First channel message, may be received after call.execute
</TD></TR>
</TABLE></P>
<A NAME="msgHangup"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>msgHangup</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgHangup</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process the chan.hangup message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Last channel message
</TD></TR>
</TABLE></P>
<A NAME="msgExecute"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>msgExecute</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgExecute</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process the call.execute message, copy any parameters needed later
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">Call execute message, may be received before chan.startup
</TD></TR>
</TABLE></P>
<A NAME="msgDisconnect"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgDisconnect</strong> (Message& msg, const String& reason)
<br></td><td align="right"><h3><strong>msgDisconnect</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Process the channel disconnect message, may connect to something else
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The chan.disconnected message
</TD></TR>
<TR><TD align="left" valign="top"><i>reason</i></TD><TD align="left" valign="top">The disconnection reason
</TD></TR>
</TABLE></P>
<A NAME="list"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline ChanAssistList* <strong>list</strong> ()
<br></td><td align="right"><h3><strong>list</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the list that owns this object
</p>
<p><b>Returns</b>: Pointer to the owner list
</p>
<A NAME="id"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>id</strong> ()
<br></td><td align="right"><h3><strong>id</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the name of the assisted channel
</p>
<p><b>Returns</b>: Identifier of the channel
</p>
<A NAME="locate"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> RefPointer<CallEndpoint> <strong>locate</strong> (const String& id)
<br></td><td align="right"><h3><strong>locate</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Retrive a smart pointer to an arbitrary channel
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">Identifier of the channel to locate
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Smart pointer to the channel or NULL if not found or dead
</p>
<A NAME="locate"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RefPointer<CallEndpoint> <strong>locate</strong> ()
<br></td><td align="right"><h3><strong>locate</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive a smart pointer to the assisted channel
</p>
<p><b>Returns</b>: Smart pointer to the channel or NULL if not found or dead
</p>
<A NAME="ChanAssist"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>ChanAssist</strong> (ChanAssistList* list, const String& id)
<br></td><td align="right"><h3><strong>ChanAssist</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor of base class
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>list</i></TD><TD align="left" valign="top">ChanAssistList that owns this object
</TD></TR>
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">Identifier of the assisted channel
</TD></TR>
</TABLE></P>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
