rubywmq 0.3.0-i386-mswin32-mq6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +13 -0
- data/README +73 -0
- data/doc/classes/WMQ.html +6300 -0
- data/doc/classes/WMQ/Message.html +376 -0
- data/doc/classes/WMQ/Message.src/M000001.html +77 -0
- data/doc/classes/WMQ/Message.src/M000002.html +27 -0
- data/doc/classes/WMQ/Queue.html +1459 -0
- data/doc/classes/WMQ/Queue.src/M000003.html +205 -0
- data/doc/classes/WMQ/Queue.src/M000004.html +107 -0
- data/doc/classes/WMQ/Queue.src/M000005.html +198 -0
- data/doc/classes/WMQ/Queue.src/M000006.html +66 -0
- data/doc/classes/WMQ/Queue.src/M000007.html +203 -0
- data/doc/classes/WMQ/Queue.src/M000008.html +265 -0
- data/doc/classes/WMQ/Queue.src/M000009.html +120 -0
- data/doc/classes/WMQ/Queue.src/M000010.html +28 -0
- data/doc/classes/WMQ/Queue.src/M000011.html +30 -0
- data/doc/classes/WMQ/Queue.src/M000012.html +31 -0
- data/doc/classes/WMQ/Queue.src/M000013.html +31 -0
- data/doc/classes/WMQ/Queue.src/M000014.html +31 -0
- data/doc/classes/WMQ/QueueManager.html +1529 -0
- data/doc/classes/WMQ/QueueManager.src/M000015.html +182 -0
- data/doc/classes/WMQ/QueueManager.src/M000016.html +194 -0
- data/doc/classes/WMQ/QueueManager.src/M000017.html +92 -0
- data/doc/classes/WMQ/QueueManager.src/M000018.html +70 -0
- data/doc/classes/WMQ/QueueManager.src/M000019.html +49 -0
- data/doc/classes/WMQ/QueueManager.src/M000020.html +49 -0
- data/doc/classes/WMQ/QueueManager.src/M000021.html +63 -0
- data/doc/classes/WMQ/QueueManager.src/M000022.html +61 -0
- data/doc/classes/WMQ/QueueManager.src/M000023.html +65 -0
- data/doc/classes/WMQ/QueueManager.src/M000024.html +232 -0
- data/doc/classes/WMQ/QueueManager.src/M000025.html +30 -0
- data/doc/classes/WMQ/QueueManager.src/M000026.html +31 -0
- data/doc/classes/WMQ/QueueManager.src/M000027.html +31 -0
- data/doc/classes/WMQ/QueueManager.src/M000028.html +38 -0
- data/doc/classes/WMQ/QueueManager.src/M000029.html +33 -0
- data/doc/classes/WMQ/QueueManager.src/M000030.html +21 -0
- data/doc/classes/WMQ/QueueManager.src/M000031.html +284 -0
- data/doc/classes/WMQ/QueueManager.src/M000032.html +24 -0
- data/doc/classes/WMQ/QueueManager.src/M000033.html +18 -0
- data/doc/classes/WMQ/QueueManager.src/M000034.html +46 -0
- data/doc/classes/WMQ/QueueManager.src/M000035.html +27 -0
- data/doc/classes/WMQ/WMQException.html +111 -0
- data/doc/created.rid +1 -0
- data/doc/files/ext/lib/wmq_const_admin_rb.html +128 -0
- data/doc/files/ext/lib/wmq_const_rb.html +128 -0
- data/doc/files/ext/lib/wmq_temp_rb.html +122 -0
- data/doc/files/ext/wmq_c.html +101 -0
- data/doc/files/ext/wmq_message_c.html +101 -0
- data/doc/files/ext/wmq_queue_c.html +101 -0
- data/doc/files/ext/wmq_queue_manager_c.html +101 -0
- data/doc/fr_class_index.html +31 -0
- data/doc/fr_file_index.html +33 -0
- data/doc/fr_method_index.html +61 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/examples/each_a.rb +31 -0
- data/examples/each_b.rb +40 -0
- data/examples/each_header.rb +37 -0
- data/examples/files_to_q.cfg +24 -0
- data/examples/files_to_q.rb +46 -0
- data/examples/get_a.rb +34 -0
- data/examples/get_client.rb +50 -0
- data/examples/put1_a.rb +24 -0
- data/examples/put1_b.rb +32 -0
- data/examples/put1_c.rb +31 -0
- data/examples/put_a.rb +34 -0
- data/examples/put_b.rb +42 -0
- data/examples/put_dlh.rb +40 -0
- data/examples/put_dynamic_q.rb +37 -0
- data/examples/put_rfh.rb +66 -0
- data/examples/put_rfh2_a.rb +42 -0
- data/examples/put_rfh2_b.rb +42 -0
- data/examples/put_xmit_q.rb +32 -0
- data/examples/q_to_files.cfg +17 -0
- data/examples/q_to_files.rb +47 -0
- data/examples/request.rb +59 -0
- data/examples/server.rb +96 -0
- data/lib/wmq.rb +25 -0
- data/lib/wmq/wmq.so +0 -0
- data/lib/wmq/wmq_const.rb +745 -0
- data/lib/wmq/wmq_const_admin.rb +555 -0
- data/lib/wmq/wmq_temp.rb +197 -0
- data/tests/test.rb +299 -0
- metadata +131 -0
@@ -0,0 +1,376 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: WMQ::Message</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">WMQ::Message</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../../files/ext/wmq_c.html">
|
59
|
+
ext/wmq.c
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
<a href="../../files/ext/lib/wmq_temp_rb.html">
|
63
|
+
ext/lib/wmq_temp.rb
|
64
|
+
</a>
|
65
|
+
<br />
|
66
|
+
</td>
|
67
|
+
</tr>
|
68
|
+
|
69
|
+
<tr class="top-aligned-row">
|
70
|
+
<td><strong>Parent:</strong></td>
|
71
|
+
<td>
|
72
|
+
Object
|
73
|
+
</td>
|
74
|
+
</tr>
|
75
|
+
</table>
|
76
|
+
</div>
|
77
|
+
<!-- banner header -->
|
78
|
+
|
79
|
+
<div id="bodyContent">
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
<div id="contextContent">
|
84
|
+
|
85
|
+
<div id="description">
|
86
|
+
<p>
|
87
|
+
<a href="Message.html">Message</a> contains the message descriptor (MQMD),
|
88
|
+
data and any headers.
|
89
|
+
</p>
|
90
|
+
<p>
|
91
|
+
Note:
|
92
|
+
</p>
|
93
|
+
<ul>
|
94
|
+
<li>The format in the descriptor applies only to the format of the data
|
95
|
+
portion, not the format of any included headers
|
96
|
+
|
97
|
+
</li>
|
98
|
+
<li>The message format can ONLY be supplied in the descriptor.
|
99
|
+
|
100
|
+
<ul>
|
101
|
+
<li>I.e. It is the format of the data, Not the headers.
|
102
|
+
|
103
|
+
</li>
|
104
|
+
<li>On the wire formats are determined automatically by the :header_type key
|
105
|
+
for each header
|
106
|
+
|
107
|
+
</li>
|
108
|
+
<li>Other WebSphere MQ interfaces require that the formats be
|
109
|
+
"daisy-chained"
|
110
|
+
|
111
|
+
<ul>
|
112
|
+
<li>I.e. The MQMD.Format is actually the format of the first header
|
113
|
+
|
114
|
+
</li>
|
115
|
+
<li>Ruby <a href="../WMQ.html">WMQ</a> removes this tedious requirement and
|
116
|
+
performs this requirement automatically under the covers
|
117
|
+
|
118
|
+
</li>
|
119
|
+
</ul>
|
120
|
+
</li>
|
121
|
+
<li>The format of any header should not be supplied in the descriptor or any
|
122
|
+
header
|
123
|
+
|
124
|
+
</li>
|
125
|
+
</ul>
|
126
|
+
</li>
|
127
|
+
</ul>
|
128
|
+
<p>
|
129
|
+
<a href="Message.html">Message</a> has the following attributes:
|
130
|
+
</p>
|
131
|
+
<ul>
|
132
|
+
<li>descriptor = {
|
133
|
+
|
134
|
+
<pre>
|
135
|
+
# WebSphere MQ Equivalent
|
136
|
+
:format => WMQ::MQFMT_STRING, # MQMD.Format - Format of data only
|
137
|
+
WMQ::MQFMT_NONE # Do not supply header formats here
|
138
|
+
:original_length => Number # MQMD.OriginalLength
|
139
|
+
:priority => 0 .. 9 # MQMD.Priority
|
140
|
+
:put_time => String # MQMD.PutTime
|
141
|
+
:msg_id => String ...
|
142
|
+
:expiry => Number
|
143
|
+
:persistence => Number
|
144
|
+
:reply_to_q => String
|
145
|
+
:correl_id => String
|
146
|
+
:feedback => Number
|
147
|
+
:offset => Number
|
148
|
+
:report => Number
|
149
|
+
:msg_flags => Number
|
150
|
+
:reply_to_q_mgr => String
|
151
|
+
:appl_identity_data => String
|
152
|
+
:put_appl_name => String
|
153
|
+
:user_identifier => String
|
154
|
+
:msg_seq_number => Number
|
155
|
+
:appl_origin_data => String
|
156
|
+
:accounting_token => String
|
157
|
+
:backout_count => Number
|
158
|
+
:coded_char_set_id => Number
|
159
|
+
:put_appl_type => Number
|
160
|
+
:msg_type => Number
|
161
|
+
:group_id => String
|
162
|
+
:put_date => String
|
163
|
+
:encoding => Number
|
164
|
+
</pre>
|
165
|
+
<p>
|
166
|
+
}
|
167
|
+
</p>
|
168
|
+
</li>
|
169
|
+
<li>data => String
|
170
|
+
|
171
|
+
</li>
|
172
|
+
<li>headers => Array of Hashes
|
173
|
+
|
174
|
+
<ul>
|
175
|
+
<li>Note: Do not supply the format of any header. Ruby <a
|
176
|
+
href="../WMQ.html">WMQ</a> does this for you.
|
177
|
+
|
178
|
+
</li>
|
179
|
+
</ul>
|
180
|
+
<pre>
|
181
|
+
The following headers are supported:
|
182
|
+
</pre>
|
183
|
+
<ul>
|
184
|
+
<li>Rules And Formatting Header (RFH)
|
185
|
+
|
186
|
+
<pre>
|
187
|
+
:header_type => :rf_header
|
188
|
+
:....
|
189
|
+
</pre>
|
190
|
+
</li>
|
191
|
+
<li>Rules and Formatting V2 Header (RFH2)
|
192
|
+
|
193
|
+
<pre>
|
194
|
+
....
|
195
|
+
</pre>
|
196
|
+
</li>
|
197
|
+
<li>Dead Letter Header
|
198
|
+
|
199
|
+
</li>
|
200
|
+
<li>CICS Header
|
201
|
+
|
202
|
+
</li>
|
203
|
+
<li>IMS Header
|
204
|
+
|
205
|
+
</li>
|
206
|
+
<li>Transmission <a href="Queue.html">Queue</a> Header
|
207
|
+
|
208
|
+
</li>
|
209
|
+
<li>…
|
210
|
+
|
211
|
+
</li>
|
212
|
+
</ul>
|
213
|
+
</li>
|
214
|
+
</ul>
|
215
|
+
|
216
|
+
</div>
|
217
|
+
|
218
|
+
|
219
|
+
</div>
|
220
|
+
|
221
|
+
<div id="method-list">
|
222
|
+
<h3 class="section-bar">Methods</h3>
|
223
|
+
|
224
|
+
<div class="name-list">
|
225
|
+
<a href="#M000002">clear</a>
|
226
|
+
<a href="#M000001">new</a>
|
227
|
+
</div>
|
228
|
+
</div>
|
229
|
+
|
230
|
+
</div>
|
231
|
+
|
232
|
+
|
233
|
+
<!-- if includes -->
|
234
|
+
|
235
|
+
<div id="section">
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
<div id="attribute-list">
|
242
|
+
<h3 class="section-bar">Attributes</h3>
|
243
|
+
|
244
|
+
<div class="name-list">
|
245
|
+
<table>
|
246
|
+
<tr class="top-aligned-row context-row">
|
247
|
+
<td class="context-item-name">data</td>
|
248
|
+
<td class="context-item-value"> [R] </td>
|
249
|
+
<td class="context-item-desc"></td>
|
250
|
+
</tr>
|
251
|
+
<tr class="top-aligned-row context-row">
|
252
|
+
<td class="context-item-name">data</td>
|
253
|
+
<td class="context-item-value"> [W] </td>
|
254
|
+
<td class="context-item-desc"></td>
|
255
|
+
</tr>
|
256
|
+
<tr class="top-aligned-row context-row">
|
257
|
+
<td class="context-item-name">descriptor</td>
|
258
|
+
<td class="context-item-value"> [W] </td>
|
259
|
+
<td class="context-item-desc"></td>
|
260
|
+
</tr>
|
261
|
+
<tr class="top-aligned-row context-row">
|
262
|
+
<td class="context-item-name">descriptor</td>
|
263
|
+
<td class="context-item-value"> [R] </td>
|
264
|
+
<td class="context-item-desc"></td>
|
265
|
+
</tr>
|
266
|
+
<tr class="top-aligned-row context-row">
|
267
|
+
<td class="context-item-name">headers</td>
|
268
|
+
<td class="context-item-value"> [R] </td>
|
269
|
+
<td class="context-item-desc"></td>
|
270
|
+
</tr>
|
271
|
+
<tr class="top-aligned-row context-row">
|
272
|
+
<td class="context-item-name">headers</td>
|
273
|
+
<td class="context-item-value"> [W] </td>
|
274
|
+
<td class="context-item-desc"></td>
|
275
|
+
</tr>
|
276
|
+
</table>
|
277
|
+
</div>
|
278
|
+
</div>
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
<!-- if method_list -->
|
283
|
+
<div id="methods">
|
284
|
+
<h3 class="section-bar">Public Class methods</h3>
|
285
|
+
|
286
|
+
<div id="method-M000001" class="method-detail">
|
287
|
+
<a name="M000001"></a>
|
288
|
+
|
289
|
+
<div class="method-heading">
|
290
|
+
<a href="Message.src/M000001.html" target="Code" class="method-signature"
|
291
|
+
onclick="popupCode('Message.src/M000001.html');return false;">
|
292
|
+
<span class="method-name">new(...)<br />
|
293
|
+
</span>
|
294
|
+
</a>
|
295
|
+
</div>
|
296
|
+
|
297
|
+
<div class="method-description">
|
298
|
+
<p>
|
299
|
+
Optional Named Parameters (as a single hash):
|
300
|
+
</p>
|
301
|
+
<ul>
|
302
|
+
<li>:data
|
303
|
+
|
304
|
+
<ul>
|
305
|
+
<li>Data to be written, or was read from the queue
|
306
|
+
|
307
|
+
</li>
|
308
|
+
</ul>
|
309
|
+
</li>
|
310
|
+
<li>:descriptor
|
311
|
+
|
312
|
+
<ul>
|
313
|
+
<li>Desciptor
|
314
|
+
|
315
|
+
</li>
|
316
|
+
</ul>
|
317
|
+
</li>
|
318
|
+
</ul>
|
319
|
+
<p>
|
320
|
+
Example:
|
321
|
+
</p>
|
322
|
+
<pre>
|
323
|
+
message = WMQ::Message.new
|
324
|
+
</pre>
|
325
|
+
<p>
|
326
|
+
Example:
|
327
|
+
</p>
|
328
|
+
<pre>
|
329
|
+
message = WMQ::Message.new(:data=>'Hello World',
|
330
|
+
:descriptor=> {
|
331
|
+
:format => WMQ::MQFMT_STRING
|
332
|
+
})
|
333
|
+
</pre>
|
334
|
+
</div>
|
335
|
+
</div>
|
336
|
+
|
337
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
338
|
+
|
339
|
+
<div id="method-M000002" class="method-detail">
|
340
|
+
<a name="M000002"></a>
|
341
|
+
|
342
|
+
<div class="method-heading">
|
343
|
+
<a href="Message.src/M000002.html" target="Code" class="method-signature"
|
344
|
+
onclick="popupCode('Message.src/M000002.html');return false;">
|
345
|
+
<span class="method-name">clear</span><span class="method-args">()</span>
|
346
|
+
</a>
|
347
|
+
</div>
|
348
|
+
|
349
|
+
<div class="method-description">
|
350
|
+
<p>
|
351
|
+
Clear out the message data and headers
|
352
|
+
</p>
|
353
|
+
<p>
|
354
|
+
Note:
|
355
|
+
</p>
|
356
|
+
<ul>
|
357
|
+
<li>The descriptor is not affected in any way
|
358
|
+
|
359
|
+
</li>
|
360
|
+
</ul>
|
361
|
+
</div>
|
362
|
+
</div>
|
363
|
+
|
364
|
+
|
365
|
+
</div>
|
366
|
+
|
367
|
+
|
368
|
+
</div>
|
369
|
+
|
370
|
+
|
371
|
+
<div id="validator-badges">
|
372
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
373
|
+
</div>
|
374
|
+
|
375
|
+
</body>
|
376
|
+
</html>
|
@@ -0,0 +1,77 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html>
|
7
|
+
<head>
|
8
|
+
<title>new (WMQ::Message)</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
11
|
+
</head>
|
12
|
+
<body class="standalone-code">
|
13
|
+
<pre>/*
|
14
|
+
* call-seq:
|
15
|
+
* new(...)
|
16
|
+
*
|
17
|
+
* Optional Named Parameters (as a single hash):
|
18
|
+
* * :data
|
19
|
+
* * Data to be written, or was read from the queue
|
20
|
+
* * :descriptor
|
21
|
+
* * Desciptor
|
22
|
+
*
|
23
|
+
* Example:
|
24
|
+
* message = WMQ::Message.new
|
25
|
+
*
|
26
|
+
* Example:
|
27
|
+
* message = WMQ::Message.new(:data=>'Hello World',
|
28
|
+
* :descriptor=> {
|
29
|
+
* :format => WMQ::MQFMT_STRING
|
30
|
+
* })
|
31
|
+
*/
|
32
|
+
VALUE Message_initialize(int argc, VALUE *argv, VALUE self)
|
33
|
+
{
|
34
|
+
VALUE parms = Qnil;
|
35
|
+
VALUE proc = Qnil;
|
36
|
+
|
37
|
+
/* Extract optional parameter */
|
38
|
+
rb_scan_args(argc, argv, "01", &parms);
|
39
|
+
|
40
|
+
if (NIL_P(parms))
|
41
|
+
{
|
42
|
+
rb_iv_set(self, "@data", Qnil);
|
43
|
+
rb_iv_set(self, "@headers", rb_ary_new());
|
44
|
+
rb_iv_set(self, "@descriptor", rb_hash_new());
|
45
|
+
}
|
46
|
+
else
|
47
|
+
{
|
48
|
+
VALUE val;
|
49
|
+
Check_Type(parms, T_HASH);
|
50
|
+
|
51
|
+
rb_iv_set(self, "@data", rb_hash_aref(parms, ID2SYM(ID_data)));
|
52
|
+
|
53
|
+
val = rb_hash_aref(parms, ID2SYM(ID_headers));
|
54
|
+
if (NIL_P(val))
|
55
|
+
{
|
56
|
+
rb_iv_set(self, "@headers", rb_ary_new());
|
57
|
+
}
|
58
|
+
else
|
59
|
+
{
|
60
|
+
rb_iv_set(self, "@headers", val);
|
61
|
+
}
|
62
|
+
|
63
|
+
val = rb_hash_aref(parms, ID2SYM(ID_descriptor));
|
64
|
+
if (NIL_P(val))
|
65
|
+
{
|
66
|
+
rb_iv_set(self, "@headers", rb_hash_new());
|
67
|
+
}
|
68
|
+
else
|
69
|
+
{
|
70
|
+
rb_iv_set(self, "@descriptor", val);
|
71
|
+
}
|
72
|
+
}
|
73
|
+
|
74
|
+
return Qnil;
|
75
|
+
}</pre>
|
76
|
+
</body>
|
77
|
+
</html>
|