1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>PV2WayConnectOptions class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>PV2WayConnectOptions Class Reference</h1><code>#include <<a class="el" href="pv__2way__basic__types_8h-source.html">pv_2way_basic_types.h</a>></code> 10 <p> 11 <p>Inheritance diagram for PV2WayConnectOptions: 12 <p><center><img src="classPV2WayConnectOptions.png" usemap="#PV2WayConnectOptions_map" border="0" alt=""></center> 13 <map name="PV2WayConnectOptions_map"> 14 <area href="classPV2Way324ConnectOptions.html" alt="PV2Way324ConnectOptions" shape="rect" coords="0,56,172,80"> 15 </map> 16 <table border=0 cellpadding=0 cellspacing=0> 17 <tr><td></td></tr> 18 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 19 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#a0">PV2WayConnectOptions</a> ()</td></tr> 20 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#a1">PV2WayConnectOptions</a> (<a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a> aLoopbackMode, uint8 *aLocalId, uint32 aLocalIdSize, uint8 *aRemoteId, uint32 aRemoteIdSize)</td></tr> 21 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#a2">GetConnectInfoClassName</a> (OSCL_wString &aClassName)=0</td></tr> 22 <tr><td colspan=2><br><h2>Data Fields</h2></td></tr> 23 <tr><td nowrap align=right valign=top><a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a> </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m0">iLoopbackMode</a></td></tr> 24 <tr><td nowrap align=right valign=top>uint8 * </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m1">iLocalId</a></td></tr> 25 <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m2">iLocalIdSize</a></td></tr> 26 <tr><td nowrap align=right valign=top>uint8 * </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m3">iRemoteId</a></td></tr> 27 <tr><td nowrap align=right valign=top>uint32 </td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m4">iRemoteIdSize</a></td></tr> 28 </table> 29 <hr><a name="_details"></a><h2>Detailed Description</h2> 30 PV2WayConnectOptions Class 31 <p> 32 PV2WayConnectOptions class contains options to be specified during connect 33 <p> 34 <hr><h2>Constructor & Destructor Documentation</h2> 35 <a name="a0" doxytag="PV2WayConnectOptions::PV2WayConnectOptions"></a><p> 36 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 37 <tr> 38 <td class="md"> 39 <table cellpadding="0" cellspacing="0" border="0"> 40 <tr> 41 <td class="md" nowrap valign="top"> PV2WayConnectOptions::PV2WayConnectOptions </td> 42 <td class="md" valign="top">( </td> 43 <td class="mdname1" valign="top" nowrap> </td> 44 <td class="md" valign="top">) </td> 45 <td class="md" nowrap><code> [inline]</code></td> 46 </tr> 47 48 </table> 49 </td> 50 </tr> 51 </table> 52 <table cellspacing=5 cellpadding=0 border=0> 53 <tr> 54 <td> 55 56 </td> 57 <td> 58 59 <p> 60 Default Constructor </td> 61 </tr> 62 </table> 63 <a name="a1" doxytag="PV2WayConnectOptions::PV2WayConnectOptions"></a><p> 64 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 65 <tr> 66 <td class="md"> 67 <table cellpadding="0" cellspacing="0" border="0"> 68 <tr> 69 <td class="md" nowrap valign="top"> PV2WayConnectOptions::PV2WayConnectOptions </td> 70 <td class="md" valign="top">( </td> 71 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a> </td> 72 <td class="mdname" nowrap> <em>aLoopbackMode</em>, </td> 73 </tr> 74 <tr> 75 <td></td> 76 <td></td> 77 <td class="md" nowrap>uint8 * </td> 78 <td class="mdname" nowrap> <em>aLocalId</em>, </td> 79 </tr> 80 <tr> 81 <td></td> 82 <td></td> 83 <td class="md" nowrap>uint32 </td> 84 <td class="mdname" nowrap> <em>aLocalIdSize</em>, </td> 85 </tr> 86 <tr> 87 <td></td> 88 <td></td> 89 <td class="md" nowrap>uint8 * </td> 90 <td class="mdname" nowrap> <em>aRemoteId</em>, </td> 91 </tr> 92 <tr> 93 <td></td> 94 <td></td> 95 <td class="md" nowrap>uint32 </td> 96 <td class="mdname" nowrap> <em>aRemoteIdSize</em></td> 97 </tr> 98 <tr> 99 <td></td> 100 <td class="md">) </td> 101 <td class="md" colspan="2"><code> [inline]</code></td> 102 </tr> 103 104 </table> 105 </td> 106 </tr> 107 </table> 108 <table cellspacing=5 cellpadding=0 border=0> 109 <tr> 110 <td> 111 112 </td> 113 <td> 114 115 <p> 116 Constructor <dl compact><dt><b>Parameters: </b></dt><dd> 117 <table border=0 cellspacing=2 cellpadding=0> 118 <tr><td valign=top><em>aLoopbackMode</em> </td><td> 119 The loopback mode to used during Connect </td></tr> 120 <tr><td valign=top><em>aLocalId, aLocalIdSize</em> </td><td> 121 A unique octet string identifying the local terminal </td></tr> 122 <tr><td valign=top><em>aRemoteId, aRemoteIdSize</em> </td><td> 123 A unique octet string identifying the peer (Used only in 2-Stage dialling) </td></tr> 124 </table> 125 </dl><dl compact><dt><b>Returns: </b></dt><dd> 126 void </dl> </td> 127 </tr> 128 </table> 129 <hr><h2>Member Function Documentation</h2> 130 <a name="a2" doxytag="PV2WayConnectOptions::GetConnectInfoClassName"></a><p> 131 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 132 <tr> 133 <td class="md"> 134 <table cellpadding="0" cellspacing="0" border="0"> 135 <tr> 136 <td class="md" nowrap valign="top"> virtual void PV2WayConnectOptions::GetConnectInfoClassName </td> 137 <td class="md" valign="top">( </td> 138 <td class="md" nowrap valign="top">OSCL_wString & </td> 139 <td class="mdname1" valign="top" nowrap> <em>aClassName</em> </td> 140 <td class="md" valign="top">) </td> 141 <td class="md" nowrap><code> [pure virtual]</code></td> 142 </tr> 143 144 </table> 145 </td> 146 </tr> 147 </table> 148 <table cellspacing=5 cellpadding=0 border=0> 149 <tr> 150 <td> 151 152 </td> 153 <td> 154 155 <p> 156 Pure virtual method that must be overridden. Retrieves class name<dl compact><dt><b>Parameters: </b></dt><dd> 157 <table border=0 cellspacing=2 cellpadding=0> 158 <tr><td valign=top><em>aClassName</em> </td><td> 159 A reference to an OSCL_wString, which is to hold the subclass name </td></tr> 160 </table> 161 </dl><dl compact><dt><b>Returns: </b></dt><dd> 162 void </dl> 163 <p> 164 Implemented in <a class="el" href="classPV2Way324ConnectOptions.html#a3">PV2Way324ConnectOptions</a>. </td> 165 </tr> 166 </table> 167 <hr><h2>Field Documentation</h2> 168 <a name="m1" doxytag="PV2WayConnectOptions::iLocalId"></a><p> 169 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 170 <tr> 171 <td class="md"> 172 <table cellpadding="0" cellspacing="0" border="0"> 173 <tr> 174 <td class="md" nowrap valign="top"> uint8* PV2WayConnectOptions::iLocalId 175 </table> 176 </td> 177 </tr> 178 </table> 179 <table cellspacing=5 cellpadding=0 border=0> 180 <tr> 181 <td> 182 183 </td> 184 <td> 185 186 <p> 187 The id of the local terminal </td> 188 </tr> 189 </table> 190 <a name="m2" doxytag="PV2WayConnectOptions::iLocalIdSize"></a><p> 191 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 192 <tr> 193 <td class="md"> 194 <table cellpadding="0" cellspacing="0" border="0"> 195 <tr> 196 <td class="md" nowrap valign="top"> uint32 PV2WayConnectOptions::iLocalIdSize 197 </table> 198 </td> 199 </tr> 200 </table> 201 <table cellspacing=5 cellpadding=0 border=0> 202 <tr> 203 <td> 204 205 </td> 206 <td> 207 208 <p> 209 The size of the local id </td> 210 </tr> 211 </table> 212 <a name="m0" doxytag="PV2WayConnectOptions::iLoopbackMode"></a><p> 213 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 214 <tr> 215 <td class="md"> 216 <table cellpadding="0" cellspacing="0" border="0"> 217 <tr> 218 <td class="md" nowrap valign="top"> <a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a> PV2WayConnectOptions::iLoopbackMode 219 </table> 220 </td> 221 </tr> 222 </table> 223 <table cellspacing=5 cellpadding=0 border=0> 224 <tr> 225 <td> 226 227 </td> 228 <td> 229 230 <p> 231 The loopback mode </td> 232 </tr> 233 </table> 234 <a name="m3" doxytag="PV2WayConnectOptions::iRemoteId"></a><p> 235 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 236 <tr> 237 <td class="md"> 238 <table cellpadding="0" cellspacing="0" border="0"> 239 <tr> 240 <td class="md" nowrap valign="top"> uint8* PV2WayConnectOptions::iRemoteId 241 </table> 242 </td> 243 </tr> 244 </table> 245 <table cellspacing=5 cellpadding=0 border=0> 246 <tr> 247 <td> 248 249 </td> 250 <td> 251 252 <p> 253 The id of the peer </td> 254 </tr> 255 </table> 256 <a name="m4" doxytag="PV2WayConnectOptions::iRemoteIdSize"></a><p> 257 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 258 <tr> 259 <td class="md"> 260 <table cellpadding="0" cellspacing="0" border="0"> 261 <tr> 262 <td class="md" nowrap valign="top"> uint32 PV2WayConnectOptions::iRemoteIdSize 263 </table> 264 </td> 265 </tr> 266 </table> 267 <table cellspacing=5 cellpadding=0 border=0> 268 <tr> 269 <td> 270 271 </td> 272 <td> 273 274 <p> 275 The size of the remote id </td> 276 </tr> 277 </table> 278 <hr>The documentation for this class was generated from the following file:<ul> 279 <li><a class="el" href="pv__2way__basic__types_8h-source.html">pv_2way_basic_types.h</a></ul> 280 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small> 281 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 282 </small></address> 283 </body> 284 </html> 285
