doc/pv2way_html/classPV2WayConnectOptions.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PV2WayConnectOptions class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>PV2WayConnectOptions Class Reference</h1><code>#include &lt;<a class="el" href="pv__2way__basic__types_8h-source.html">pv_2way_basic_types.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PV2WayConnectOptions:
<p><center><img src="classPV2WayConnectOptions.png" usemap="#PV2WayConnectOptions_map" border="0" alt=""></center>
<map name="PV2WayConnectOptions_map">
<area href="classPV2Way324ConnectOptions.html" alt="PV2Way324ConnectOptions" shape="rect" coords="0,56,172,80">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#a0">PV2WayConnectOptions</a> ()</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</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>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#a2">GetConnectInfoClassName</a> (OSCL_wString &amp;aClassName)=0</td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a>&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m0">iLoopbackMode</a></td></tr>
<tr><td nowrap align=right valign=top>uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m1">iLocalId</a></td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m2">iLocalIdSize</a></td></tr>
<tr><td nowrap align=right valign=top>uint8 *&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m3">iRemoteId</a></td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classPV2WayConnectOptions.html#m4">iRemoteIdSize</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
PV2WayConnectOptions Class
<p>
PV2WayConnectOptions class contains options to be specified during connect 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="PV2WayConnectOptions::PV2WayConnectOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PV2WayConnectOptions::PV2WayConnectOptions </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Default Constructor     </td>
  </tr>
</table>
<a name="a1" doxytag="PV2WayConnectOptions::PV2WayConnectOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PV2WayConnectOptions::PV2WayConnectOptions </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>aLoopbackMode</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>uint8 *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>aLocalId</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>uint32&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>aLocalIdSize</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>uint8 *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>aRemoteId</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>uint32&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>aRemoteIdSize</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aLoopbackMode</em>&nbsp;</td><td>
The loopback mode to used during Connect </td></tr>
<tr><td valign=top><em>aLocalId, aLocalIdSize</em>&nbsp;</td><td>
A unique octet string identifying the local terminal </td></tr>
<tr><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>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
void </dl>    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="PV2WayConnectOptions::GetConnectInfoClassName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void PV2WayConnectOptions::GetConnectInfoClassName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">OSCL_wString &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>aClassName</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Pure virtual method that must be overridden. Retrieves class name<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><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>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
void </dl>
<p>
Implemented in <a class="el" href="classPV2Way324ConnectOptions.html#a3">PV2Way324ConnectOptions</a>.    </td>
  </tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="m1" doxytag="PV2WayConnectOptions::iLocalId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> uint8* PV2WayConnectOptions::iLocalId
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The id of the local terminal     </td>
  </tr>
</table>
<a name="m2" doxytag="PV2WayConnectOptions::iLocalIdSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> uint32 PV2WayConnectOptions::iLocalIdSize
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The size of the local id     </td>
  </tr>
</table>
<a name="m0" doxytag="PV2WayConnectOptions::iLoopbackMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="pv__2way__basic__types_8h.html#a45">TPVLoopbackMode</a> PV2WayConnectOptions::iLoopbackMode
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The loopback mode     </td>
  </tr>
</table>
<a name="m3" doxytag="PV2WayConnectOptions::iRemoteId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> uint8* PV2WayConnectOptions::iRemoteId
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The id of the peer     </td>
  </tr>
</table>
<a name="m4" doxytag="PV2WayConnectOptions::iRemoteIdSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> uint32 PV2WayConnectOptions::iRemoteIdSize
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The size of the remote id     </td>
  </tr>
</table>
<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></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>