-
Notifications
You must be signed in to change notification settings - Fork 4
/
amqp0-9-1.extended.xml
3383 lines (2965 loc) · 133 KB
/
amqp0-9-1.extended.xml
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version = "1.0"?>
<!--
WARNING: Modified from the official 0-9-1 specification XML by
the addition of:
confirm.select and confirm.select-ok,
exchange.bind and exchange.bind-ok,
exchange.unbind and exchange.unbind-ok,
basic.nack,
the ability for the Server to send basic.ack, basic.nack and
basic.cancel to the client, and
the un-deprecation of exchange.declare{auto-delete} and exchange.declare{internal}
Modifications are (c) 2010-2013 VMware, Inc. and may be distributed under
the same BSD license as the stripped spec.
-->
<!--
Copyright Notice
================
Copyright (c) 2006-2008 Cisco Systems, Credit Suisse, Deutsche Boerse
Systems, Envoy Technologies, Inc., Goldman Sachs, IONA Technologies PLC,
iMatix Corporation, JPMorgan Chase Bank Inc. N.A, Novell, Rabbit
Technologies Ltd., Red Hat, Inc., TWIST Process Innovations Ltd, WS02
Inc. and 29West Inc. All rights reserved.
License
=======
Cisco Systems, Credit Suisse, Deutsche Boerse Systems, Envoy Technologies,
Inc., Goldman Sachs, IONA Technologies PLC, iMatix Corporation, JPMorgan
Chase Bank Inc. N.A, Novell, Rabbit Technologies Ltd., Red Hat, Inc.,
TWIST Process Innovations Ltd, WS02, Inc. and 29West Inc. (collectively,
the "Authors") each hereby grants to you a worldwide, perpetual,
royalty-free, nontransferable, nonexclusive license to (i) copy, display,
distribute and implement the Advanced Messaging Queue Protocol ("AMQP")
Specification and (ii) the Licensed Claims that are held by the Authors,
all for the purpose of implementing the Advanced Messaging Queue Protocol
Specification. Your license and any rights under this Agreement will
terminate immediately without notice from any Author if you bring any
claim, suit, demand, or action related to the Advanced Messaging Queue
Protocol Specification against any Author. Upon termination, you shall
destroy all copies of the Advanced Messaging Queue Protocol Specification
in your possession or control.
As used hereunder, "Licensed Claims" means those claims of a patent or
patent application, throughout the world, excluding design patents and
design registrations, owned or controlled, or that can be sublicensed
without fee and in compliance with the requirements of this Agreement,
by an Author or its affiliates now or at any future time and which would
necessarily be infringed by implementation of the Advanced Messaging
Queue Protocol Specification. A claim is necessarily infringed hereunder
only when it is not possible to avoid infringing it because there is no
plausible non-infringing alternative for implementing the required
portions of the Advanced Messaging Queue Protocol Specification.
Notwithstanding the foregoing, Licensed Claims shall not include any
claims other than as set forth above even if contained in the same patent
as Licensed Claims; or that read solely on any implementations of any
portion of the Advanced Messaging Queue Protocol Specification that are
not required by the Advanced Messaging Queue ProtocolSpecification, or
that, if licensed, would require a payment of royalties by the licensor
to unaffiliated third parties. Moreover, Licensed Claims shall not
include (i) any enabling technologies that may be necessary to make or
use any Licensed Product but are not themselves expressly set forth in
the Advanced Messaging Queue Protocol Specification (e.g., semiconductor
manufacturing technology, compiler technology, object oriented
technology, networking technology, operating system technology, and the
like); or (ii) the implementation of other published standards developed
elsewhere and merely referred to in the body of the Advanced Messaging
Queue Protocol Specification, or (iii) any Licensed Product and any
combinations thereof the purpose or function of which is not required
for compliance with the Advanced Messaging Queue Protocol Specification.
For purposes of this definition, the Advanced Messaging Queue Protocol
Specification shall be deemed to include both architectural and
interconnection requirements essential for interoperability and may also
include supporting source code artifacts where such architectural,
interconnection requirements and source code artifacts are expressly
identified as being required or documentation to achieve compliance with
the Advanced Messaging Queue Protocol Specification.
As used hereunder, "Licensed Products" means only those specific portions
of products (hardware, software or combinations thereof) that implement
and are compliant with all relevant portions of the Advanced Messaging
Queue Protocol Specification.
The following disclaimers, which you hereby also acknowledge as to any
use you may make of the Advanced Messaging Queue Protocol Specification:
THE ADVANCED MESSAGING QUEUE PROTOCOL SPECIFICATION IS PROVIDED "AS IS,"
AND THE AUTHORS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE
CONTENTS OF THE ADVANCED MESSAGING QUEUE PROTOCOL SPECIFICATION ARE
SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF THE ADVANCED
MESSAGING QUEUE PROTOCOL SPECIFICATION WILL NOT INFRINGE ANY THIRD PARTY
PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
THE AUTHORS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL,
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR RELATING TO ANY
USE, IMPLEMENTATION OR DISTRIBUTION OF THE ADVANCED MESSAGING QUEUE
PROTOCOL SPECIFICATION.
The name and trademarks of the Authors may NOT be used in any manner,
including advertising or publicity pertaining to the Advanced Messaging
Queue Protocol Specification or its contents without specific, written
prior permission. Title to copyright in the Advanced Messaging Queue
Protocol Specification will at all times remain with the Authors.
No other rights are granted by implication, estoppel or otherwise.
Upon termination of your license or rights under this Agreement, you
shall destroy all copies of the Advanced Messaging Queue Protocol
Specification in your possession or control.
Trademarks
==========
JPMorgan, JPMorgan Chase, Chase, the JPMorgan Chase logo and the
Octagon Symbol are trademarks of JPMorgan Chase & Co.
IMATIX and the iMatix logo are trademarks of iMatix Corporation sprl.
IONA, IONA Technologies, and the IONA logos are trademarks of IONA
Technologies PLC and/or its subsidiaries.
LINUX is a trademark of Linus Torvalds. RED HAT and JBOSS are registered
trademarks of Red Hat, Inc. in the US and other countries.
Java, all Java-based trademarks and OpenOffice.org are trademarks of
Sun Microsystems, Inc. in the United States, other countries, or both.
Other company, product, or service names may be trademarks or service
marks of others.
Links to full AMQP specification:
=================================
http://www.amqp.org
-->
<!--
<!DOCTYPE amqp SYSTEM "amqp.dtd">
-->
<!-- XML Notes
We use entities to indicate repetition; attributes to indicate properties.
We use the 'name' attribute as an identifier, usually within the context
of the surrounding entities.
We use spaces to seperate words in names, so that we can print names in
their natural form depending on the context - underlines for source code,
hyphens for written text, etc.
We do not enforce any particular validation mechanism but we support all
mechanisms. The protocol definition conforms to a formal grammar that is
published seperately in several technologies.
-->
<amqp major = "0" minor = "9" revision = "1"
port = "5672" comment = "AMQ Protocol version 0-9-1">
<!--
======================================================
== CONSTANTS
======================================================
-->
<!-- Frame types -->
<constant name = "frame-method" value = "1" />
<constant name = "frame-header" value = "2" />
<constant name = "frame-body" value = "3" />
<constant name = "frame-heartbeat" value = "8" />
<!-- Protocol constants -->
<constant name = "frame-min-size" value = "4096" />
<constant name = "frame-end" value = "206" />
<!-- Reply codes -->
<constant name = "reply-success" value = "200">
<doc>
Indicates that the method completed successfully. This reply code is
reserved for future use - the current protocol design does not use positive
confirmation and reply codes are sent only in case of an error.
</doc>
</constant>
<constant name = "content-too-large" value = "311" class = "soft-error">
<doc>
The client attempted to transfer content larger than the server could accept
at the present time. The client may retry at a later time.
</doc>
</constant>
<constant name = "no-route" value = "312" class = "soft-error">
<doc>
Returned when RabbitMQ sends back with 'basic.return' when a
'mandatory' message cannot be delivered to any queue.
</doc>
</constant>
<constant name = "no-consumers" value = "313" class = "soft-error">
<doc>
When the exchange cannot deliver to a consumer when the immediate flag is
set. As a result of pending data on the queue or the absence of any
consumers of the queue.
</doc>
</constant>
<constant name = "connection-forced" value = "320" class = "hard-error">
<doc>
An operator intervened to close the connection for some reason. The client
may retry at some later date.
</doc>
</constant>
<constant name = "invalid-path" value = "402" class = "hard-error">
<doc>
The client tried to work with an unknown virtual host.
</doc>
</constant>
<constant name = "access-refused" value = "403" class = "soft-error">
<doc>
The client attempted to work with a server entity to which it has no
access due to security settings.
</doc>
</constant>
<constant name = "not-found" value = "404" class = "soft-error">
<doc>
The client attempted to work with a server entity that does not exist.
</doc>
</constant>
<constant name = "resource-locked" value = "405" class = "soft-error">
<doc>
The client attempted to work with a server entity to which it has no
access because another client is working with it.
</doc>
</constant>
<constant name = "precondition-failed" value = "406" class = "soft-error">
<doc>
The client requested a method that was not allowed because some precondition
failed.
</doc>
</constant>
<constant name = "frame-error" value = "501" class = "hard-error">
<doc>
The sender sent a malformed frame that the recipient could not decode.
This strongly implies a programming error in the sending peer.
</doc>
</constant>
<constant name = "syntax-error" value = "502" class = "hard-error">
<doc>
The sender sent a frame that contained illegal values for one or more
fields. This strongly implies a programming error in the sending peer.
</doc>
</constant>
<constant name = "command-invalid" value = "503" class = "hard-error">
<doc>
The client sent an invalid sequence of frames, attempting to perform an
operation that was considered invalid by the server. This usually implies
a programming error in the client.
</doc>
</constant>
<constant name = "channel-error" value = "504" class = "hard-error">
<doc>
The client attempted to work with a channel that had not been correctly
opened. This most likely indicates a fault in the client layer.
</doc>
</constant>
<constant name = "unexpected-frame" value = "505" class = "hard-error">
<doc>
The peer sent a frame that was not expected, usually in the context of
a content header and body. This strongly indicates a fault in the peer's
content processing.
</doc>
</constant>
<constant name = "resource-error" value = "506" class = "hard-error">
<doc>
The server could not complete the method because it lacked sufficient
resources. This may be due to the client creating too many of some type
of entity.
</doc>
</constant>
<constant name = "not-allowed" value = "530" class = "hard-error">
<doc>
The client tried to work with some entity in a manner that is prohibited
by the server, due to security settings or by some other criteria.
</doc>
</constant>
<constant name = "not-implemented" value = "540" class = "hard-error">
<doc>
The client tried to use functionality that is not implemented in the
server.
</doc>
</constant>
<constant name = "internal-error" value = "541" class = "hard-error">
<doc>
The server could not complete the method because of an internal error.
The server may require intervention by an operator in order to resume
normal operations.
</doc>
</constant>
<!--
======================================================
== DOMAIN TYPES
======================================================
-->
<domain name = "class-id" type = "short" />
<domain name = "consumer-tag" type = "shortstr" label = "consumer tag">
<doc>
Identifier for the consumer, valid within the current channel.
</doc>
</domain>
<domain name = "delivery-tag" type = "longlong" label = "server-assigned delivery tag">
<doc>
The server-assigned and channel-specific delivery tag
</doc>
<rule name = "channel-local">
<doc>
The delivery tag is valid only within the channel from which the message was
received. I.e. a client MUST NOT receive a message on one channel and then
acknowledge it on another.
</doc>
</rule>
<rule name = "non-zero">
<doc>
The server MUST NOT use a zero value for delivery tags. Zero is reserved
for client use, meaning "all messages so far received".
</doc>
</rule>
</domain>
<domain name = "exchange-name" type = "shortstr" label = "exchange name">
<doc>
The exchange name is a client-selected string that identifies the exchange for
publish methods.
</doc>
<assert check = "length" value = "127" />
<assert check = "regexp" value = "^[a-zA-Z0-9-_.:]*$" />
</domain>
<domain name = "method-id" type = "short" />
<domain name = "no-ack" type = "bit" label = "no acknowledgement needed">
<doc>
If this field is set the server does not expect acknowledgements for
messages. That is, when a message is delivered to the client the server
assumes the delivery will succeed and immediately dequeues it. This
functionality may increase performance but at the cost of reliability.
Messages can get lost if a client dies before they are delivered to the
application.
</doc>
</domain>
<domain name = "no-local" type = "bit" label = "do not deliver own messages">
<doc>
If the no-local field is set the server will not send messages to the connection that
published them.
</doc>
</domain>
<domain name = "no-wait" type = "bit" label = "do not send reply method">
<doc>
If set, the server will not respond to the method. The client should not wait
for a reply method. If the server could not complete the method it will raise a
channel or connection exception.
</doc>
</domain>
<domain name = "path" type = "shortstr">
<doc>
Unconstrained.
</doc>
<assert check = "notnull" />
<assert check = "length" value = "127" />
</domain>
<domain name = "peer-properties" type = "table">
<doc>
This table provides a set of peer properties, used for identification, debugging,
and general information.
</doc>
</domain>
<domain name = "queue-name" type = "shortstr" label = "queue name">
<doc>
The queue name identifies the queue within the vhost. In methods where the queue
name may be blank, and that has no specific significance, this refers to the
'current' queue for the channel, meaning the last queue that the client declared
on the channel. If the client did not declare a queue, and the method needs a
queue name, this will result in a 502 (syntax error) channel exception.
</doc>
<assert check = "length" value = "127" />
<assert check = "regexp" value = "^[a-zA-Z0-9-_.:]*$" />
</domain>
<domain name = "redelivered" type = "bit" label = "message is being redelivered">
<doc>
This indicates that the message has been previously delivered to this or
another client.
</doc>
<rule name = "implementation">
<doc>
The server SHOULD try to signal redelivered messages when it can. When
redelivering a message that was not successfully acknowledged, the server
SHOULD deliver it to the original client if possible.
</doc>
<doc type = "scenario">
Declare a shared queue and publish a message to the queue. Consume the
message using explicit acknowledgements, but do not acknowledge the
message. Close the connection, reconnect, and consume from the queue
again. The message should arrive with the redelivered flag set.
</doc>
</rule>
<rule name = "hinting">
<doc>
The client MUST NOT rely on the redelivered field but should take it as a
hint that the message may already have been processed. A fully robust
client must be able to track duplicate received messages on non-transacted,
and locally-transacted channels.
</doc>
</rule>
</domain>
<domain name = "message-count" type = "long" label = "number of messages in queue">
<doc>
The number of messages in the queue, which will be zero for newly-declared
queues. This is the number of messages present in the queue, and committed
if the channel on which they were published is transacted, that are not
waiting acknowledgement.
</doc>
</domain>
<domain name = "reply-code" type = "short" label = "reply code from server">
<doc>
The reply code. The AMQ reply codes are defined as constants at the start
of this formal specification.
</doc>
<assert check = "notnull" />
</domain>
<domain name = "reply-text" type = "shortstr" label = "localised reply text">
<doc>
The localised reply text. This text can be logged as an aid to resolving
issues.
</doc>
<assert check = "notnull" />
</domain>
<!-- Elementary domains -->
<domain name = "bit" type = "bit" label = "single bit" />
<domain name = "octet" type = "octet" label = "single octet" />
<domain name = "short" type = "short" label = "16-bit integer" />
<domain name = "long" type = "long" label = "32-bit integer" />
<domain name = "longlong" type = "longlong" label = "64-bit integer" />
<domain name = "shortstr" type = "shortstr" label = "short string (max. 256 characters)" />
<domain name = "longstr" type = "longstr" label = "long string" />
<domain name = "timestamp" type = "timestamp" label = "64-bit timestamp" />
<domain name = "table" type = "table" label = "field table" />
<!-- == CONNECTION ======================================================= -->
<class name = "connection" handler = "connection" index = "10" label = "work with socket connections">
<doc>
The connection class provides methods for a client to establish a network connection to
a server, and for both peers to operate the connection thereafter.
</doc>
<doc type = "grammar">
connection = open-connection *use-connection close-connection
open-connection = C:protocol-header
S:START C:START-OK
*challenge
S:TUNE C:TUNE-OK
C:OPEN S:OPEN-OK
challenge = S:SECURE C:SECURE-OK
use-connection = *channel
close-connection = C:CLOSE S:CLOSE-OK
/ S:CLOSE C:CLOSE-OK
</doc>
<chassis name = "server" implement = "MUST" />
<chassis name = "client" implement = "MUST" />
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "start" synchronous = "1" index = "10" label = "start connection negotiation">
<doc>
This method starts the connection negotiation process by telling the client the
protocol version that the server proposes, along with a list of security mechanisms
which the client can use for authentication.
</doc>
<rule name = "protocol-name">
<doc>
If the server cannot support the protocol specified in the protocol header,
it MUST respond with a valid protocol header and then close the socket
connection.
</doc>
<doc type = "scenario">
The client sends a protocol header containing an invalid protocol name.
The server MUST respond by sending a valid protocol header and then closing
the connection.
</doc>
</rule>
<rule name = "server-support">
<doc>
The server MUST provide a protocol version that is lower than or equal to
that requested by the client in the protocol header.
</doc>
<doc type = "scenario">
The client requests a protocol version that is higher than any valid
implementation, e.g. 2.0. The server must respond with a protocol header
indicating its supported protocol version, e.g. 1.0.
</doc>
</rule>
<rule name = "client-support">
<doc>
If the client cannot handle the protocol version suggested by the server
it MUST close the socket connection without sending any further data.
</doc>
<doc type = "scenario">
The server sends a protocol version that is lower than any valid
implementation, e.g. 0.1. The client must respond by closing the
connection without sending any further data.
</doc>
</rule>
<chassis name = "client" implement = "MUST" />
<response name = "start-ok" />
<field name = "version-major" domain = "octet" label = "protocol major version">
<doc>
The major version number can take any value from 0 to 99 as defined in the
AMQP specification.
</doc>
</field>
<field name = "version-minor" domain = "octet" label = "protocol minor version">
<doc>
The minor version number can take any value from 0 to 99 as defined in the
AMQP specification.
</doc>
</field>
<field name = "server-properties" domain = "peer-properties" label = "server properties">
<rule name = "required-fields">
<doc>
The properties SHOULD contain at least these fields: "host", specifying the
server host name or address, "product", giving the name of the server product,
"version", giving the name of the server version, "platform", giving the name
of the operating system, "copyright", if appropriate, and "information", giving
other general information.
</doc>
<doc type = "scenario">
Client connects to server and inspects the server properties. It checks for
the presence of the required fields.
</doc>
</rule>
</field>
<field name = "mechanisms" domain = "longstr" label = "available security mechanisms">
<doc>
A list of the security mechanisms that the server supports, delimited by spaces.
</doc>
<assert check = "notnull" />
</field>
<field name = "locales" domain = "longstr" label = "available message locales">
<doc>
A list of the message locales that the server supports, delimited by spaces. The
locale defines the language in which the server will send reply texts.
</doc>
<rule name = "required-support">
<doc>
The server MUST support at least the en_US locale.
</doc>
<doc type = "scenario">
Client connects to server and inspects the locales field. It checks for
the presence of the required locale(s).
</doc>
</rule>
<assert check = "notnull" />
</field>
</method>
<method name = "start-ok" synchronous = "1" index = "11"
label = "select security mechanism and locale">
<doc>
This method selects a SASL security mechanism.
</doc>
<chassis name = "server" implement = "MUST" />
<field name = "client-properties" domain = "peer-properties" label = "client properties">
<rule name = "required-fields">
<!-- This rule is not testable from the client side -->
<doc>
The properties SHOULD contain at least these fields: "product", giving the name
of the client product, "version", giving the name of the client version, "platform",
giving the name of the operating system, "copyright", if appropriate, and
"information", giving other general information.
</doc>
</rule>
</field>
<field name = "mechanism" domain = "shortstr" label = "selected security mechanism">
<doc>
A single security mechanisms selected by the client, which must be one of those
specified by the server.
</doc>
<rule name = "security">
<doc>
The client SHOULD authenticate using the highest-level security profile it
can handle from the list provided by the server.
</doc>
</rule>
<rule name = "validity">
<doc>
If the mechanism field does not contain one of the security mechanisms
proposed by the server in the Start method, the server MUST close the
connection without sending any further data.
</doc>
<doc type = "scenario">
Client connects to server and sends an invalid security mechanism. The
server must respond by closing the connection (a socket close, with no
connection close negotiation).
</doc>
</rule>
<assert check = "notnull" />
</field>
<field name = "response" domain = "longstr" label = "security response data">
<doc>
A block of opaque data passed to the security mechanism. The contents of this
data are defined by the SASL security mechanism.
</doc>
<assert check = "notnull" />
</field>
<field name = "locale" domain = "shortstr" label = "selected message locale">
<doc>
A single message locale selected by the client, which must be one of those
specified by the server.
</doc>
<assert check = "notnull" />
</field>
</method>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "secure" synchronous = "1" index = "20" label = "security mechanism challenge">
<doc>
The SASL protocol works by exchanging challenges and responses until both peers have
received sufficient information to authenticate each other. This method challenges
the client to provide more information.
</doc>
<chassis name = "client" implement = "MUST" />
<response name = "secure-ok" />
<field name = "challenge" domain = "longstr" label = "security challenge data">
<doc>
Challenge information, a block of opaque binary data passed to the security
mechanism.
</doc>
</field>
</method>
<method name = "secure-ok" synchronous = "1" index = "21" label = "security mechanism response">
<doc>
This method attempts to authenticate, passing a block of SASL data for the security
mechanism at the server side.
</doc>
<chassis name = "server" implement = "MUST" />
<field name = "response" domain = "longstr" label = "security response data">
<doc>
A block of opaque data passed to the security mechanism. The contents of this
data are defined by the SASL security mechanism.
</doc>
<assert check = "notnull" />
</field>
</method>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "tune" synchronous = "1" index = "30"
label = "propose connection tuning parameters">
<doc>
This method proposes a set of connection configuration values to the client. The
client can accept and/or adjust these.
</doc>
<chassis name = "client" implement = "MUST" />
<response name = "tune-ok" />
<field name = "channel-max" domain = "short" label = "proposed maximum channels">
<doc>
Specifies highest channel number that the server permits. Usable channel numbers
are in the range 1..channel-max. Zero indicates no specified limit.
</doc>
</field>
<field name = "frame-max" domain = "long" label = "proposed maximum frame size">
<doc>
The largest frame size that the server proposes for the connection, including
frame header and end-byte. The client can negotiate a lower value. Zero means
that the server does not impose any specific limit but may reject very large
frames if it cannot allocate resources for them.
</doc>
<rule name = "minimum">
<doc>
Until the frame-max has been negotiated, both peers MUST accept frames of up
to frame-min-size octets large, and the minimum negotiated value for frame-max
is also frame-min-size.
</doc>
<doc type = "scenario">
Client connects to server and sends a large properties field, creating a frame
of frame-min-size octets. The server must accept this frame.
</doc>
</rule>
</field>
<field name = "heartbeat" domain = "short" label = "desired heartbeat delay">
<doc>
The delay, in seconds, of the connection heartbeat that the server wants.
Zero means the server does not want a heartbeat.
</doc>
</field>
</method>
<method name = "tune-ok" synchronous = "1" index = "31"
label = "negotiate connection tuning parameters">
<doc>
This method sends the client's connection tuning parameters to the server.
Certain fields are negotiated, others provide capability information.
</doc>
<chassis name = "server" implement = "MUST" />
<field name = "channel-max" domain = "short" label = "negotiated maximum channels">
<doc>
The maximum total number of channels that the client will use per connection.
</doc>
<rule name = "upper-limit">
<doc>
If the client specifies a channel max that is higher than the value provided
by the server, the server MUST close the connection without attempting a
negotiated close. The server may report the error in some fashion to assist
implementors.
</doc>
</rule>
<assert check = "notnull" />
<assert check = "le" method = "tune" field = "channel-max" />
</field>
<field name = "frame-max" domain = "long" label = "negotiated maximum frame size">
<doc>
The largest frame size that the client and server will use for the connection.
Zero means that the client does not impose any specific limit but may reject
very large frames if it cannot allocate resources for them. Note that the
frame-max limit applies principally to content frames, where large contents can
be broken into frames of arbitrary size.
</doc>
<rule name = "minimum">
<doc>
Until the frame-max has been negotiated, both peers MUST accept frames of up
to frame-min-size octets large, and the minimum negotiated value for frame-max
is also frame-min-size.
</doc>
</rule>
<rule name = "upper-limit">
<doc>
If the client specifies a frame max that is higher than the value provided
by the server, the server MUST close the connection without attempting a
negotiated close. The server may report the error in some fashion to assist
implementors.
</doc>
</rule>
</field>
<field name = "heartbeat" domain = "short" label = "desired heartbeat delay">
<doc>
The delay, in seconds, of the connection heartbeat that the client wants. Zero
means the client does not want a heartbeat.
</doc>
</field>
</method>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "open" synchronous = "1" index = "40" label = "open connection to virtual host">
<doc>
This method opens a connection to a virtual host, which is a collection of
resources, and acts to separate multiple application domains within a server.
The server may apply arbitrary limits per virtual host, such as the number
of each type of entity that may be used, per connection and/or in total.
</doc>
<chassis name = "server" implement = "MUST" />
<response name = "open-ok" />
<field name = "virtual-host" domain = "path" label = "virtual host name">
<doc>
The name of the virtual host to work with.
</doc>
<rule name = "separation">
<doc>
If the server supports multiple virtual hosts, it MUST enforce a full
separation of exchanges, queues, and all associated entities per virtual
host. An application, connected to a specific virtual host, MUST NOT be able
to access resources of another virtual host.
</doc>
</rule>
<rule name = "security">
<doc>
The server SHOULD verify that the client has permission to access the
specified virtual host.
</doc>
</rule>
</field>
<!-- Deprecated: "capabilities", must be zero -->
<field name = "reserved-1" type = "shortstr" reserved = "1" />
<!-- Deprecated: "insist", must be zero -->
<field name = "reserved-2" type = "bit" reserved = "1" />
</method>
<method name = "open-ok" synchronous = "1" index = "41" label = "signal that connection is ready">
<doc>
This method signals to the client that the connection is ready for use.
</doc>
<chassis name = "client" implement = "MUST" />
<!-- Deprecated: "known-hosts", must be zero -->
<field name = "reserved-1" type = "shortstr" reserved = "1" />
</method>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "close" synchronous = "1" index = "50" label = "request a connection close">
<doc>
This method indicates that the sender wants to close the connection. This may be
due to internal conditions (e.g. a forced shut-down) or due to an error handling
a specific method, i.e. an exception. When a close is due to an exception, the
sender provides the class and method id of the method which caused the exception.
</doc>
<rule name = "stability">
<doc>
After sending this method, any received methods except Close and Close-OK MUST
be discarded. The response to receiving a Close after sending Close must be to
send Close-Ok.
</doc>
</rule>
<chassis name = "client" implement = "MUST" />
<chassis name = "server" implement = "MUST" />
<response name = "close-ok" />
<field name = "reply-code" domain = "reply-code" />
<field name = "reply-text" domain = "reply-text" />
<field name = "class-id" domain = "class-id" label = "failing method class">
<doc>
When the close is provoked by a method exception, this is the class of the
method.
</doc>
</field>
<field name = "method-id" domain = "method-id" label = "failing method ID">
<doc>
When the close is provoked by a method exception, this is the ID of the method.
</doc>
</field>
</method>
<method name = "close-ok" synchronous = "1" index = "51" label = "confirm a connection close">
<doc>
This method confirms a Connection.Close method and tells the recipient that it is
safe to release resources for the connection and close the socket.
</doc>
<rule name = "reporting">
<doc>
A peer that detects a socket closure without having received a Close-Ok
handshake method SHOULD log the error.
</doc>
</rule>
<chassis name = "client" implement = "MUST" />
<chassis name = "server" implement = "MUST" />
</method>
<method name = "blocked" index = "60" label = "indicate that connection is blocked">
<doc>
This method indicates that a connection has been blocked
and does not accept new publishes.
</doc>
<chassis name = "server" implement = "MUST"/>
<chassis name = "client" implement = "MUST"/>
<field name="reason" domain="shortstr" label="Block reason" requred="0">
<doc>
The reason the connection was blocked.
</doc>
</field>
</method>
<method name = "unblocked" index = "61" label = "indicate that connection is unblocked">
<doc>
This method indicates that a connection has been unblocked
and now accepts publishes.
</doc>
<chassis name = "server" implement = "MUST"/>
<chassis name = "client" implement = "MUST"/>
</method>
<method name = "update-secret" synchronous = "1" index = "70" label = "update secret">
<doc>
This method updates the secret used to authenticate this connection. It is used
when secrets have an expiration date and need to be renewed, like OAuth 2 tokens.
</doc>
<chassis name = "client" implement = "MUST" />
<response name = "update-secret-ok" />
<field name = "new-secret" domain = "longstr" label = "new secret">
<doc>
The new secret.
</doc>
</field>
<field name = "reason" domain = "shortstr" label = "reason">
<doc>
The reason for the secret update.
</doc>
</field>
</method>
<method name = "update-secret-ok" synchronous = "1" index = "71" label = "update secret response">
<doc>
This method confirms the updated secret is valid.
</doc>
<chassis name = "server" implement = "MUST" />
</method>
</class>
<!-- == CHANNEL ========================================================== -->
<class name = "channel" handler = "channel" index = "20" label = "work with channels">
<doc>
The channel class provides methods for a client to establish a channel to a
server and for both peers to operate the channel thereafter.
</doc>
<doc type = "grammar">
channel = open-channel *use-channel close-channel
open-channel = C:OPEN S:OPEN-OK
use-channel = C:FLOW S:FLOW-OK
/ S:FLOW C:FLOW-OK
/ functional-class
close-channel = C:CLOSE S:CLOSE-OK
/ S:CLOSE C:CLOSE-OK
</doc>
<chassis name = "server" implement = "MUST" />
<chassis name = "client" implement = "MUST" />
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<method name = "open" synchronous = "1" index = "10" label = "open a channel for use">
<doc>
This method opens a channel to the server.
</doc>
<rule name = "state" on-failure = "channel-error">
<doc>
The client MUST NOT use this method on an already-opened channel.
</doc>
<doc type = "scenario">
Client opens a channel and then reopens the same channel.
</doc>
</rule>
<chassis name = "server" implement = "MUST" />
<response name = "open-ok" />
<!-- Deprecated: "out-of-band", must be zero -->
<field name = "reserved-1" type = "shortstr" reserved = "1" />