aboutsummaryrefslogtreecommitdiff
path: root/doc/pv2way_html/classPV2Way324ConnectOptions.html
blob: d0b087dc96928eafb6106bc36849537ee4727556 (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
<!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: PV2Way324ConnectOptions 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>PV2Way324ConnectOptions Class Reference</h1><!-- doxytag: class="PV2Way324ConnectOptions" --><!-- doxytag: inherits="PV2WayConnectOptions" -->
<p><code>#include &lt;<a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_types.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PV2Way324ConnectOptions:</div>
<div class="dynsection">
 <div class="center">
  <img src="classPV2Way324ConnectOptions.png" usemap="#PV2Way324ConnectOptions_map" alt=""/>
  <map id="PV2Way324ConnectOptions_map" name="PV2Way324ConnectOptions_map">
<area href="classPV2WayConnectOptions.html" alt="PV2WayConnectOptions" shape="rect" coords="0,0,172,24"/>
</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="classPV2Way324ConnectOptions.html#aa103d77dca7705725ad064278166f54f">PV2Way324ConnectOptions</a> (uint32 aDisconnectTimeoutInterval)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2Way324ConnectOptions.html#ac722303586a707e05260b351e5d6b03e">PV2Way324ConnectOptions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2Way324ConnectOptions.html#a32a936298f2d7cc48dea52d3ee580b05">~PV2Way324ConnectOptions</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2Way324ConnectOptions.html#a990e77848c4d76d87ec594d0a64f7113">GetConnectInfoClassName</a> (OSCL_wString &amp;aClassName)</td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2Way324ConnectOptions.html#a30d82039d9cc943e0c9ab15edb45e835">iDisconnectTimeoutInterval</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classPV2Way324ConnectOptions.html">PV2Way324ConnectOptions</a> Class</p>
<p><a class="el" href="classPV2Way324ConnectOptions.html">PV2Way324ConnectOptions</a> implements the <a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> interface and is used for 324M specific initialization. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa103d77dca7705725ad064278166f54f"></a><!-- doxytag: member="PV2Way324ConnectOptions::PV2Way324ConnectOptions" ref="aa103d77dca7705725ad064278166f54f" args="(uint32 aDisconnectTimeoutInterval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PV2Way324ConnectOptions::PV2Way324ConnectOptions </td>
          <td>(</td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>aDisconnectTimeoutInterval</em></td>
          <td>&nbsp;)&nbsp;</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>disconnectTimeout</em>&nbsp;</td><td>The interval to wait after initiating a disconnect before stopping signalling </td></tr>
  </table>
  </dd>
</dl>

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

</div>
</div>
<a class="anchor" id="a32a936298f2d7cc48dea52d3ee580b05"></a><!-- doxytag: member="PV2Way324ConnectOptions::~PV2Way324ConnectOptions" ref="a32a936298f2d7cc48dea52d3ee580b05" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PV2Way324ConnectOptions::~PV2Way324ConnectOptions </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="a990e77848c4d76d87ec594d0a64f7113"></a><!-- doxytag: member="PV2Way324ConnectOptions::GetConnectInfoClassName" ref="a990e77848c4d76d87ec594d0a64f7113" args="(OSCL_wString &amp;aClassName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PV2Way324ConnectOptions::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> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Retrieves the 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, this class will assign the string "CPV2Way324ConnectInfo" </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>

<p>Implements <a class="el" href="classPV2WayConnectOptions.html#a3609802000747ebac57a07f2d75d5b27">PV2WayConnectOptions</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a30d82039d9cc943e0c9ab15edb45e835"></a><!-- doxytag: member="PV2Way324ConnectOptions::iDisconnectTimeoutInterval" ref="a30d82039d9cc943e0c9ab15edb45e835" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 <a class="el" href="classPV2Way324ConnectOptions.html#a30d82039d9cc943e0c9ab15edb45e835">PV2Way324ConnectOptions::iDisconnectTimeoutInterval</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The disconnect timeout interval in units of 100ms </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_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>