12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636(** Internal - Low level protocol description *)(***********************************)(* AUTOGENERATED FILE: DO NOT EDIT *)(* ./gen_spec.exe -type specification amqp0-9-1.extended.xml *)(***********************************)(* spec/gen_spec.ml:439 *)openAmqp_client_libopenTypesopenProtocolopenProtocol_helpers(* Domains *)(**
The localised reply text. This text can be logged as an aid to resolving
issues.
*)(* spec/gen_spec.ml:177 *)typereply_text=shortstr(**
Unconstrained.
*)(* spec/gen_spec.ml:177 *)typepath=shortstr(**
The reply code. The AMQ reply codes are defined as constants at the start
of this formal specification.
*)(* spec/gen_spec.ml:177 *)typereply_code=short(* spec/gen_spec.ml:177 *)typeclass_id=short(**
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.
*)(* spec/gen_spec.ml:177 *)typemessage_count=long(**
This table provides a set of peer properties, used for identification, debugging,
and general information.
*)(* spec/gen_spec.ml:177 *)typepeer_properties=table(* spec/gen_spec.ml:177 *)typemethod_id=short(**
The exchange name is a client-selected string that identifies the exchange for
publish methods.
*)(* spec/gen_spec.ml:177 *)typeexchange_name=shortstr(**
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.
*)(* spec/gen_spec.ml:177 *)typeno_wait=bit(**
The server-assigned and channel-specific delivery tag
*)(* spec/gen_spec.ml:177 *)typedelivery_tag=longlong(**
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.
*)(* spec/gen_spec.ml:177 *)typeno_ack=bit(**
Identifier for the consumer, valid within the current channel.
*)(* spec/gen_spec.ml:177 *)typeconsumer_tag=shortstr(**
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.
*)(* spec/gen_spec.ml:177 *)typequeue_name=shortstr(**
This indicates that the message has been previously delivered to this or
another client.
*)(* spec/gen_spec.ml:177 *)typeredelivered=bit(**
If the no-local field is set the server will not send messages to the connection that
published them.
*)(* spec/gen_spec.ml:177 *)typeno_local=bit(**/**)(* spec/gen_spec.ml:182 *)moduleInternal_alias=structletreply_text=Shortstrletpath=Shortstrletreply_code=Shortletclass_id=Shortletmessage_count=Longletpeer_properties=Tableletmethod_id=Shortletexchange_name=Shortstrletno_wait=Bitletdelivery_tag=Longlongletno_ack=Bitletconsumer_tag=Shortstrletqueue_name=Shortstrletredelivered=Bitletno_local=Bitend(**/**)(**
The Confirm class allows publishers to put the channel in
confirm mode and subsequently be notified when messages have been
handled by the broker. The intention is that all messages
published on a channel in confirm mode will be acknowledged at
some point. By acknowledging a message the broker assumes
responsibility for it and indicates that it has done something
it deems reasonable with it.
Unroutable mandatory or immediate messages are acknowledged
right after the Basic.Return method. Messages are acknowledged
when all queues to which the message has been routed
have either delivered the message and received an
acknowledgement (if required), or enqueued the message (and
persisted it if required).
Published messages are assigned ascending sequence numbers,
starting at 1 with the first Confirm.Select method. The server
confirms messages by sending Basic.Ack methods referring to these
sequence numbers.
*)(* spec/gen_spec.ml:396 *)moduleConfirm=struct(**
This method confirms to the client that the channel was successfully
set to use publisher acknowledgements.
*)(* spec/gen_spec.ml:276 *)moduleSelect_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((85,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method sets the channel to use publisher acknowledgements.
The client can only use this method on a non-transactional
channel.
*)(* spec/gen_spec.ml:276 *)moduleSelect=struct(* spec/gen_spec.ml:310 *)typet={nowait:bit;(**
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.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Bit::[]letmakenowait={nowait}letapplyf{nowait}=fnowaitletdef=((85,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~nowait()=Internal.makenowait(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeSelect_ok.Internal.readendend(**
The Tx class allows publish and ack operations to be batched into atomic
units of work. The intention is that all publish and ack requests issued
within a transaction will complete successfully or none of them will.
Servers SHOULD implement atomic transactions at least where all publish
or ack requests affect a single queue. Transactions that cover multiple
queues may be non-atomic, given that queues can be created and destroyed
asynchronously, and such events do not form part of any transaction.
Further, the behaviour of transactions with respect to the immediate and
mandatory flags on Basic.Publish methods is not defined.
*)(* spec/gen_spec.ml:396 *)moduleTx=struct(**
This method confirms to the client that the channel was successfully set to use
standard transactions.
*)(* spec/gen_spec.ml:276 *)moduleSelect_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method sets the channel to use standard transactions. The client must use this
method at least once on a channel before using the Commit or Rollback methods.
*)(* spec/gen_spec.ml:276 *)moduleSelect=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.make(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeSelect_ok.Internal.readend(**
This method confirms to the client that the commit succeeded. Note that if a commit
fails, the server raises a channel exception.
*)(* spec/gen_spec.ml:276 *)moduleCommit_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method commits all message publications and acknowledgments performed in
the current transaction. A new transaction starts immediately after a commit.
*)(* spec/gen_spec.ml:276 *)moduleCommit=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.make(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeCommit_ok.Internal.readend(**
This method confirms to the client that the rollback succeeded. Note that if an
rollback fails, the server raises a channel exception.
*)(* spec/gen_spec.ml:276 *)moduleRollback_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,31),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method abandons all message publications and acknowledgments performed in
the current transaction. A new transaction starts immediately after a rollback.
Note that unacked messages will not be automatically redelivered by rollback;
if that is required an explicit recover call should be issued.
*)(* spec/gen_spec.ml:276 *)moduleRollback=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((90,30),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.make(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeRollback_ok.Internal.readendend(**
The Basic class provides methods that support an industry-standard messaging model.
*)(* spec/gen_spec.ml:396 *)moduleBasic=struct(* spec/gen_spec.ml:276 *)moduleContent=struct(* spec/gen_spec.ml:310 *)typet={content_type:shortstroption;content_encoding:shortstroption;headers:tableoption;delivery_mode:octetoption;priority:octetoption;correlation_id:shortstroption;reply_to:shortstroption;expiration:shortstroption;message_id:shortstroption;timestamp:timestampoption;amqp_type:shortstroption;user_id:shortstroption;app_id:shortstroption;reserved:shortstroption;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Content(* spec/gen_spec.ml:327 *)letspec=Shortstr::Shortstr::Table::Octet::Octet::Shortstr::Shortstr::Shortstr::Shortstr::Timestamp::Shortstr::Shortstr::Shortstr::Shortstr::[]letmakecontent_typecontent_encodingheadersdelivery_modeprioritycorrelation_idreply_toexpirationmessage_idtimestampamqp_typeuser_idapp_idreserved={content_type;content_encoding;headers;delivery_mode;priority;correlation_id;reply_to;expiration;message_id;timestamp;amqp_type;user_id;app_id;reserved}letapplyf{content_type;content_encoding;headers;delivery_mode;priority;correlation_id;reply_to;expiration;message_id;timestamp;amqp_type;user_id;app_id;reserved}=fcontent_typecontent_encodingheadersdelivery_modeprioritycorrelation_idreply_toexpirationmessage_idtimestampamqp_typeuser_idapp_idreservedletdef=((60,0),spec,make,apply)end(**/**)(* spec/gen_spec.ml:352 *)letinit?content_type?content_encoding?headers?delivery_mode?priority?correlation_id?reply_to?expiration?message_id?timestamp?amqp_type?user_id?app_id?reserved()=Internal.makecontent_typecontent_encodingheadersdelivery_modeprioritycorrelation_idreply_toexpirationmessage_idtimestampamqp_typeuser_idapp_idreservedend(**
This method tells the client that the requested QoS levels could be handled by the
server. The requested QoS applies to all active consumers until a new QoS is
defined.
*)(* spec/gen_spec.ml:276 *)moduleQos_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((60,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method requests a specific quality of service. The QoS can be specified for the
current channel or for all channels on the connection. The particular properties and
semantics of a qos method always depend on the content class semantics. Though the
qos method could in principle apply to both peers, it is currently meaningful only
for the server.
*)(* spec/gen_spec.ml:276 *)moduleQos=struct(* spec/gen_spec.ml:310 *)typet={prefetch_size:long;(**
The client can request that messages be sent in advance so that when the client
finishes processing a message, the following message is already held locally,
rather than needing to be sent down the channel. Prefetching gives a performance
improvement. This field specifies the prefetch window size in octets. The server
will send a message in advance if it is equal to or smaller in size than the
available prefetch size (and also falls into other prefetch limits). May be set
to zero, meaning "no specific limit", although other prefetch limits may still
apply. The prefetch-size is ignored if the no-ack option is set.
*)prefetch_count:short;(**
Specifies a prefetch window in terms of whole messages. This field may be used
in combination with the prefetch-size field; a message will only be sent in
advance if both prefetch windows (and those at the channel and connection level)
allow it. The prefetch-count is ignored if the no-ack option is set.
*)global:bit;(**
RabbitMQ has reinterpreted this field. The original
specification said: "By default the QoS settings apply to
the current channel only. If this field is set, they are
applied to the entire connection." Instead, RabbitMQ takes
global=false to mean that the QoS settings should apply
per-consumer (for new consumers on the channel; existing
ones being unaffected) and global=true to mean that the QoS
settings should apply per-channel.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Long::Short::Bit::[]letmakeprefetch_sizeprefetch_countglobal={prefetch_size;prefetch_count;global}letapplyf{prefetch_size;prefetch_count;global}=fprefetch_sizeprefetch_countgloballetdef=((60,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~prefetch_size~prefetch_count~global()=Internal.makeprefetch_sizeprefetch_countglobal(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeQos_ok.Internal.readend(**
The server provides the client with a consumer tag, which is used by the client
for methods called on the consumer at a later stage.
*)(* spec/gen_spec.ml:276 *)moduleConsume_ok=struct(* spec/gen_spec.ml:310 *)typet={consumer_tag:consumer_tag;(**
Holds the consumer tag specified by the client or provided by the server.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=consumer_tag::[]letmakeconsumer_tag={consumer_tag}letapplyf{consumer_tag}=fconsumer_tagletdef=((60,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~consumer_tag()=Internal.makeconsumer_tagend(**
This method asks the server to start a "consumer", which is a transient request for
messages from a specific queue. Consumers last as long as the channel they were
declared on, or until the client cancels them.
*)(* spec/gen_spec.ml:276 *)moduleConsume=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to consume from. *)consumer_tag:consumer_tag;(**
Specifies the identifier for the consumer. The consumer tag is local to a
channel, so two clients can use the same consumer tags. If this field is
empty the server will generate a unique tag.
*)no_local:no_local;no_ack:no_ack;exclusive:bit;(**
Request exclusive consumer access, meaning only this consumer can access the
queue.
*)no_wait:no_wait;arguments:table;(**
A set of arguments for the consume. The syntax and semantics of these
arguments depends on the server implementation.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::consumer_tag::no_local::no_ack::Bit::no_wait::Table::[]letmake_queueconsumer_tagno_localno_ackexclusiveno_waitarguments={queue;consumer_tag;no_local;no_ack;exclusive;no_wait;arguments}letapplyf{queue;consumer_tag;no_local;no_ack;exclusive;no_wait;arguments}=f(reserved_valueShort)queueconsumer_tagno_localno_ackexclusiveno_waitargumentsletdef=((60,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~consumer_tag~no_local~no_ack~exclusive~no_wait~arguments()=Internal.makequeueconsumer_tagno_localno_ackexclusiveno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeConsume_ok.Internal.readend(**
This method confirms that the cancellation was completed.
*)(* spec/gen_spec.ml:276 *)moduleCancel_ok=struct(* spec/gen_spec.ml:310 *)typet={consumer_tag:consumer_tag;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=consumer_tag::[]letmakeconsumer_tag={consumer_tag}letapplyf{consumer_tag}=fconsumer_tagletdef=((60,31),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~consumer_tag()=Internal.makeconsumer_tagend(**
This method cancels a consumer. This does not affect already delivered
messages, but it does mean the server will not send any more messages for
that consumer. The client may receive an arbitrary number of messages in
between sending the cancel method and receiving the cancel-ok reply.
It may also be sent from the server to the client in the event
of the consumer being unexpectedly cancelled (i.e. cancelled
for any reason other than the server receiving the
corresponding basic.cancel from the client). This allows
clients to be notified of the loss of consumers due to events
such as queue deletion. Note that as it is not a MUST for
clients to accept this method from the server, it is advisable
for the broker to be able to identify those clients that are
capable of accepting the method, through some means of
capability negotiation.
*)(* spec/gen_spec.ml:276 *)moduleCancel=struct(* spec/gen_spec.ml:310 *)typet={consumer_tag:consumer_tag;no_wait:no_wait;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=consumer_tag::no_wait::[]letmakeconsumer_tagno_wait={consumer_tag;no_wait}letapplyf{consumer_tag;no_wait}=fconsumer_tagno_waitletdef=((60,30),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~consumer_tag~no_wait()=Internal.makeconsumer_tagno_wait(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readCancel_ok.Internal.write(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeCancel_ok.Internal.readend(**
This method publishes a message to a specific exchange. The message will be routed
to queues as defined by the exchange configuration and distributed to any active
consumers when the transaction, if any, is committed.
*)(* spec/gen_spec.ml:276 *)modulePublish=struct(* spec/gen_spec.ml:310 *)typet={exchange:exchange_name;(**
Specifies the name of the exchange to publish to. The exchange name can be
empty, meaning the default exchange. If the exchange name is specified, and that
exchange does not exist, the server will raise a channel exception.
*)routing_key:shortstr;(**
Specifies the routing key for the message. The routing key is used for routing
messages depending on the exchange configuration.
*)mandatory:bit;(**
This flag tells the server how to react if the message cannot be routed to a
queue. If this flag is set, the server will return an unroutable message with a
Return method. If this flag is zero, the server silently drops the message.
*)immediate:bit;(**
This flag tells the server how to react if the message cannot be routed to a
queue consumer immediately. If this flag is set, the server will return an
undeliverable message with a Return method. If this flag is zero, the server
will queue the message, but with no guarantee that it will ever be consumed.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::exchange_name::Shortstr::Bit::Bit::[]letmake_exchangerouting_keymandatoryimmediate={exchange;routing_key;mandatory;immediate}letapplyf{exchange;routing_key;mandatory;immediate}=f(reserved_valueShort)exchangerouting_keymandatoryimmediateletdef=((60,40),spec,make,apply)(* spec/gen_spec.ml:338 *)letwrite=write_method_contentdefContent.Internal.def(* spec/gen_spec.ml:339 *)letread=read_method_contentdefContent.Internal.defend(**/**)(* spec/gen_spec.ml:354 *)letinit~exchange~routing_key~mandatory~immediate()=Internal.makeexchangerouting_keymandatoryimmediate(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method returns an undeliverable message that was published with the "immediate"
flag set, or an unroutable message published with the "mandatory" flag set. The
reply code and text provide information about the reason that the message was
undeliverable.
*)(* spec/gen_spec.ml:276 *)moduleReturn=struct(* spec/gen_spec.ml:310 *)typet={reply_code:reply_code;reply_text:reply_text;exchange:exchange_name;(**
Specifies the name of the exchange that the message was originally published
to. May be empty, meaning the default exchange.
*)routing_key:shortstr;(**
Specifies the routing key name specified when the message was published.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=reply_code::reply_text::exchange_name::Shortstr::[]letmakereply_codereply_textexchangerouting_key={reply_code;reply_text;exchange;routing_key}letapplyf{reply_code;reply_text;exchange;routing_key}=freply_codereply_textexchangerouting_keyletdef=((60,50),spec,make,apply)(* spec/gen_spec.ml:338 *)letwrite=write_method_contentdefContent.Internal.def(* spec/gen_spec.ml:339 *)letread=read_method_contentdefContent.Internal.defend(**/**)(* spec/gen_spec.ml:354 *)letinit~reply_code~reply_text~exchange~routing_key()=Internal.makereply_codereply_textexchangerouting_key(* spec/gen_spec.ml:368 *)letreply=reply0Internal.readend(**
This method delivers a message to the client, via a consumer. In the asynchronous
message delivery model, the client starts a consumer using the Consume method, then
the server responds with Deliver methods as and when messages arrive for that
consumer.
*)(* spec/gen_spec.ml:276 *)moduleDeliver=struct(* spec/gen_spec.ml:310 *)typet={consumer_tag:consumer_tag;delivery_tag:delivery_tag;redelivered:redelivered;exchange:exchange_name;(**
Specifies the name of the exchange that the message was originally published to.
May be empty, indicating the default exchange.
*)routing_key:shortstr;(** Specifies the routing key name specified when the message was published. *)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=consumer_tag::delivery_tag::redelivered::exchange_name::Shortstr::[]letmakeconsumer_tagdelivery_tagredeliveredexchangerouting_key={consumer_tag;delivery_tag;redelivered;exchange;routing_key}letapplyf{consumer_tag;delivery_tag;redelivered;exchange;routing_key}=fconsumer_tagdelivery_tagredeliveredexchangerouting_keyletdef=((60,60),spec,make,apply)(* spec/gen_spec.ml:338 *)letwrite=write_method_contentdefContent.Internal.def(* spec/gen_spec.ml:339 *)letread=read_method_contentdefContent.Internal.defend(**/**)(* spec/gen_spec.ml:354 *)letinit~consumer_tag~delivery_tag~redelivered~exchange~routing_key()=Internal.makeconsumer_tagdelivery_tagredeliveredexchangerouting_key(* spec/gen_spec.ml:368 *)letreply=reply0Internal.readend(**
This method delivers a message to the client following a get method. A message
delivered by 'get-ok' must be acknowledged unless the no-ack option was set in the
get method.
*)(* spec/gen_spec.ml:276 *)moduleGet_ok=struct(* spec/gen_spec.ml:310 *)typet={delivery_tag:delivery_tag;redelivered:redelivered;exchange:exchange_name;(**
Specifies the name of the exchange that the message was originally published to.
If empty, the message was published to the default exchange.
*)routing_key:shortstr;(** Specifies the routing key name specified when the message was published. *)message_count:message_count;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=delivery_tag::redelivered::exchange_name::Shortstr::message_count::[]letmakedelivery_tagredeliveredexchangerouting_keymessage_count={delivery_tag;redelivered;exchange;routing_key;message_count}letapplyf{delivery_tag;redelivered;exchange;routing_key;message_count}=fdelivery_tagredeliveredexchangerouting_keymessage_countletdef=((60,71),spec,make,apply)(* spec/gen_spec.ml:338 *)letwrite=write_method_contentdefContent.Internal.def(* spec/gen_spec.ml:339 *)letread=read_method_contentdefContent.Internal.defend(**/**)(* spec/gen_spec.ml:354 *)letinit~delivery_tag~redelivered~exchange~routing_key~message_count()=Internal.makedelivery_tagredeliveredexchangerouting_keymessage_countend(**
This method tells the client that the queue has no messages available for the
client.
*)(* spec/gen_spec.ml:276 *)moduleGet_empty=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Shortstr::[]letmake_=()letapplyf()=f(reserved_valueShortstr)letdef=((60,72),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method provides a direct access to the messages in a queue using a synchronous
dialogue that is designed for specific types of application where synchronous
functionality is more important than performance.
*)(* spec/gen_spec.ml:276 *)moduleGet=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to get a message from. *)no_ack:no_ack;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::no_ack::[]letmake_queueno_ack={queue;no_ack}letapplyf{queue;no_ack}=f(reserved_valueShort)queueno_ackletdef=((60,70),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~no_ack()=Internal.makequeueno_ack(* spec/gen_spec.ml:372 *)letrequest=request2Internal.writeGet_ok.Internal.read(funm->`Get_okm)Get_empty.Internal.read(funm->`Get_emptym)end(**
When sent by the client, this method acknowledges one or more
messages delivered via the Deliver or Get-Ok methods.
When sent by server, this method acknowledges one or more
messages published with the Publish method on a channel in
confirm mode.
The acknowledgement can be for a single message or a set of
messages up to and including a specific message.
*)(* spec/gen_spec.ml:276 *)moduleAck=struct(* spec/gen_spec.ml:310 *)typet={delivery_tag:delivery_tag;multiple:bit;(**
If set to 1, the delivery tag is treated as "up to and
including", so that multiple messages can be acknowledged
with a single method. If set to zero, the delivery tag
refers to a single message. If the multiple field is 1, and
the delivery tag is zero, this indicates acknowledgement of
all outstanding messages.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=delivery_tag::Bit::[]letmakedelivery_tagmultiple={delivery_tag;multiple}letapplyf{delivery_tag;multiple}=fdelivery_tagmultipleletdef=((60,80),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~delivery_tag~multiple()=Internal.makedelivery_tagmultiple(* spec/gen_spec.ml:368 *)letreply=reply0Internal.read(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method allows a client to reject a message. It can be used to interrupt and
cancel large incoming messages, or return untreatable messages to their original
queue.
*)(* spec/gen_spec.ml:276 *)moduleReject=struct(* spec/gen_spec.ml:310 *)typet={delivery_tag:delivery_tag;requeue:bit;(**
If requeue is true, the server will attempt to requeue the message. If requeue
is false or the requeue attempt fails the messages are discarded or dead-lettered.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=delivery_tag::Bit::[]letmakedelivery_tagrequeue={delivery_tag;requeue}letapplyf{delivery_tag;requeue}=fdelivery_tagrequeueletdef=((60,90),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~delivery_tag~requeue()=Internal.makedelivery_tagrequeue(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method asks the server to redeliver all unacknowledged messages on a
specified channel. Zero or more messages may be redelivered. This method
is deprecated in favour of the synchronous Recover/Recover-Ok.
*)(* spec/gen_spec.ml:276 *)moduleRecover_async=struct(* spec/gen_spec.ml:310 *)typet={requeue:bit;(**
If this field is zero, the message will be redelivered to the original
recipient. If this bit is 1, the server will attempt to requeue the message,
potentially then delivering it to an alternative subscriber.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Bit::[]letmakerequeue={requeue}letapplyf{requeue}=frequeueletdef=((60,100),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~requeue()=Internal.makerequeue(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method asks the server to redeliver all unacknowledged messages on a
specified channel. Zero or more messages may be redelivered. This method
replaces the asynchronous Recover.
*)(* spec/gen_spec.ml:276 *)moduleRecover=struct(* spec/gen_spec.ml:310 *)typet={requeue:bit;(**
If this field is zero, the message will be redelivered to the original
recipient. If this bit is 1, the server will attempt to requeue the message,
potentially then delivering it to an alternative subscriber.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Bit::[]letmakerequeue={requeue}letapplyf{requeue}=frequeueletdef=((60,110),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~requeue()=Internal.makerequeue(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method acknowledges a Basic.Recover method.
*)(* spec/gen_spec.ml:276 *)moduleRecover_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((60,111),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method allows a client to reject one or more incoming messages. It can be
used to interrupt and cancel large incoming messages, or return untreatable
messages to their original queue.
This method is also used by the server to inform publishers on channels in
confirm mode of unhandled messages. If a publisher receives this method, it
probably needs to republish the offending messages.
*)(* spec/gen_spec.ml:276 *)moduleNack=struct(* spec/gen_spec.ml:310 *)typet={delivery_tag:delivery_tag;multiple:bit;(**
If set to 1, the delivery tag is treated as "up to and
including", so that multiple messages can be rejected
with a single method. If set to zero, the delivery tag
refers to a single message. If the multiple field is 1, and
the delivery tag is zero, this indicates rejection of
all outstanding messages.
*)requeue:bit;(**
If requeue is true, the server will attempt to requeue the message. If requeue
is false or the requeue attempt fails the messages are discarded or dead-lettered.
Clients receiving the Nack methods should ignore this flag.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=delivery_tag::Bit::Bit::[]letmakedelivery_tagmultiplerequeue={delivery_tag;multiple;requeue}letapplyf{delivery_tag;multiple;requeue}=fdelivery_tagmultiplerequeueletdef=((60,120),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~delivery_tag~multiple~requeue()=Internal.makedelivery_tagmultiplerequeue(* spec/gen_spec.ml:368 *)letreply=reply0Internal.read(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeendend(**
Queues store and forward messages. Queues can be configured in the server or created at
runtime. Queues must be attached to at least one exchange in order to receive messages
from publishers.
*)(* spec/gen_spec.ml:396 *)moduleQueue=struct(**
This method confirms a Declare method and confirms the name of the queue, essential
for automatically-named queues.
*)(* spec/gen_spec.ml:276 *)moduleDeclare_ok=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(**
Reports the name of the queue. If the server generated a queue name, this field
contains that name.
*)message_count:message_count;consumer_count:long;(**
Reports the number of active consumers for the queue. Note that consumers can
suspend activity (Channel.Flow) in which case they do not appear in this count.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=queue_name::message_count::Long::[]letmakequeuemessage_countconsumer_count={queue;message_count;consumer_count}letapplyf{queue;message_count;consumer_count}=fqueuemessage_countconsumer_countletdef=((50,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~message_count~consumer_count()=Internal.makequeuemessage_countconsumer_countend(**
This method creates or checks a queue. When creating a new queue the client can
specify various properties that control the durability of the queue and its
contents, and the level of sharing for the queue.
*)(* spec/gen_spec.ml:276 *)moduleDeclare=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;passive:bit;(**
If set, the server will reply with Declare-Ok if the queue already
exists with the same name, and raise an error if not. The client can
use this to check whether a queue exists without modifying the
server state. When set, all other method fields except name and no-wait
are ignored. A declare with both passive and no-wait has no effect.
Arguments are compared for semantic equivalence.
*)durable:bit;(**
If set when creating a new queue, the queue will be marked as durable. Durable
queues remain active when a server restarts. Non-durable queues (transient
queues) are purged if/when a server restarts. Note that durable queues do not
necessarily hold persistent messages, although it does not make sense to send
persistent messages to a transient queue.
*)exclusive:bit;(**
Exclusive queues may only be accessed by the current connection, and are
deleted when that connection closes. Passive declaration of an exclusive
queue by other connections are not allowed.
*)auto_delete:bit;(**
If set, the queue is deleted when all consumers have finished using it. The last
consumer can be cancelled either explicitly or because its channel is closed. If
there was no consumer ever on the queue, it won't be deleted. Applications can
explicitly delete auto-delete queues using the Delete method as normal.
*)no_wait:no_wait;arguments:table;(**
A set of arguments for the declaration. The syntax and semantics of these
arguments depends on the server implementation.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::Bit::Bit::Bit::Bit::no_wait::Table::[]letmake_queuepassivedurableexclusiveauto_deleteno_waitarguments={queue;passive;durable;exclusive;auto_delete;no_wait;arguments}letapplyf{queue;passive;durable;exclusive;auto_delete;no_wait;arguments}=f(reserved_valueShort)queuepassivedurableexclusiveauto_deleteno_waitargumentsletdef=((50,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~passive~durable~exclusive~auto_delete~no_wait~arguments()=Internal.makequeuepassivedurableexclusiveauto_deleteno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeDeclare_ok.Internal.readend(** This method confirms that the bind was successful. *)(* spec/gen_spec.ml:276 *)moduleBind_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((50,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method binds a queue to an exchange. Until a queue is bound it will not
receive any messages. In a classic messaging model, store-and-forward queues
are bound to a direct exchange and subscription queues are bound to a topic
exchange.
*)(* spec/gen_spec.ml:276 *)moduleBind=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to bind. *)exchange:exchange_name;routing_key:shortstr;(**
Specifies the routing key for the binding. The routing key is used for routing
messages depending on the exchange configuration. Not all exchanges use a
routing key - refer to the specific exchange documentation. If the queue name
is empty, the server uses the last queue declared on the channel. If the
routing key is also empty, the server uses this queue name for the routing
key as well. If the queue name is provided but the routing key is empty, the
server does the binding with that empty routing key. The meaning of empty
routing keys depends on the exchange implementation.
*)no_wait:no_wait;arguments:table;(**
A set of arguments for the binding. The syntax and semantics of these arguments
depends on the exchange class.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::exchange_name::Shortstr::no_wait::Table::[]letmake_queueexchangerouting_keyno_waitarguments={queue;exchange;routing_key;no_wait;arguments}letapplyf{queue;exchange;routing_key;no_wait;arguments}=f(reserved_valueShort)queueexchangerouting_keyno_waitargumentsletdef=((50,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~exchange~routing_key~no_wait~arguments()=Internal.makequeueexchangerouting_keyno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeBind_ok.Internal.readend(** This method confirms that the unbind was successful. *)(* spec/gen_spec.ml:276 *)moduleUnbind_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((50,51),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(** This method unbinds a queue from an exchange. *)(* spec/gen_spec.ml:276 *)moduleUnbind=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to unbind. *)exchange:exchange_name;(** The name of the exchange to unbind from. *)routing_key:shortstr;(** Specifies the routing key of the binding to unbind. *)arguments:table;(** Specifies the arguments of the binding to unbind. *)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::exchange_name::Shortstr::Table::[]letmake_queueexchangerouting_keyarguments={queue;exchange;routing_key;arguments}letapplyf{queue;exchange;routing_key;arguments}=f(reserved_valueShort)queueexchangerouting_keyargumentsletdef=((50,50),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~exchange~routing_key~arguments()=Internal.makequeueexchangerouting_keyarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeUnbind_ok.Internal.readend(** This method confirms the purge of a queue. *)(* spec/gen_spec.ml:276 *)modulePurge_ok=struct(* spec/gen_spec.ml:310 *)typet={message_count:message_count;(**
Reports the number of messages purged.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=message_count::[]letmakemessage_count={message_count}letapplyf{message_count}=fmessage_countletdef=((50,31),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~message_count()=Internal.makemessage_countend(**
This method removes all messages from a queue which are not awaiting
acknowledgment.
*)(* spec/gen_spec.ml:276 *)modulePurge=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to purge. *)no_wait:no_wait;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::no_wait::[]letmake_queueno_wait={queue;no_wait}letapplyf{queue;no_wait}=f(reserved_valueShort)queueno_waitletdef=((50,30),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~no_wait()=Internal.makequeueno_wait(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writePurge_ok.Internal.readend(** This method confirms the deletion of a queue. *)(* spec/gen_spec.ml:276 *)moduleDelete_ok=struct(* spec/gen_spec.ml:310 *)typet={message_count:message_count;(** Reports the number of messages deleted. *)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=message_count::[]letmakemessage_count={message_count}letapplyf{message_count}=fmessage_countletdef=((50,41),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~message_count()=Internal.makemessage_countend(**
This method deletes a queue. When a queue is deleted any pending messages are sent
to a dead-letter queue if this is defined in the server configuration, and all
consumers on the queue are cancelled.
*)(* spec/gen_spec.ml:276 *)moduleDelete=struct(* spec/gen_spec.ml:310 *)typet={queue:queue_name;(** Specifies the name of the queue to delete. *)if_unused:bit;(**
If set, the server will only delete the queue if it has no consumers. If the
queue has consumers the server does does not delete it but raises a channel
exception instead.
*)if_empty:bit;(**
If set, the server will only delete the queue if it has no messages.
*)no_wait:no_wait;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::queue_name::Bit::Bit::no_wait::[]letmake_queueif_unusedif_emptyno_wait={queue;if_unused;if_empty;no_wait}letapplyf{queue;if_unused;if_empty;no_wait}=f(reserved_valueShort)queueif_unusedif_emptyno_waitletdef=((50,40),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~queue~if_unused~if_empty~no_wait()=Internal.makequeueif_unusedif_emptyno_wait(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeDelete_ok.Internal.readendend(**
Exchanges match and distribute messages across queues. Exchanges can be configured in
the server or declared at runtime.
*)(* spec/gen_spec.ml:396 *)moduleExchange=struct(**
This method confirms a Declare method and confirms the name of the exchange,
essential for automatically-named exchanges.
*)(* spec/gen_spec.ml:276 *)moduleDeclare_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((40,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method creates an exchange if it does not already exist, and if the exchange
exists, verifies that it is of the correct and expected class.
*)(* spec/gen_spec.ml:276 *)moduleDeclare=struct(* spec/gen_spec.ml:310 *)typet={exchange:exchange_name;amqp_type:shortstr;(**
Each exchange belongs to one of a set of exchange types implemented by the
server. The exchange types define the functionality of the exchange - i.e. how
messages are routed through it. It is not valid or meaningful to attempt to
change the type of an existing exchange.
*)passive:bit;(**
If set, the server will reply with Declare-Ok if the exchange already
exists with the same name, and raise an error if not. The client can
use this to check whether an exchange exists without modifying the
server state. When set, all other method fields except name and no-wait
are ignored. A declare with both passive and no-wait has no effect.
Arguments are compared for semantic equivalence.
*)durable:bit;(**
If set when creating a new exchange, the exchange will be marked as durable.
Durable exchanges remain active when a server restarts. Non-durable exchanges
(transient exchanges) are purged if/when a server restarts.
*)auto_delete:bit;(**
If set, the exchange is deleted when all queues have
finished using it.
*)internal:bit;(**
If set, the exchange may not be used directly by publishers,
but only when bound to other exchanges. Internal exchanges
are used to construct wiring that is not visible to
applications.
*)no_wait:no_wait;arguments:table;(**
A set of arguments for the declaration. The syntax and semantics of these
arguments depends on the server implementation.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::exchange_name::Shortstr::Bit::Bit::Bit::Bit::no_wait::Table::[]letmake_exchangeamqp_typepassivedurableauto_deleteinternalno_waitarguments={exchange;amqp_type;passive;durable;auto_delete;internal;no_wait;arguments}letapplyf{exchange;amqp_type;passive;durable;auto_delete;internal;no_wait;arguments}=f(reserved_valueShort)exchangeamqp_typepassivedurableauto_deleteinternalno_waitargumentsletdef=((40,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~exchange~amqp_type~passive~durable~auto_delete~internal~no_wait~arguments()=Internal.makeexchangeamqp_typepassivedurableauto_deleteinternalno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeDeclare_ok.Internal.readend(** This method confirms the deletion of an exchange. *)(* spec/gen_spec.ml:276 *)moduleDelete_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((40,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method deletes an exchange. When an exchange is deleted all queue bindings on
the exchange are cancelled.
*)(* spec/gen_spec.ml:276 *)moduleDelete=struct(* spec/gen_spec.ml:310 *)typet={exchange:exchange_name;if_unused:bit;(**
If set, the server will only delete the exchange if it has no queue bindings. If
the exchange has queue bindings the server does not delete it but raises a
channel exception instead.
*)no_wait:no_wait;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::exchange_name::Bit::no_wait::[]letmake_exchangeif_unusedno_wait={exchange;if_unused;no_wait}letapplyf{exchange;if_unused;no_wait}=f(reserved_valueShort)exchangeif_unusedno_waitletdef=((40,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~exchange~if_unused~no_wait()=Internal.makeexchangeif_unusedno_wait(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeDelete_ok.Internal.readend(** This method confirms that the bind was successful. *)(* spec/gen_spec.ml:276 *)moduleBind_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((40,31),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(** This method binds an exchange to an exchange. *)(* spec/gen_spec.ml:276 *)moduleBind=struct(* spec/gen_spec.ml:310 *)typet={destination:exchange_name;(** Specifies the name of the destination exchange to bind. *)source:exchange_name;(** Specifies the name of the source exchange to bind. *)routing_key:shortstr;(**
Specifies the routing key for the binding. The routing key
is used for routing messages depending on the exchange
configuration. Not all exchanges use a routing key - refer
to the specific exchange documentation.
*)no_wait:no_wait;arguments:table;(**
A set of arguments for the binding. The syntax and semantics
of these arguments depends on the exchange class.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::exchange_name::exchange_name::Shortstr::no_wait::Table::[]letmake_destinationsourcerouting_keyno_waitarguments={destination;source;routing_key;no_wait;arguments}letapplyf{destination;source;routing_key;no_wait;arguments}=f(reserved_valueShort)destinationsourcerouting_keyno_waitargumentsletdef=((40,30),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~destination~source~routing_key~no_wait~arguments()=Internal.makedestinationsourcerouting_keyno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeBind_ok.Internal.readend(** This method confirms that the unbind was successful. *)(* spec/gen_spec.ml:276 *)moduleUnbind_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((40,51),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(** This method unbinds an exchange from an exchange. *)(* spec/gen_spec.ml:276 *)moduleUnbind=struct(* spec/gen_spec.ml:310 *)typet={destination:exchange_name;(** Specifies the name of the destination exchange to unbind. *)source:exchange_name;(** Specifies the name of the source exchange to unbind. *)routing_key:shortstr;(** Specifies the routing key of the binding to unbind. *)no_wait:no_wait;arguments:table;(** Specifies the arguments of the binding to unbind. *)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::exchange_name::exchange_name::Shortstr::no_wait::Table::[]letmake_destinationsourcerouting_keyno_waitarguments={destination;source;routing_key;no_wait;arguments}letapplyf{destination;source;routing_key;no_wait;arguments}=f(reserved_valueShort)destinationsourcerouting_keyno_waitargumentsletdef=((40,40),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~destination~source~routing_key~no_wait~arguments()=Internal.makedestinationsourcerouting_keyno_waitarguments(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeUnbind_ok.Internal.readendend(**
The channel class provides methods for a client to establish a channel to a
server and for both peers to operate the channel thereafter.
*)(* spec/gen_spec.ml:396 *)moduleChannel=struct(**
This method signals to the client that the channel is ready for use.
*)(* spec/gen_spec.ml:276 *)moduleOpen_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Longstr::[]letmake_=()letapplyf()=f(reserved_valueLongstr)letdef=((20,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method opens a channel to the server.
*)(* spec/gen_spec.ml:276 *)moduleOpen=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Shortstr::[]letmake_=()letapplyf()=f(reserved_valueShortstr)letdef=((20,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.make(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeOpen_ok.Internal.readend(**
Confirms to the peer that a flow command was received and processed.
*)(* spec/gen_spec.ml:276 *)moduleFlow_ok=struct(* spec/gen_spec.ml:310 *)typet={active:bit;(**
Confirms the setting of the processed flow method: 1 means the peer will start
sending or continue to send content frames; 0 means it will not.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Bit::[]letmakeactive={active}letapplyf{active}=factiveletdef=((20,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~active()=Internal.makeactive(* spec/gen_spec.ml:368 *)letreply=reply0Internal.read(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method asks the peer to pause or restart the flow of content data sent by
a consumer. This is a simple flow-control mechanism that a peer can use to avoid
overflowing its queues or otherwise finding itself receiving more messages than
it can process. Note that this method is not intended for window control. It does
not affect contents returned by Basic.Get-Ok methods.
*)(* spec/gen_spec.ml:276 *)moduleFlow=struct(* spec/gen_spec.ml:310 *)typet={active:bit;(**
If 1, the peer starts sending content frames. If 0, the peer stops sending
content frames.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Bit::[]letmakeactive={active}letapplyf{active}=factiveletdef=((20,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~active()=Internal.makeactive(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readFlow_ok.Internal.write(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeFlow_ok.Internal.readend(**
This method confirms a Channel.Close method and tells the recipient that it is safe
to release resources for the channel.
*)(* spec/gen_spec.ml:276 *)moduleClose_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((20,41),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
This method indicates that the sender wants to close the channel. 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.
*)(* spec/gen_spec.ml:276 *)moduleClose=struct(* spec/gen_spec.ml:310 *)typet={reply_code:reply_code;reply_text:reply_text;class_id:class_id;(**
When the close is provoked by a method exception, this is the class of the
method.
*)method_id:method_id;(**
When the close is provoked by a method exception, this is the ID of the method.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=reply_code::reply_text::class_id::method_id::[]letmakereply_codereply_textclass_idmethod_id={reply_code;reply_text;class_id;method_id}letapplyf{reply_code;reply_text;class_id;method_id}=freply_codereply_textclass_idmethod_idletdef=((20,40),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~reply_code~reply_text~class_id~method_id()=Internal.makereply_codereply_textclass_idmethod_id(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readClose_ok.Internal.write(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeClose_ok.Internal.readendend(**
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.
*)(* spec/gen_spec.ml:396 *)moduleConnection=struct(**
This method selects a SASL security mechanism.
*)(* spec/gen_spec.ml:276 *)moduleStart_ok=struct(* spec/gen_spec.ml:310 *)typet={client_properties:peer_properties;mechanism:shortstr;(**
A single security mechanisms selected by the client, which must be one of those
specified by the server.
*)response:longstr;(**
A block of opaque data passed to the security mechanism. The contents of this
data are defined by the SASL security mechanism.
*)locale:shortstr;(**
A single message locale selected by the client, which must be one of those
specified by the server.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=peer_properties::Shortstr::Longstr::Shortstr::[]letmakeclient_propertiesmechanismresponselocale={client_properties;mechanism;response;locale}letapplyf{client_properties;mechanism;response;locale}=fclient_propertiesmechanismresponselocaleletdef=((10,11),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~client_properties~mechanism~response~locale()=Internal.makeclient_propertiesmechanismresponselocaleend(**
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.
*)(* spec/gen_spec.ml:276 *)moduleStart=struct(* spec/gen_spec.ml:310 *)typet={version_major:octet;(**
The major version number can take any value from 0 to 99 as defined in the
AMQP specification.
*)version_minor:octet;(**
The minor version number can take any value from 0 to 99 as defined in the
AMQP specification.
*)server_properties:peer_properties;mechanisms:longstr;(**
A list of the security mechanisms that the server supports, delimited by spaces.
*)locales:longstr;(**
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.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Octet::Octet::peer_properties::Longstr::Longstr::[]letmakeversion_majorversion_minorserver_propertiesmechanismslocales={version_major;version_minor;server_properties;mechanisms;locales}letapplyf{version_major;version_minor;server_properties;mechanisms;locales}=fversion_majorversion_minorserver_propertiesmechanismslocalesletdef=((10,10),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~version_major~version_minor~server_properties~mechanisms~locales()=Internal.makeversion_majorversion_minorserver_propertiesmechanismslocales(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readStart_ok.Internal.writeend(**
This method attempts to authenticate, passing a block of SASL data for the security
mechanism at the server side.
*)(* spec/gen_spec.ml:276 *)moduleSecure_ok=struct(* spec/gen_spec.ml:310 *)typet={response:longstr;(**
A block of opaque data passed to the security mechanism. The contents of this
data are defined by the SASL security mechanism.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Longstr::[]letmakeresponse={response}letapplyf{response}=fresponseletdef=((10,21),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~response()=Internal.makeresponseend(**
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.
*)(* spec/gen_spec.ml:276 *)moduleSecure=struct(* spec/gen_spec.ml:310 *)typet={challenge:longstr;(**
Challenge information, a block of opaque binary data passed to the security
mechanism.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Longstr::[]letmakechallenge={challenge}letapplyf{challenge}=fchallengeletdef=((10,20),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~challenge()=Internal.makechallenge(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readSecure_ok.Internal.writeend(**
This method sends the client's connection tuning parameters to the server.
Certain fields are negotiated, others provide capability information.
*)(* spec/gen_spec.ml:276 *)moduleTune_ok=struct(* spec/gen_spec.ml:310 *)typet={channel_max:short;(**
The maximum total number of channels that the client will use per connection.
*)frame_max:long;(**
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.
*)heartbeat:short;(**
The delay, in seconds, of the connection heartbeat that the client wants. Zero
means the client does not want a heartbeat.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::Long::Short::[]letmakechannel_maxframe_maxheartbeat={channel_max;frame_max;heartbeat}letapplyf{channel_max;frame_max;heartbeat}=fchannel_maxframe_maxheartbeatletdef=((10,31),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~channel_max~frame_max~heartbeat()=Internal.makechannel_maxframe_maxheartbeatend(**
This method proposes a set of connection configuration values to the client. The
client can accept and/or adjust these.
*)(* spec/gen_spec.ml:276 *)moduleTune=struct(* spec/gen_spec.ml:310 *)typet={channel_max:short;(**
Specifies highest channel number that the server permits. Usable channel numbers
are in the range 1..channel-max. Zero indicates no specified limit.
*)frame_max:long;(**
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.
*)heartbeat:short;(**
The delay, in seconds, of the connection heartbeat that the server wants.
Zero means the server does not want a heartbeat.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Short::Long::Short::[]letmakechannel_maxframe_maxheartbeat={channel_max;frame_max;heartbeat}letapplyf{channel_max;frame_max;heartbeat}=fchannel_maxframe_maxheartbeatletdef=((10,30),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~channel_max~frame_max~heartbeat()=Internal.makechannel_maxframe_maxheartbeat(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readTune_ok.Internal.writeend(**
This method signals to the client that the connection is ready for use.
*)(* spec/gen_spec.ml:276 *)moduleOpen_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Shortstr::[]letmake_=()letapplyf()=f(reserved_valueShortstr)letdef=((10,41),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
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.
*)(* spec/gen_spec.ml:276 *)moduleOpen=struct(* spec/gen_spec.ml:310 *)typet={virtual_host:path;(**
The name of the virtual host to work with.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=path::Shortstr::Bit::[]letmakevirtual_host__={virtual_host}letapplyf{virtual_host}=fvirtual_host(reserved_valueShortstr)(reserved_valueBit)letdef=((10,40),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~virtual_host()=Internal.makevirtual_host(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeOpen_ok.Internal.readend(**
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.
*)(* spec/gen_spec.ml:276 *)moduleClose_ok=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((10,51),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.makeend(**
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.
*)(* spec/gen_spec.ml:276 *)moduleClose=struct(* spec/gen_spec.ml:310 *)typet={reply_code:reply_code;reply_text:reply_text;class_id:class_id;(**
When the close is provoked by a method exception, this is the class of the
method.
*)method_id:method_id;(**
When the close is provoked by a method exception, this is the ID of the method.
*)}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=reply_code::reply_text::class_id::method_id::[]letmakereply_codereply_textclass_idmethod_id={reply_code;reply_text;class_id;method_id}letapplyf{reply_code;reply_text;class_id;method_id}=freply_codereply_textclass_idmethod_idletdef=((10,50),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~reply_code~reply_text~class_id~method_id()=Internal.makereply_codereply_textclass_idmethod_id(* spec/gen_spec.ml:368 *)letreply=reply1Internal.readClose_ok.Internal.write(* spec/gen_spec.ml:372 *)letrequest=request1Internal.writeClose_ok.Internal.readend(**
This method indicates that a connection has been blocked
and does not accept new publishes.
*)(* spec/gen_spec.ml:276 *)moduleBlocked=struct(* spec/gen_spec.ml:310 *)typet={reason:shortstr;}(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=Shortstr::[]letmakereason={reason}letapplyf{reason}=freasonletdef=((10,60),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit~reason()=Internal.makereason(* spec/gen_spec.ml:368 *)letreply=reply0Internal.read(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeend(**
This method indicates that a connection has been unblocked
and now accepts publishes.
*)(* spec/gen_spec.ml:276 *)moduleUnblocked=struct(* spec/gen_spec.ml:308 *)typet=unit(**/**)(* spec/gen_spec.ml:317 *)moduleInternal=structopenInternal_alias[@@warning"-33"]openProtocol.Spec(* spec/gen_spec.ml:327 *)letspec=[]letmake=()letapplyf()=fletdef=((10,61),spec,make,apply)(* spec/gen_spec.ml:335 *)letwrite=write_methoddef(* spec/gen_spec.ml:336 *)letread=read_methoddefend(**/**)(* spec/gen_spec.ml:354 *)letinit()=Internal.make(* spec/gen_spec.ml:368 *)letreply=reply0Internal.read(* spec/gen_spec.ml:372 *)letrequest=request0Internal.writeendend