|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE reference |
|
11 PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
12 <reference id="GUID-0B5DB521-831C-5016-BD38-EC7E86F41513" xml:lang="en"><title>Reference</title><shortdesc>This section provides a summary of documents related to DHCP that |
|
13 you can refer. </shortdesc><prolog><metadata><keywords/></metadata></prolog><refbody> |
|
14 <section id="GUID-A4EF7DE7-E35A-413B-B4B5-4FA17CA79B79"><p>The following table explains the various constants used to extract |
|
15 the DHCP options available in Symbian platform. </p> </section> |
|
16 <table id="GUID-D1DC6D41-F1FB-5EDE-938C-113EF7CC1E59"> |
|
17 <tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/> |
|
18 <tbody> |
|
19 <row> |
|
20 <entry><p> <b>Constant</b> </p> </entry> |
|
21 <entry><p> <b>Description</b> </p> </entry> |
|
22 <entry><p> <b>Version Supported</b> </p> </entry> |
|
23 </row> |
|
24 <row> |
|
25 <entry><p> <xref href="GUID-C31641DD-17C8-312B-A700-4F267F1B6125.dita"><apiname>KConnGetCurrentAddr</apiname></xref> </p> </entry> |
|
26 <entry><p>Retrieves the current IP address that the host uses. </p> </entry> |
|
27 <entry><p>IPv4 and IPv6 </p> </entry> |
|
28 </row> |
|
29 <row> |
|
30 <entry><p> <xref href="GUID-69EEB521-4987-39FB-B20D-54C04A4A3F7C.dita"><apiname>KConnGetServerAddr</apiname></xref> </p> </entry> |
|
31 <entry><p>Retrieves the DHCP IP address of the server. </p> </entry> |
|
32 <entry><p>IPv4 and IPv6 </p> </entry> |
|
33 </row> |
|
34 <row> |
|
35 <entry><p> <xref href="GUID-2B40B801-353B-34E1-A544-74D703EE7901.dita"><apiname> KConnGetAddrLeaseTimeRemain</apiname></xref> </p> </entry> |
|
36 <entry><p>Retrieves the remaining lease time of the current IP address. </p> </entry> |
|
37 <entry><p>IPv4 and IPv6 </p> </entry> |
|
38 </row> |
|
39 <row> |
|
40 <entry><p> <xref href="GUID-42842D3A-C957-3D29-9994-D917E46AA9FF.dita"><apiname>KConnAddrRelease</apiname></xref> </p> </entry> |
|
41 <entry><p>Releases the current IP address. </p> </entry> |
|
42 <entry><p>IPv4 and IPv6 </p> </entry> |
|
43 </row> |
|
44 <row> |
|
45 <entry><p> <xref href="GUID-013EA689-1417-34E1-8653-27C05B412527.dita"><apiname>KConnAddrRenew</apiname></xref> </p> </entry> |
|
46 <entry><p>Renews the current lease of the IP address. </p> </entry> |
|
47 <entry><p>IPv4 and IPv6 </p> </entry> |
|
48 </row> |
|
49 <row> |
|
50 <entry><p> <xref href="GUID-8530A427-8B0B-3E98-A99C-AC1278EBC524.dita"><apiname>KConnGetDhcpRawOptionData</apiname></xref> </p> </entry> |
|
51 <entry><p>Retrieves raw data from the DHCP messages. </p> </entry> |
|
52 <entry><p>IPv4 and IPv6 </p> </entry> |
|
53 </row> |
|
54 <row> |
|
55 <entry><p> <xref href="GUID-A5473E87-D8C9-3115-933A-6C4A3AE16C12.dita"><apiname>KConnGetSipServerAddr</apiname></xref> </p> </entry> |
|
56 <entry><p>Retrieves the SIP server address. </p> </entry> |
|
57 <entry><p>IPv4 and IPv6 </p> </entry> |
|
58 </row> |
|
59 <row> |
|
60 <entry><p> <xref href="GUID-FC3DED28-B14B-34F5-98FA-94BA583E826A.dita"><apiname>KConnGetSipServerDomain</apiname></xref> </p> </entry> |
|
61 <entry><p>Retrieves the SIP server domain name. </p> </entry> |
|
62 <entry><p>IPv4 and IPv6 </p> </entry> |
|
63 </row> |
|
64 <row> |
|
65 <entry><p> <xref href="GUID-84090B89-AEA7-31C5-A8E5-7FACA300913C.dita"><apiname>KConnGetDhcpHdrSname</apiname></xref> </p> </entry> |
|
66 <entry><p>Retrieves the host name of next available DHCP server. </p> </entry> |
|
67 <entry><p>IPv4 only </p> </entry> |
|
68 </row> |
|
69 <row> |
|
70 <entry><p> <xref href="GUID-D3921873-7EF1-3CD8-A29D-ED670284E264.dita"><apiname>KConngetDhcpHdrSiaddr</apiname></xref> </p> </entry> |
|
71 <entry><p>Retrieves the IP address of next available DHCP server. </p> </entry> |
|
72 <entry><p>IPv4 only </p> </entry> |
|
73 </row> |
|
74 <row> |
|
75 <entry><p> <xref href="GUID-CF70542A-F5EA-3A74-8EF4-14653F74FD90.dita"><apiname>KConnGetTftpServerAddr</apiname></xref> </p> </entry> |
|
76 <entry><p>Retrieves the IP address of the TFTP server. </p> </entry> |
|
77 <entry><p>IPv4 only </p> </entry> |
|
78 </row> |
|
79 <row> |
|
80 <entry><p> <xref href="GUID-5B39ECDB-7907-3E99-9849-E16F5404A2C3.dita"><apiname>KConnDhcpGetMultipleParams</apiname></xref> </p> </entry> |
|
81 <entry><p>Retrieves multiple option code data in raw format. </p> </entry> |
|
82 <entry><p>IPv4 only </p> </entry> |
|
83 </row> |
|
84 <row> |
|
85 <entry><p> <xref href="GUID-5EB4D73D-B71A-3841-B6A0-5B3EF910AD49.dita"><apiname>KConnGetTftpServerName</apiname></xref> </p> </entry> |
|
86 <entry><p>Retrieves the host name of the TFTP server. </p> </entry> |
|
87 <entry><p>IPv4 only </p> </entry> |
|
88 </row> |
|
89 </tbody> |
|
90 </tgroup> |
|
91 </table> |
|
92 <section id="GUID-C87E13BE-0190-4BF2-A8C1-833BF89B5A1C"><title>Comms Database Configuration for DHCP</title> <p>To use the |
|
93 DHCP, the following records have to be modified in the Comms Database <xref href="GUID-387A8240-0765-52F2-98A4-8F9FC809E03E.dita#GUID-387A8240-0765-52F2-98A4-8F9FC809E03E/GUID-7230C019-50CA-52A6-A21B-EED1C6D7E60C">service |
|
94 table</xref>. </p> <table id="GUID-DCEE5CA8-6C91-5E1B-B8DD-00ED85C48F0E"> |
|
95 <tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/> |
|
96 <tbody> |
|
97 <row> |
|
98 <entry><p> <b>Record name</b> </p> </entry> |
|
99 <entry><p> <b>Description</b> </p> </entry> |
|
100 <entry><p> <b>Value</b> </p> </entry> |
|
101 </row> |
|
102 <row> |
|
103 <entry><p> <codeph>ConfigDaemonName</codeph> </p> </entry> |
|
104 <entry><p>Name of the DHCP daemon to be loaded by the Nifman. </p> </entry> |
|
105 <entry><p>DhcpServ </p> </entry> |
|
106 </row> |
|
107 <row> |
|
108 <entry><p> <codeph>IpAddrFromServ</codeph> </p> </entry> |
|
109 <entry><p>Determines if an IP address is required from the DHCP server. </p> </entry> |
|
110 <entry><p>TRUE </p> </entry> |
|
111 </row> |
|
112 <row> |
|
113 <entry><p> <codeph>IfNetworks</codeph> </p> </entry> |
|
114 <entry><p>The protocols supported by the connection. </p> </entry> |
|
115 <entry><p>ip for IPv4 networks or ip6 for IPv6 networks </p> </entry> |
|
116 </row> |
|
117 </tbody> |
|
118 </tgroup> |
|
119 </table> <p>If the <codeph>IpAddrFromServ</codeph> field is set to <b>FALSE</b>, |
|
120 the <codeph>IPAddr</codeph> field must be set with a static IP address. </p> <p>The |
|
121 DHCP daemon in the comms database configures the following DHCP related fields: </p> <table id="GUID-AABD79CB-40C0-57E3-B107-72095BB091C8"> |
|
122 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
123 <tbody> |
|
124 <row> |
|
125 <entry><p> <b>Record name</b> </p> </entry> |
|
126 <entry><p> <b>Description</b> </p> </entry> |
|
127 </row> |
|
128 <row> |
|
129 <entry><p>IpAddrLeaseValidFrom </p> </entry> |
|
130 <entry><p>The start time of the IP address. </p> </entry> |
|
131 </row> |
|
132 <row> |
|
133 <entry><p>IpAddrLeaseValidTo </p> </entry> |
|
134 <entry><p>The end time of the IP address. </p> </entry> |
|
135 </row> |
|
136 <row> |
|
137 <entry><p>IpAddr </p> </entry> |
|
138 <entry><p>The IP address of the device. </p> </entry> |
|
139 </row> |
|
140 </tbody> |
|
141 </tgroup> |
|
142 </table> </section> |
|
143 </refbody></reference> |