reference/geoip/functions/geoip-netspeedcell-by-name.xml
4754397753fd79f1c846868b66a2448babab1c54
...
...
@@ -1,129 +1,129 @@
1
-
<?xml version="1.0" encoding="utf-8"?>
2
-
<!-- $Revision$ -->
3
-
<refentry xml:id="function.geoip-netspeedcell-by-name" xmlns="http://docbook.org/ns/docbook">
4
-
<refnamediv>
5
-
<refname>geoip_netspeedcell_by_name</refname>
6
-
<refpurpose>Get the Internet connection speed</refpurpose>
7
-
</refnamediv>
8
-
<refsect1 role="description">
9
-
&reftitle.description;
10
-
<methodsynopsis>
11
-
<type>string</type><methodname>geoip_netspeedcell_by_name</methodname>
12
-
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
13
-
</methodsynopsis>
14
-
15
-
<para>
16
-
The <function>geoip_netspeedcell_by_name</function> function will return the Internet
17
-
connection type and speed corresponding to a hostname or an IP address.
18
-
</para>
19
-
<para>
20
-
This function is only available if using GeoIP Library version 1.4.8 or newer.
21
-
</para>
22
-
<para>
23
-
This function is currently only available to users who have bought a commercial
24
-
GeoIP NetSpeedCell Edition. A warning will be issued if the proper database cannot be
25
-
located.
26
-
</para>
27
-
<para>
28
-
The return value is a string, common values are:
29
-
</para>
30
-
<para>
31
-
<itemizedlist>
32
-
<listitem>
33
-
<simpara>
34
-
Cable/DSL
35
-
</simpara>
36
-
</listitem>
37
-
<listitem>
38
-
<simpara>
39
-
Dialup
40
-
</simpara>
41
-
</listitem>
42
-
<listitem>
43
-
<simpara>
44
-
Cellular
45
-
</simpara>
46
-
</listitem>
47
-
<listitem>
48
-
<simpara>
49
-
Corporate
50
-
</simpara>
51
-
</listitem>
52
-
</itemizedlist>
53
-
</para>
54
-
55
-
</refsect1>
56
-
<refsect1 role="parameters">
57
-
&reftitle.parameters;
58
-
<para>
59
-
<variablelist>
60
-
<varlistentry>
61
-
<term><parameter>hostname</parameter></term>
62
-
<listitem>
63
-
<para>
64
-
The hostname or IP address.
65
-
</para>
66
-
</listitem>
67
-
</varlistentry>
68
-
</variablelist>
69
-
</para>
70
-
</refsect1>
71
-
<refsect1 role="returnvalues">
72
-
&reftitle.returnvalues;
73
-
<para>
74
-
Returns the connection speed on success, or &false; if the address
75
-
cannot be found in the database.
76
-
</para>
77
-
</refsect1>
78
-
79
-
<refsect1 role="examples">
80
-
&reftitle.examples;
81
-
<para>
82
-
<example>
83
-
<title>A <function>geoip_netspeedcell_by_name</function> example</title>
84
-
<para>
85
-
This will output the connection speed of the host example.com.
86
-
</para>
87
-
<programlisting role="php">
88
-
<![CDATA[
89
-
<?php
90
-
$netspeed = geoip_netspeedcell_by_name('www.example.com');
91
-
92
-
if ($netspeed) {
93
-
echo 'The connection type is: '. $netspeed;
94
-
}
95
-
?>
96
-
]]>
97
-
</programlisting>
98
-
&example.outputs;
99
-
<screen>
100
-
<![CDATA[
101
-
The connection type is: Corporate
102
-
]]>
103
-
</screen>
104
-
</example>
105
-
</para>
106
-
</refsect1>
107
-
108
-
</refentry>
109
-
110
-
<!-- Keep this comment at the end of the file
111
-
Local variables:
112
-
mode: sgml
113
-
sgml-omittag:t
114
-
sgml-shorttag:t
115
-
sgml-minimize-attributes:nil
116
-
sgml-always-quote-attributes:t
117
-
sgml-indent-step:1
118
-
sgml-indent-data:t
119
-
indent-tabs-mode:nil
120
-
sgml-parent-document:nil
121
-
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
122
-
sgml-exposed-tags:nil
123
-
sgml-local-catalogs:nil
124
-
sgml-local-ecat-files:nil
125
-
End:
126
-
vim600: syn=xml fen fdm=syntax fdl=2 si
127
-
vim: et tw=78 syn=sgml
128
-
vi: ts=1 sw=1
129
-
-->
1
+
<?xml version="1.0" encoding="utf-8"?>
2
+
<!-- $Revision$ -->
3
+
<refentry xml:id="function.geoip-netspeedcell-by-name" xmlns="http://docbook.org/ns/docbook">
4
+
<refnamediv>
5
+
<refname>geoip_netspeedcell_by_name</refname>
6
+
<refpurpose>Get the Internet connection speed</refpurpose>
7
+
</refnamediv>
8
+
<refsect1 role="description">
9
+
&reftitle.description;
10
+
<methodsynopsis>
11
+
<type>string</type><methodname>geoip_netspeedcell_by_name</methodname>
12
+
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
13
+
</methodsynopsis>
14
+

