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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision: 297078 $ -->
<reference xml:id="ref.sam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>SAM &Functions;</title>
<partintro>
<!-- FIXME: Upgrade to the new-oo-markup -->
<!-- class definition section -->
<section xml:id='sam.classes'>
&reftitle.classes;
<!-- Connection class -->
<section xml:id='sam.class.Connection'>
<title><classname>SAMConnection</classname></title>
<para>
Object representing a connection to a Messaging Server
</para>
<section xml:id='sam.class.Connection.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para>
<link linkend='function.samconnection-constructor'>new SAMConnection</link> - construct a new connection object to allow connection to a messaging infrastructure.
</para>
</listitem>
</itemizedlist>
</section> <!-- xml:id=sam.class.Connection.constructor -->
<section xml:id='sam.class.Connection.methods'>
&reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link linkend='function.samconnection-commit'>commit</link>
- a method that commits (successfully completes) an in-flight unit
of work.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-connect'>connect</link>
- a method that connects a PHP script to a messaging server.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-disconnect'>disconnect</link>
- a method that disconnects a PHP script from a messaging server.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-isconnected'>isConnected</link>
- a method that checks whether a PHP script is connected to a
messaging server.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-peek'>peek</link>
- a method that receives a message from a queue without removing it
from the queue.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-peekall'>peekAll</link>
- a method that receives one or messages from a queue without
removing them from the queue.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-receive'>receive</link>
- a method that receives a message from a queue or subscription.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-remove'>remove</link>
- a method that removes a message from a queue.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-rollback'>rollback</link>
- a method that cancels (rolls back) an in-flight unit of work.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-send'>send</link>
- a method that sends a message to a queue or posts to a topic
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-setDebug'>setDebug</link>
- a method that switches additional debugging output on or off
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-subscribe'>subscribe</link>
- a method that creates a subscription to one or more topics
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-unsubscribe'>unsubscribe</link>
- a method that destroys a subscription to one or more topics
</para>
</listitem>
</itemizedlist>
</section> <!-- xml:id=sam.class.Connection.methods -->
<section xml:id='sam.class.Connection.properties'>
&reftitle.properties;
<itemizedlist>
<listitem>
<para>
<link linkend='function.samconnection-errno'>errno</link> - the
numeric error code for the last encountered error on this
connection. This property is set to 0 if the last operation was
successful.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.samconnection-error'>error</link> - the
text description for the last encountered error on this connection
</para>
</listitem>
</itemizedlist>
</section> <!-- xml:id=sam.class.Connection.properties -->
</section> <!-- xml:id=sam.class.Connection -->
<!-- Message class *************************************************** -->
<section xml:id='sam.class.Message'>
<title><classname>SAMMessage</classname></title>
<para>
Object representing a message to be sent or received
</para>
<section xml:id='sam.class.Message.constructor'>
&reftitle.constructor;
<itemizedlist>
<listitem>
<para>
<link linkend='function.sammessage-constructor'>new SAMMessage</link> - construct a
new message.
</para>
</listitem>
</itemizedlist>
</section> <!-- xml:id=sam.class.Message.constructor -->
<section xml:id='sam.class.Message.properties'>
&reftitle.properties;
<itemizedlist>
<listitem>
<para>
<link linkend='function.sammessage-body'>body</link> - the body of
the message.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.sammessage-header'>header</link> - the
header properties of the message.
</para>
</listitem>
</itemizedlist>
</section> <!-- xml:id=sam.class.Message.methods -->
</section> <!-- xml:id=sam.class.Message -->
</section> <!-- xml:id=sam.classes -->
</partintro>
<!-- This seems to create the table of contents -->
&reference.sam.entities.functions;
</reference>
<!-- 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
-->
|
