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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 323238 $ -->
<refentry xml:id="amqpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AMQPConnection::__construct</refname>
<refpurpose>Create an instance of AMQPConnection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>AMQPConnection::__construct</methodname>
<methodparam choice="opt"><type>array</type><parameter>credentials</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
Creates an <classname>AMQPConnection</classname> instance representing a connection to an AMQP broker.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>credentials</parameter></term>
<listitem>
<para>
The <parameter>credentials</parameter> is an optional array of credential information for connecting to the AMQP
broker.
</para>
<table>
<title>Supported indexes</title>
<tgroup cols="3">
<thead>
<row>
<entry>key</entry>
<entry>Description</entry>
<entry>Default value</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>host</emphasis></entry>
<entry>The host to connect too <note><simpara>Max 1024 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.host">amqp.host</link></entry>
</row>
<row>
<entry><emphasis>port</emphasis></entry>
<entry>Port on the host</entry>
<entry><link linkend="ini.amqp.port">amqp.port</link></entry>
</row>
<row>
<entry><emphasis>vhost</emphasis></entry>
<entry>The virtual host on the host <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.vhost">amqp.vhost</link></entry>
</row>
<row>
<entry><emphasis>login</emphasis></entry>
<entry>The login name to use. <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.login">amqp.login</link></entry>
</row>
<row>
<entry><emphasis>password</emphasis></entry>
<entry>Password <note><simpara>Max 128 characters</simpara></note></entry>
<entry><link linkend="ini.amqp.password">amqp.password</link></entry>
</row>
</tbody>
</tgroup>
</table>
<para>All other keys will be ignored.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An AMQPConnection object.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>AMQPException</classname> exception on parameter parsing
failures, and option errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><methodname>AMQPConnection::__construct</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Create a connection using the INI values */
$connection1 = new AMQPConnection();
/* Specifying all keys */
$connection2 = new AMQPConnection(array(
'host' => 'example.host',
'vhost' => '/',
'port' => 5763,
'login' => 'user',
'password' => 'password'
));
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
A connection will not be established until <methodname>AMQPConnection::connect</methodname> is called.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
