aboutsummaryrefslogtreecommitdiff
path: root/doc/pv2way_html/classPV2WayConnectOptions.html
blob: fe2cf9ad6898d3bf3ec7514811ccbd29d7c2101d (plain)
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
<!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"/>
<title>pv2way_engine: PV2WayConnectOptions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PV2WayConnectOptions Class Reference</h1><!-- doxytag: class="PV2WayConnectOptions" -->
<p><code>#include &lt;<a class="el" href="pv__2way__basic__types_8h_source.html">pv_2way_basic_types.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PV2WayConnectOptions:</div>
<div class="dynsection">
 <div class="center">
  <img src="classPV2WayConnectOptions.png" usemap="#PV2WayConnectOptions_map" alt=""/>
  <map id="PV2WayConnectOptions_map" name="PV2WayConnectOptions_map">
<area href="classPV2Way324ConnectOptions.html" alt="PV2Way324ConnectOptions" shape="rect" coords="0,56,172,80"/>
</map>
 </div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a493f60cee2febc3d4d17b5ac71d6ca56">PV2WayConnectOptions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a3c3e0c6553a2e52cc485995484245520">PV2WayConnectOptions</a> (<a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a> aLoopbackMode, uint8 *aLocalId, uint32 aLocalIdSize, uint8 *aRemoteId, uint32 aRemoteIdSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#ac172c6986711686155a6a86da6d81a97">~PV2WayConnectOptions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a3609802000747ebac57a07f2d75d5b27">GetConnectInfoClassName</a> (OSCL_wString &amp;aClassName)=0</td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a81cd5ff611f1b345ed7b31459f03bae9">iLoopbackMode</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a3cb32e968d4b244160c16e4364424f7a">iLocalId</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#acfef7a953ae3fbfeeb9a873c5b0bd79f">iLocalIdSize</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a627f3c99c7dc287fe261d2ad5553e339">iRemoteId</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html#a25101061ad51838f83fafa1e3d1ebdfd">iRemoteIdSize</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> Class</p>
<p><a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> class contains options to be specified during connect </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a493f60cee2febc3d4d17b5ac71d6ca56"></a><!-- doxytag: member="PV2WayConnectOptions::PV2WayConnectOptions" ref="a493f60cee2febc3d4d17b5ac71d6ca56" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PV2WayConnectOptions::PV2WayConnectOptions </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default Constructor </p>

</div>
</div>
<a class="anchor" id="a3c3e0c6553a2e52cc485995484245520"></a><!-- doxytag: member="PV2WayConnectOptions::PV2WayConnectOptions" ref="a3c3e0c6553a2e52cc485995484245520" args="(TPVLoopbackMode aLoopbackMode, uint8 *aLocalId, uint32 aLocalIdSize, uint8 *aRemoteId, uint32 aRemoteIdSize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PV2WayConnectOptions::PV2WayConnectOptions </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a>&nbsp;</td>
          <td class="paramname"> <em>aLoopbackMode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>aLocalId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>aLocalIdSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&nbsp;</td>
          <td class="paramname"> <em>aRemoteId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>aRemoteIdSize</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aLoopbackMode</em>&nbsp;</td><td>The loopback mode to used during Connect </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aLocalId,aLocalIdSize</em>&nbsp;</td><td>A unique octet string identifying the local terminal </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aRemoteId,aRemoteIdSize</em>&nbsp;</td><td>A unique octet string identifying the peer (Used only in 2-Stage dialling) </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>

</div>
</div>
<a class="anchor" id="ac172c6986711686155a6a86da6d81a97"></a><!-- doxytag: member="PV2WayConnectOptions::~PV2WayConnectOptions" ref="ac172c6986711686155a6a86da6d81a97" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PV2WayConnectOptions::~PV2WayConnectOptions </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3609802000747ebac57a07f2d75d5b27"></a><!-- doxytag: member="PV2WayConnectOptions::GetConnectInfoClassName" ref="a3609802000747ebac57a07f2d75d5b27" args="(OSCL_wString &amp;aClassName)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PV2WayConnectOptions::GetConnectInfoClassName </td>
          <td>(</td>
          <td class="paramtype">OSCL_wString &amp;&nbsp;</td>
          <td class="paramname"> <em>aClassName</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Pure virtual method that must be overridden. Retrieves class name</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aClassName</em>&nbsp;</td><td>A reference to an OSCL_wString, which is to hold the subclass name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>

<p>Implemented in <a class="el" href="classPV2Way324ConnectOptions.html#a990e77848c4d76d87ec594d0a64f7113">PV2Way324ConnectOptions</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a3cb32e968d4b244160c16e4364424f7a"></a><!-- doxytag: member="PV2WayConnectOptions::iLocalId" ref="a3cb32e968d4b244160c16e4364424f7a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8* <a class="el" href="classPV2WayConnectOptions.html#a3cb32e968d4b244160c16e4364424f7a">PV2WayConnectOptions::iLocalId</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The id of the local terminal </p>

</div>
</div>
<a class="anchor" id="acfef7a953ae3fbfeeb9a873c5b0bd79f"></a><!-- doxytag: member="PV2WayConnectOptions::iLocalIdSize" ref="acfef7a953ae3fbfeeb9a873c5b0bd79f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 <a class="el" href="classPV2WayConnectOptions.html#acfef7a953ae3fbfeeb9a873c5b0bd79f">PV2WayConnectOptions::iLocalIdSize</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The size of the local id </p>

</div>
</div>
<a class="anchor" id="a81cd5ff611f1b345ed7b31459f03bae9"></a><!-- doxytag: member="PV2WayConnectOptions::iLoopbackMode" ref="a81cd5ff611f1b345ed7b31459f03bae9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a> <a class="el" href="classPV2WayConnectOptions.html#a81cd5ff611f1b345ed7b31459f03bae9">PV2WayConnectOptions::iLoopbackMode</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The loopback mode </p>

</div>
</div>
<a class="anchor" id="a627f3c99c7dc287fe261d2ad5553e339"></a><!-- doxytag: member="PV2WayConnectOptions::iRemoteId" ref="a627f3c99c7dc287fe261d2ad5553e339" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8* <a class="el" href="classPV2WayConnectOptions.html#a627f3c99c7dc287fe261d2ad5553e339">PV2WayConnectOptions::iRemoteId</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The id of the peer </p>

</div>
</div>
<a class="anchor" id="a25101061ad51838f83fafa1e3d1ebdfd"></a><!-- doxytag: member="PV2WayConnectOptions::iRemoteIdSize" ref="a25101061ad51838f83fafa1e3d1ebdfd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 <a class="el" href="classPV2WayConnectOptions.html#a25101061ad51838f83fafa1e3d1ebdfd">PV2WayConnectOptions::iRemoteIdSize</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The size of the remote id </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__basic__types_8h_source.html">pv_2way_basic_types.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>