15
+
<para>
16
+
The <function>geoip_netspeedcell_by_name</function> function will return the Internet
17
+
connection type and speed corresponding to a hostname or an IP address.
18
+
</para>
19
+
<para>
20
+
This function is only available if using GeoIP Library version 1.4.8 or newer.
21
+
</para>
22
+
<para>
23
+
This function is currently only available to users who have bought a commercial
24
+
GeoIP NetSpeedCell Edition. A warning will be issued if the proper database cannot be
25
+
located.
26
+
</para>
27
+
<para>
28
+
The return value is a string, common values are:
29
+
</para>
30
+
<para>
31
+
<itemizedlist>
32
+
<listitem>
33
+
<simpara>
34
+
Cable/DSL
35
+
</simpara>
36
+
</listitem>
37
+
<listitem>
38
+
<simpara>
39
+
Dialup
40
+
</simpara>
41
+
</listitem>
42
+
<listitem>
43
+
<simpara>
44
+
Cellular
45
+
</simpara>
46
+
</listitem>
47
+
<listitem>
48
+
<simpara>
49
+
Corporate
50
+
</simpara>
51
+
</listitem>
52
+
</itemizedlist>
53
+
</para>
54
+
55
+
</refsect1>
56
+
<refsect1 role="parameters">
57
+
&reftitle.parameters;
58
+
<para>
59
+
<variablelist>
60
+
<varlistentry>
61
+
<term><parameter>hostname</parameter></term>
62
+
<listitem>
63
+
<para>
64
+
The hostname or IP address.
65
+
</para>
66
+
</listitem>
67
+
</varlistentry>
68
+
</variablelist>
69
+
</para>
70
+
</refsect1>
71
+
<refsect1 role="returnvalues">
72
+
&reftitle.returnvalues;
73
+
<para>
74
+
Returns the connection speed on success, or &false; if the address
75
+
cannot be found in the database.
76
+
</para>
77
+
</refsect1>
78
+

79
+
<refsect1 role="examples">
80
+
&reftitle.examples;
81
+
<para>
82
+
<example>
83
+
<title>A <function>geoip_netspeedcell_by_name</function> example</title>
84
+
<para>
85
+
This will output the connection speed of the host example.com.
86
+
</para>
87
+
<programlisting role="php">
88
+
<![CDATA[
89
+
<?php
90
+
$netspeed = geoip_netspeedcell_by_name('www.example.com');
91
+

92
+
if ($netspeed) {
93
+
echo 'The connection type is: '. $netspeed;
94
+
}
95
+
?>
96
+
]]>
97
+
</programlisting>
98
+
&example.outputs;
99
+
<screen>
100
+
<![CDATA[
101
+
The connection type is: Corporate
102
+
]]>
103
+
</screen>
104
+
</example>
105
+
</para>
106
+
</refsect1>
107
+

108
+
</refentry>
109
+

110
+
<!-- Keep this comment at the end of the file
111
+
Local variables:
112
+
mode: sgml
113
+
sgml-omittag:t
114
+
sgml-shorttag:t
115
+
sgml-minimize-attributes:nil
116
+
sgml-always-quote-attributes:t
117
+
sgml-indent-step:1
118
+
sgml-indent-data:t
119
+
indent-tabs-mode:nil
120
+
sgml-parent-document:nil
121
+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
122
+
sgml-exposed-tags:nil
123
+
sgml-local-catalogs:nil
124
+
sgml-local-ecat-files:nil
125
+
End:
126
+
vim600: syn=xml fen fdm=syntax fdl=2 si
127
+
vim: et tw=78 syn=sgml
128
+
vi: ts=1 sw=1
129
+
-->
130
130