RabbitMQ.Client.xml 256 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>RabbitMQ.Client</name>
  5. </assembly>
  6. <members>
  7. <member name="T:RabbitMQ.Client.AmqpTcpEndpoint">
  8. <summary>
  9. Represents a TCP-addressable AMQP peer: a host name and port number.
  10. </summary>
  11. <para>
  12. Some of the constructors take, as a convenience, a System.Uri
  13. instance representing an AMQP server address. The use of Uri
  14. here is not standardised - Uri is simply a convenient
  15. container for internet-address-like components. In particular,
  16. the Uri "Scheme" property is ignored: only the "Host" and
  17. "Port" properties are extracted.
  18. </para>
  19. </member>
  20. <member name="F:RabbitMQ.Client.AmqpTcpEndpoint.DefaultAmqpSslPort">
  21. <summary>
  22. Default Amqp ssl port.
  23. </summary>
  24. </member>
  25. <member name="F:RabbitMQ.Client.AmqpTcpEndpoint.UseDefaultPort">
  26. <summary>
  27. Indicates that the default port for the protocol should be used.
  28. </summary>
  29. </member>
  30. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.#ctor(System.String,System.Int32,RabbitMQ.Client.SslOption)">
  31. <summary>
  32. Creates a new instance of the <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/>.
  33. </summary>
  34. <param name="hostName">Hostname.</param>
  35. <param name="portOrMinusOne"> Port number. If the port number is -1, the default port number will be used.</param>
  36. <param name="ssl">Ssl option.</param>
  37. </member>
  38. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.#ctor(System.String,System.Int32)">
  39. <summary>
  40. Creates a new instance of the <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/>.
  41. </summary>
  42. <param name="hostName">Hostname.</param>
  43. <param name="portOrMinusOne"> Port number. If the port number is -1, the default port number will be used.</param>
  44. </member>
  45. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.#ctor">
  46. <summary>
  47. Construct an AmqpTcpEndpoint with "localhost" as the hostname, and using the default port.
  48. </summary>
  49. </member>
  50. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.#ctor(System.Uri,RabbitMQ.Client.SslOption)">
  51. <summary>
  52. Creates a new instance of the <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/> with the given Uri and ssl options.
  53. </summary>
  54. <remarks>
  55. Please see the class overview documentation for information about the Uri format in use.
  56. </remarks>
  57. </member>
  58. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.#ctor(System.Uri)">
  59. <summary>
  60. Creates a new instance of the <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/> with the given Uri.
  61. </summary>
  62. <remarks>
  63. Please see the class overview documentation for information about the Uri format in use.
  64. </remarks>
  65. </member>
  66. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.Clone">
  67. <summary>
  68. Clones the endpoint.
  69. </summary>
  70. <returns>A copy with the same hostname, port, and TLS settings</returns>
  71. </member>
  72. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.CloneWithHostname(System.String)">
  73. <summary>
  74. Clones the endpoint using the provided hostname.
  75. </summary>
  76. <param name="hostname">Hostname to use</param>
  77. <returns>A copy with the provided hostname and port/TLS settings of this endpoint</returns>
  78. </member>
  79. <member name="P:RabbitMQ.Client.AmqpTcpEndpoint.HostName">
  80. <summary>
  81. Retrieve or set the hostname of this <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/>.
  82. </summary>
  83. </member>
  84. <member name="P:RabbitMQ.Client.AmqpTcpEndpoint.Port">
  85. <summary>Retrieve or set the port number of this
  86. AmqpTcpEndpoint. A port number of -1 causes the default
  87. port number.</summary>
  88. </member>
  89. <member name="P:RabbitMQ.Client.AmqpTcpEndpoint.Protocol">
  90. <summary>
  91. Retrieve IProtocol of this <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/>.
  92. </summary>
  93. </member>
  94. <member name="P:RabbitMQ.Client.AmqpTcpEndpoint.AddressFamily">
  95. <summary>
  96. Used to force the address family of the endpoint.
  97. Use <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" /> to force to IPv4.
  98. Use <see cref="F:System.Net.Sockets.AddressFamily.InterNetworkV6" /> to force to IPv6.
  99. Or use <see cref="F:System.Net.Sockets.AddressFamily.Unknown" /> to attempt both IPv6 and IPv4.
  100. </summary>
  101. </member>
  102. <member name="P:RabbitMQ.Client.AmqpTcpEndpoint.Ssl">
  103. <summary>
  104. Retrieve the TLS options for this AmqpTcpEndpoint. If not set, null is returned.
  105. </summary>
  106. </member>
  107. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.Parse(System.String)">
  108. <summary>
  109. Construct an instance from a protocol and an address in "hostname:port" format.
  110. </summary>
  111. <remarks>
  112. If the address string passed in contains ":", it is split
  113. into a hostname and a port-number part. Otherwise, the
  114. entire string is used as the hostname, and the port-number
  115. is set to -1 (meaning the default number for the protocol
  116. variant specified).
  117. Hostnames provided as IPv6 must appear in square brackets ([]).
  118. </remarks>
  119. </member>
  120. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.ParseMultiple(System.String)">
  121. <summary>
  122. Splits the passed-in string on ",", and passes the substrings to <see cref="M:RabbitMQ.Client.AmqpTcpEndpoint.Parse(System.String)"/>.
  123. </summary>
  124. <remarks>
  125. Accepts a string of the form "hostname:port,
  126. hostname:port, ...", where the ":port" pieces are
  127. optional, and returns a corresponding array of <see cref="T:RabbitMQ.Client.AmqpTcpEndpoint"/>s.
  128. </remarks>
  129. </member>
  130. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.Equals(System.Object)">
  131. <summary>
  132. Compares this instance by value (protocol, hostname, port) against another instance.
  133. </summary>
  134. </member>
  135. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.GetHashCode">
  136. <summary>
  137. Implementation of hash code depending on protocol, hostname and port,
  138. to line up with the implementation of <see cref="M:RabbitMQ.Client.AmqpTcpEndpoint.Equals(System.Object)"/>.
  139. </summary>
  140. </member>
  141. <member name="M:RabbitMQ.Client.AmqpTcpEndpoint.ToString">
  142. <summary>
  143. Returns a URI-like string of the form amqp-PROTOCOL://HOSTNAME:PORTNUMBER.
  144. </summary>
  145. <remarks>
  146. This method is intended mainly for debugging and logging use.
  147. </remarks>
  148. </member>
  149. <member name="T:RabbitMQ.Client.AmqpTimestamp">
  150. <summary>
  151. Structure holding an AMQP timestamp, a posix 64-bit time_t.</summary>
  152. <remarks>
  153. <para>
  154. When converting between an AmqpTimestamp and a System.DateTime,
  155. be aware of the effect of your local timezone. In particular,
  156. different versions of the .NET framework assume different
  157. defaults.
  158. </para>
  159. <para>
  160. We have chosen a signed 64-bit time_t here, since the AMQP
  161. specification through versions 0-9 is silent on whether
  162. timestamps are signed or unsigned.
  163. </para>
  164. </remarks>
  165. </member>
  166. <member name="M:RabbitMQ.Client.AmqpTimestamp.#ctor(System.Int64)">
  167. <summary>
  168. Construct an <see cref="T:RabbitMQ.Client.AmqpTimestamp"/>.
  169. </summary>
  170. <param name="unixTime">Unix time.</param>
  171. </member>
  172. <member name="P:RabbitMQ.Client.AmqpTimestamp.UnixTime">
  173. <summary>
  174. Unix time.
  175. </summary>
  176. </member>
  177. <member name="M:RabbitMQ.Client.AmqpTimestamp.ToString">
  178. <summary>
  179. Provides a debugger-friendly display.
  180. </summary>
  181. </member>
  182. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.#ctor">
  183. <summary>
  184. Creates a new instance of an <see cref="T:RabbitMQ.Client.DefaultBasicConsumer"/>.
  185. </summary>
  186. </member>
  187. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.#ctor(RabbitMQ.Client.IModel)">
  188. <summary>
  189. Constructor which sets the Model property to the given value.
  190. </summary>
  191. <param name="model">Common AMQP model.</param>
  192. </member>
  193. <member name="P:RabbitMQ.Client.AsyncDefaultBasicConsumer.ConsumerTags">
  194. <summary>
  195. Retrieve the consumer tags this consumer is registered as; to be used when discussing this consumer
  196. with the server, for instance with <see cref="M:RabbitMQ.Client.IModel.BasicCancel(System.String)"/>.
  197. </summary>
  198. </member>
  199. <member name="P:RabbitMQ.Client.AsyncDefaultBasicConsumer.IsRunning">
  200. <summary>
  201. Returns true while the consumer is registered and expecting deliveries from the broker.
  202. </summary>
  203. </member>
  204. <member name="P:RabbitMQ.Client.AsyncDefaultBasicConsumer.ShutdownReason">
  205. <summary>
  206. If our <see cref="T:RabbitMQ.Client.IModel"/> shuts down, this property will contain a description of the reason for the
  207. shutdown. Otherwise it will contain null. See <see cref="T:RabbitMQ.Client.ShutdownEventArgs"/>.
  208. </summary>
  209. </member>
  210. <member name="E:RabbitMQ.Client.AsyncDefaultBasicConsumer.ConsumerCancelled">
  211. <summary>
  212. Signalled when the consumer gets cancelled.
  213. </summary>
  214. </member>
  215. <member name="P:RabbitMQ.Client.AsyncDefaultBasicConsumer.Model">
  216. <summary>
  217. Retrieve the <see cref="T:RabbitMQ.Client.IModel"/> this consumer is associated with,
  218. for use in acknowledging received messages, for instance.
  219. </summary>
  220. </member>
  221. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicCancel(System.String)">
  222. <summary>
  223. Called when the consumer is cancelled for reasons other than by a basicCancel:
  224. e.g. the queue has been deleted (either by this channel or by any other channel).
  225. See <see cref="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicCancelOk(System.String)"/> for notification of consumer cancellation due to basicCancel
  226. </summary>
  227. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  228. </member>
  229. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicCancelOk(System.String)">
  230. <summary>
  231. Called upon successful deregistration of the consumer from the broker.
  232. </summary>
  233. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  234. </member>
  235. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicConsumeOk(System.String)">
  236. <summary>
  237. Called upon successful registration of the consumer with the broker.
  238. </summary>
  239. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  240. </member>
  241. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  242. <summary>
  243. Called each time a message is delivered for this consumer.
  244. </summary>
  245. <remarks>
  246. This is a no-op implementation. It will not acknowledge deliveries via <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>
  247. if consuming in automatic acknowledgement mode.
  248. Subclasses must copy or fully use delivery body before returning.
  249. Accessing the body at a later point is unsafe as its memory can
  250. be already released.
  251. </remarks>
  252. </member>
  253. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  254. <summary>
  255. Called when the model (channel) this consumer was registered on terminates.
  256. </summary>
  257. <param name="model">A channel this consumer was registered on.</param>
  258. <param name="reason">Shutdown context.</param>
  259. </member>
  260. <member name="M:RabbitMQ.Client.AsyncDefaultBasicConsumer.OnCancel(System.String[])">
  261. <summary>
  262. Default implementation - overridable in subclasses.</summary>
  263. <param name="consumerTags">The set of consumer tags that where cancelled</param>
  264. <remarks>
  265. This default implementation simply sets the <see cref="P:RabbitMQ.Client.AsyncDefaultBasicConsumer.IsRunning"/>
  266. property to false, and takes no further action.
  267. </remarks>
  268. </member>
  269. <member name="T:RabbitMQ.Client.BasicGetResult">
  270. <summary>Represents Basic.GetOk responses from the server.</summary>
  271. <remarks>
  272. Basic.Get either returns an instance of this class, or null if a Basic.GetEmpty was received.
  273. </remarks>
  274. </member>
  275. <member name="M:RabbitMQ.Client.BasicGetResult.#ctor(System.UInt64,System.Boolean,System.String,System.String,System.UInt32,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  276. <summary>
  277. Sets the new instance's properties from the arguments passed in.
  278. </summary>
  279. <param name="deliveryTag">Delivery tag for the message.</param>
  280. <param name="redelivered">Redelivered flag for the message</param>
  281. <param name="exchange">The exchange this message was published to.</param>
  282. <param name="routingKey">Routing key with which the message was published.</param>
  283. <param name="messageCount">The number of messages pending on the queue, excluding the message being delivered.</param>
  284. <param name="basicProperties">The Basic-class content header properties for the message.</param>
  285. <param name="body"></param>
  286. </member>
  287. <member name="P:RabbitMQ.Client.BasicGetResult.BasicProperties">
  288. <summary>
  289. Retrieves the Basic-class content header properties for this message.
  290. </summary>
  291. </member>
  292. <member name="P:RabbitMQ.Client.BasicGetResult.Body">
  293. <summary>
  294. Retrieves the body of this message.
  295. </summary>
  296. </member>
  297. <member name="P:RabbitMQ.Client.BasicGetResult.DeliveryTag">
  298. <summary>
  299. Retrieve the delivery tag for this message. See also <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>.
  300. </summary>
  301. </member>
  302. <member name="P:RabbitMQ.Client.BasicGetResult.Exchange">
  303. <summary>
  304. Retrieve the exchange this message was published to.
  305. </summary>
  306. </member>
  307. <member name="P:RabbitMQ.Client.BasicGetResult.MessageCount">
  308. <summary>
  309. Retrieve the number of messages pending on the queue, excluding the message being delivered.
  310. </summary>
  311. <remarks>
  312. Note that this figure is indicative, not reliable, and can
  313. change arbitrarily as messages are added to the queue and removed by other clients.
  314. </remarks>
  315. </member>
  316. <member name="P:RabbitMQ.Client.BasicGetResult.Redelivered">
  317. <summary>
  318. Retrieve the redelivered flag for this message.
  319. </summary>
  320. </member>
  321. <member name="P:RabbitMQ.Client.BasicGetResult.RoutingKey">
  322. <summary>
  323. Retrieve the routing key with which this message was published.
  324. </summary>
  325. </member>
  326. <member name="T:RabbitMQ.Client.BinaryTableValue">
  327. <summary>Wrapper for a byte[]. May appear as values read from
  328. and written to AMQP field tables.</summary>
  329. <remarks>
  330. <para>
  331. The sole reason for the existence of this class is to permit
  332. encoding of byte[] as 'x' in AMQP field tables, an extension
  333. to the specification that is part of the tentative JMS mapping
  334. implemented by QPid.
  335. </para>
  336. <para>
  337. Instances of this object may be found as values held in
  338. IDictionary instances returned from
  339. RabbitMQ.Client.Impl.WireFormatting.ReadTable, e.g. as part of
  340. IBasicProperties.Headers tables. Likewise, instances may be
  341. set as values in an IDictionary table to be encoded by
  342. RabbitMQ.Client.Impl.WireFormatting.WriteTable.
  343. </para>
  344. <para>
  345. When an instance of this class is encoded/decoded, the type
  346. tag 'x' is used in the on-the-wire representation. The AMQP
  347. standard type tag 'S' is decoded to a raw byte[], and a raw
  348. byte[] is encoded as 'S'. Instances of System.String are
  349. converted to a UTF-8 binary representation, and then encoded
  350. using tag 'S'. In order to force the use of tag 'x', instances
  351. of this class must be used.
  352. </para>
  353. </remarks>
  354. </member>
  355. <member name="M:RabbitMQ.Client.BinaryTableValue.#ctor">
  356. <summary>
  357. Creates a new instance of the <see cref="T:RabbitMQ.Client.BinaryTableValue"/> with null for its Bytes property.
  358. </summary>
  359. </member>
  360. <member name="M:RabbitMQ.Client.BinaryTableValue.#ctor(System.Byte[])">
  361. <summary>
  362. Creates a new instance of the <see cref="T:RabbitMQ.Client.BinaryTableValue"/>.
  363. </summary>
  364. <param name="bytes">The wrapped byte array, as decoded or as to be encoded.</param>
  365. </member>
  366. <member name="P:RabbitMQ.Client.BinaryTableValue.Bytes">
  367. <summary>
  368. The wrapped byte array, as decoded or as to be encoded.
  369. </summary>
  370. </member>
  371. <member name="T:RabbitMQ.Client.ConnectionFactory">
  372. <summary>Main entry point to the RabbitMQ .NET AMQP client
  373. API. Constructs <see cref="T:RabbitMQ.Client.IConnection"/> instances.</summary>
  374. <remarks>
  375. <para>
  376. A simple example of connecting to a broker:
  377. </para>
  378. <example><code>
  379. ConnectionFactory factory = new ConnectionFactory();
  380. //
  381. // The next six lines are optional:
  382. factory.UserName = ConnectionFactory.DefaultUser;
  383. factory.Password = ConnectionFactory.DefaultPass;
  384. factory.VirtualHost = ConnectionFactory.DefaultVHost;
  385. factory.HostName = hostName;
  386. factory.Port = AmqpTcpEndpoint.UseDefaultPort;
  387. //
  388. IConnection conn = factory.CreateConnection();
  389. //
  390. IModel ch = conn.CreateModel();
  391. //
  392. // ... use ch's IModel methods ...
  393. //
  394. ch.Close(Constants.ReplySuccess, "Closing the channel");
  395. conn.Close(Constants.ReplySuccess, "Closing the connection");
  396. </code></example>
  397. <para>
  398. The same example, written more compactly with AMQP URIs:
  399. </para>
  400. <example><code>
  401. ConnectionFactory factory = new ConnectionFactory();
  402. factory.SetUri("amqp://localhost");
  403. IConnection conn = factory.CreateConnection();
  404. ...
  405. </code></example>
  406. <para>
  407. Please see also the API overview and tutorial in the User Guide.
  408. </para>
  409. <para>
  410. Note that the Uri property takes a string representation of an
  411. AMQP URI. Omitted URI parts will take default values. The
  412. host part of the URI cannot be omitted and URIs of the form
  413. "amqp://foo/" (note the trailing slash) also represent the
  414. default virtual host. The latter issue means that virtual
  415. hosts with an empty name are not addressable. </para></remarks>
  416. </member>
  417. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultChannelMax">
  418. <summary>
  419. Default value for the desired maximum channel number. Default: 2047.
  420. </summary>
  421. </member>
  422. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultConnectionTimeout">
  423. <summary>
  424. Default value for connection attempt timeout.
  425. </summary>
  426. </member>
  427. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultFrameMax">
  428. <summary>
  429. Default value for the desired maximum frame size. Default is 0 ("no limit").
  430. </summary>
  431. </member>
  432. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultHeartbeat">
  433. <summary>
  434. Default value for desired heartbeat interval. Default is 60 seconds,
  435. TimeSpan.Zero means "heartbeats are disabled".
  436. </summary>
  437. </member>
  438. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultPass">
  439. <summary>
  440. Default password (value: "guest").
  441. </summary>
  442. </member>
  443. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultUser">
  444. <summary>
  445. Default user name (value: "guest").
  446. </summary>
  447. </member>
  448. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultVHost">
  449. <summary>
  450. Default virtual host (value: "/").
  451. </summary>
  452. </member>
  453. <member name="P:RabbitMQ.Client.ConnectionFactory.DefaultAmqpUriSslProtocols">
  454. <summary>
  455. TLS versions enabled by default: TLSv1.2, v1.1, v1.0.
  456. </summary>
  457. </member>
  458. <member name="P:RabbitMQ.Client.ConnectionFactory.AmqpUriSslProtocols">
  459. <summary>
  460. The AMQP URI SSL protocols.
  461. </summary>
  462. </member>
  463. <member name="F:RabbitMQ.Client.ConnectionFactory.DefaultAuthMechanisms">
  464. <summary>
  465. Default SASL auth mechanisms to use.
  466. </summary>
  467. </member>
  468. <member name="P:RabbitMQ.Client.ConnectionFactory.AuthMechanisms">
  469. <summary>
  470. SASL auth mechanisms to use.
  471. </summary>
  472. </member>
  473. <member name="P:RabbitMQ.Client.ConnectionFactory.DefaultAddressFamily">
  474. <summary>
  475. Address family used by default.
  476. Use <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" /> to force to IPv4.
  477. Use <see cref="F:System.Net.Sockets.AddressFamily.InterNetworkV6" /> to force to IPv6.
  478. Or use <see cref="F:System.Net.Sockets.AddressFamily.Unknown" /> to attempt both IPv6 and IPv4.
  479. </summary>
  480. </member>
  481. <member name="P:RabbitMQ.Client.ConnectionFactory.AutomaticRecoveryEnabled">
  482. <summary>
  483. Set to false to disable automatic connection recovery.
  484. Defaults to true.
  485. </summary>
  486. </member>
  487. <member name="P:RabbitMQ.Client.ConnectionFactory.DispatchConsumersAsync">
  488. <summary>
  489. Set to true will enable a asynchronous consumer dispatcher which is compatible with <see cref="T:RabbitMQ.Client.IAsyncBasicConsumer"/>.
  490. Defaults to false.
  491. </summary>
  492. </member>
  493. <member name="P:RabbitMQ.Client.ConnectionFactory.ConsumerDispatchConcurrency">
  494. <summary>
  495. Set to a value greater than one to enable concurrent processing. For a concurrency greater than one <see cref="T:RabbitMQ.Client.IBasicConsumer"/>
  496. will be offloaded to the worker thread pool so it is important to choose the value for the concurrency wisely to avoid thread pool overloading.
  497. <see cref="T:RabbitMQ.Client.IAsyncBasicConsumer"/> can handle concurrency much more efficiently due to the non-blocking nature of the consumer.
  498. Defaults to 1.
  499. </summary>
  500. <remarks>For concurrency greater than one this removes the guarantee that consumers handle messages in the order they receive them.
  501. In addition to that consumers need to be thread/concurrency safe.</remarks>
  502. </member>
  503. <member name="P:RabbitMQ.Client.ConnectionFactory.HostName">
  504. <summary>The host to connect to.</summary>
  505. </member>
  506. <member name="P:RabbitMQ.Client.ConnectionFactory.NetworkRecoveryInterval">
  507. <summary>
  508. Amount of time client will wait for before re-trying to recover connection.
  509. </summary>
  510. </member>
  511. <member name="P:RabbitMQ.Client.ConnectionFactory.HandshakeContinuationTimeout">
  512. <summary>
  513. Amount of time protocol handshake operations are allowed to take before
  514. timing out.
  515. </summary>
  516. </member>
  517. <member name="P:RabbitMQ.Client.ConnectionFactory.ContinuationTimeout">
  518. <summary>
  519. Amount of time protocol operations (e.g. <code>queue.declare</code>) are allowed to take before
  520. timing out.
  521. </summary>
  522. </member>
  523. <member name="P:RabbitMQ.Client.ConnectionFactory.EndpointResolverFactory">
  524. <summary>
  525. Factory function for creating the <see cref="T:RabbitMQ.Client.IEndpointResolver"/>
  526. used to generate a list of endpoints for the ConnectionFactory
  527. to try in order.
  528. The default value creates an instance of the <see cref="T:RabbitMQ.Client.DefaultEndpointResolver"/>
  529. using the list of endpoints passed in. The DefaultEndpointResolver shuffles the
  530. provided list each time it is requested.
  531. </summary>
  532. </member>
  533. <member name="P:RabbitMQ.Client.ConnectionFactory.Port">
  534. <summary>
  535. The port to connect on. <see cref="F:RabbitMQ.Client.AmqpTcpEndpoint.UseDefaultPort"/>
  536. indicates the default for the protocol should be used.
  537. </summary>
  538. </member>
  539. <member name="P:RabbitMQ.Client.ConnectionFactory.RequestedConnectionTimeout">
  540. <summary>
  541. Timeout setting for connection attempts.
  542. </summary>
  543. </member>
  544. <member name="P:RabbitMQ.Client.ConnectionFactory.SocketReadTimeout">
  545. <summary>
  546. Timeout setting for socket read operations.
  547. </summary>
  548. </member>
  549. <member name="P:RabbitMQ.Client.ConnectionFactory.SocketWriteTimeout">
  550. <summary>
  551. Timeout setting for socket write operations.
  552. </summary>
  553. </member>
  554. <member name="P:RabbitMQ.Client.ConnectionFactory.Ssl">
  555. <summary>
  556. TLS options setting.
  557. </summary>
  558. </member>
  559. <member name="P:RabbitMQ.Client.ConnectionFactory.TopologyRecoveryEnabled">
  560. <summary>
  561. Set to false to make automatic connection recovery not recover topology (exchanges, queues, bindings, etc).
  562. Defaults to true.
  563. </summary>
  564. </member>
  565. <member name="M:RabbitMQ.Client.ConnectionFactory.#ctor">
  566. <summary>
  567. Construct a fresh instance, with all fields set to their respective defaults.
  568. </summary>
  569. </member>
  570. <member name="P:RabbitMQ.Client.ConnectionFactory.Endpoint">
  571. <summary>
  572. Connection endpoint.
  573. </summary>
  574. </member>
  575. <member name="P:RabbitMQ.Client.ConnectionFactory.ClientProperties">
  576. <summary>
  577. Dictionary of client properties to be sent to the server.
  578. </summary>
  579. </member>
  580. <member name="P:RabbitMQ.Client.ConnectionFactory.Password">
  581. <summary>
  582. Password to use when authenticating to the server.
  583. </summary>
  584. </member>
  585. <member name="P:RabbitMQ.Client.ConnectionFactory.RequestedChannelMax">
  586. <summary>
  587. Maximum channel number to ask for.
  588. </summary>
  589. </member>
  590. <member name="P:RabbitMQ.Client.ConnectionFactory.RequestedFrameMax">
  591. <summary>
  592. Frame-max parameter to ask for (in bytes).
  593. </summary>
  594. </member>
  595. <member name="P:RabbitMQ.Client.ConnectionFactory.RequestedHeartbeat">
  596. <summary>
  597. Heartbeat timeout to use when negotiating with the server.
  598. </summary>
  599. </member>
  600. <member name="P:RabbitMQ.Client.ConnectionFactory.UseBackgroundThreadsForIO">
  601. <summary>
  602. When set to true, background thread will be used for the I/O loop.
  603. </summary>
  604. </member>
  605. <member name="P:RabbitMQ.Client.ConnectionFactory.UserName">
  606. <summary>
  607. Username to use when authenticating to the server.
  608. </summary>
  609. </member>
  610. <member name="P:RabbitMQ.Client.ConnectionFactory.VirtualHost">
  611. <summary>
  612. Virtual host to access during this connection.
  613. </summary>
  614. </member>
  615. <member name="P:RabbitMQ.Client.ConnectionFactory.Uri">
  616. <summary>
  617. The uri to use for the connection.
  618. </summary>
  619. </member>
  620. <member name="P:RabbitMQ.Client.ConnectionFactory.ClientProvidedName">
  621. <summary>
  622. Default client provided name to be used for connections.
  623. </summary>
  624. </member>
  625. <member name="M:RabbitMQ.Client.ConnectionFactory.AuthMechanismFactory(System.Collections.Generic.IList{System.String})">
  626. <summary>
  627. Given a list of mechanism names supported by the server, select a preferred mechanism,
  628. or null if we have none in common.
  629. </summary>
  630. </member>
  631. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection">
  632. <summary>
  633. Create a connection to one of the endpoints provided by the IEndpointResolver
  634. returned by the EndpointResolverFactory. By default the configured
  635. hostname and port are used.
  636. </summary>
  637. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  638. When the configured hostname was not reachable.
  639. </exception>
  640. </member>
  641. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(System.String)">
  642. <summary>
  643. Create a connection to one of the endpoints provided by the IEndpointResolver
  644. returned by the EndpointResolverFactory. By default the configured
  645. hostname and port are used.
  646. </summary>
  647. <param name="clientProvidedName">
  648. Application-specific connection name, will be displayed in the management UI
  649. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  650. be used as a connection identifier, e.g. in HTTP API requests.
  651. This value is supposed to be human-readable.
  652. </param>
  653. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  654. When the configured hostname was not reachable.
  655. </exception>
  656. </member>
  657. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(System.Collections.Generic.IList{System.String})">
  658. <summary>
  659. Create a connection using a list of hostnames using the configured port.
  660. By default each hostname is tried in a random order until a successful connection is
  661. found or the list is exhausted using the DefaultEndpointResolver.
  662. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  663. </summary>
  664. <param name="hostnames">
  665. List of hostnames to use for the initial
  666. connection and recovery.
  667. </param>
  668. <returns>Open connection</returns>
  669. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  670. When no hostname was reachable.
  671. </exception>
  672. </member>
  673. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(System.Collections.Generic.IList{System.String},System.String)">
  674. <summary>
  675. Create a connection using a list of hostnames using the configured port.
  676. By default each endpoint is tried in a random order until a successful connection is
  677. found or the list is exhausted.
  678. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  679. </summary>
  680. <param name="hostnames">
  681. List of hostnames to use for the initial
  682. connection and recovery.
  683. </param>
  684. <param name="clientProvidedName">
  685. Application-specific connection name, will be displayed in the management UI
  686. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  687. be used as a connection identifier, e.g. in HTTP API requests.
  688. This value is supposed to be human-readable.
  689. </param>
  690. <returns>Open connection</returns>
  691. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  692. When no hostname was reachable.
  693. </exception>
  694. </member>
  695. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(System.Collections.Generic.IList{RabbitMQ.Client.AmqpTcpEndpoint})">
  696. <summary>
  697. Create a connection using a list of endpoints. By default each endpoint will be tried
  698. in a random order until a successful connection is found or the list is exhausted.
  699. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  700. </summary>
  701. <param name="endpoints">
  702. List of endpoints to use for the initial
  703. connection and recovery.
  704. </param>
  705. <returns>Open connection</returns>
  706. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  707. When no hostname was reachable.
  708. </exception>
  709. </member>
  710. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(System.Collections.Generic.IList{RabbitMQ.Client.AmqpTcpEndpoint},System.String)">
  711. <summary>
  712. Create a connection using a list of endpoints. By default each endpoint will be tried
  713. in a random order until a successful connection is found or the list is exhausted.
  714. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  715. </summary>
  716. <param name="endpoints">
  717. List of endpoints to use for the initial
  718. connection and recovery.
  719. </param>
  720. <param name="clientProvidedName">
  721. Application-specific connection name, will be displayed in the management UI
  722. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  723. be used as a connection identifier, e.g. in HTTP API requests.
  724. This value is supposed to be human-readable.
  725. </param>
  726. <returns>Open connection</returns>
  727. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  728. When no hostname was reachable.
  729. </exception>
  730. </member>
  731. <member name="M:RabbitMQ.Client.ConnectionFactory.CreateConnection(RabbitMQ.Client.IEndpointResolver,System.String)">
  732. <summary>
  733. Create a connection using an IEndpointResolver.
  734. </summary>
  735. <param name="endpointResolver">
  736. The endpointResolver that returns the endpoints to use for the connection attempt.
  737. </param>
  738. <param name="clientProvidedName">
  739. Application-specific connection name, will be displayed in the management UI
  740. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  741. be used as a connection identifier, e.g. in HTTP API requests.
  742. This value is supposed to be human-readable.
  743. </param>
  744. <returns>Open connection</returns>
  745. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  746. When no hostname was reachable.
  747. </exception>
  748. </member>
  749. <member name="M:RabbitMQ.Client.ConnectionFactory.UriDecode(System.String)">
  750. <summary>
  751. Unescape a string, protecting '+'.
  752. </summary>
  753. </member>
  754. <member name="F:RabbitMQ.Client.ConnectionFactoryBase.SocketFactory">
  755. <summary>
  756. Set custom socket options by providing a SocketFactory.
  757. </summary>
  758. </member>
  759. <member name="M:RabbitMQ.Client.ConnectionFactoryBase.DefaultSocketFactory(System.Net.Sockets.AddressFamily)">
  760. <summary>
  761. Creates a new instance of the <see cref="T:System.Net.Sockets.TcpClient"/>.
  762. </summary>
  763. <param name="addressFamily">Specifies the addressing scheme.</param>
  764. <returns>New instance of a <see cref="T:System.Net.Sockets.TcpClient"/>.</returns>
  765. </member>
  766. <member name="T:RabbitMQ.Client.DefaultBasicConsumer">
  767. <summary>
  768. Useful default/base implementation of <see cref="T:RabbitMQ.Client.IBasicConsumer"/>.
  769. Subclass and override <see cref="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})"/> in application code.
  770. </summary>
  771. <remarks>
  772. Note that the "Handle*" methods run in the connection's thread!
  773. Consider using <see cref="T:RabbitMQ.Client.Events.EventingBasicConsumer"/>, which exposes
  774. events that can be subscribed to consumer messages.
  775. </remarks>
  776. </member>
  777. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.#ctor">
  778. <summary>
  779. Creates a new instance of an <see cref="T:RabbitMQ.Client.DefaultBasicConsumer"/>.
  780. </summary>
  781. </member>
  782. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.#ctor(RabbitMQ.Client.IModel)">
  783. <summary>
  784. Constructor which sets the Model property to the given value.
  785. </summary>
  786. <param name="model">Common AMQP model.</param>
  787. </member>
  788. <member name="P:RabbitMQ.Client.DefaultBasicConsumer.ConsumerTags">
  789. <summary>
  790. Retrieve the consumer tags this consumer is registered as; to be used to identify
  791. this consumer, for example, when cancelling it with <see cref="M:RabbitMQ.Client.IModel.BasicCancel(System.String)"/>.
  792. This value is an array because a single consumer instance can be reused to consume on
  793. multiple channels.
  794. </summary>
  795. </member>
  796. <member name="P:RabbitMQ.Client.DefaultBasicConsumer.IsRunning">
  797. <summary>
  798. Returns true while the consumer is registered and expecting deliveries from the broker.
  799. </summary>
  800. </member>
  801. <member name="P:RabbitMQ.Client.DefaultBasicConsumer.ShutdownReason">
  802. <summary>
  803. If our <see cref="T:RabbitMQ.Client.IModel"/> shuts down, this property will contain a description of the reason for the
  804. shutdown. Otherwise it will contain null. See <see cref="T:RabbitMQ.Client.ShutdownEventArgs"/>.
  805. </summary>
  806. </member>
  807. <member name="E:RabbitMQ.Client.DefaultBasicConsumer.ConsumerCancelled">
  808. <summary>
  809. Signalled when the consumer gets cancelled.
  810. </summary>
  811. </member>
  812. <member name="P:RabbitMQ.Client.DefaultBasicConsumer.Model">
  813. <summary>
  814. Retrieve the <see cref="T:RabbitMQ.Client.IModel"/> this consumer is associated with,
  815. for use in acknowledging received messages, for instance.
  816. </summary>
  817. </member>
  818. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicCancel(System.String)">
  819. <summary>
  820. Called when the consumer is cancelled for reasons other than by a basicCancel:
  821. e.g. the queue has been deleted (either by this channel or by any other channel).
  822. See <see cref="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicCancelOk(System.String)"/> for notification of consumer cancellation due to basicCancel
  823. </summary>
  824. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  825. </member>
  826. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicCancelOk(System.String)">
  827. <summary>
  828. Called upon successful deregistration of the consumer from the broker.
  829. </summary>
  830. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  831. </member>
  832. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicConsumeOk(System.String)">
  833. <summary>
  834. Called upon successful registration of the consumer with the broker.
  835. </summary>
  836. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  837. </member>
  838. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  839. <summary>
  840. Called each time a message is delivered for this consumer.
  841. </summary>
  842. <remarks>
  843. This is a no-op implementation. It will not acknowledge deliveries via <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>
  844. if consuming in automatic acknowledgement mode.
  845. Subclasses must copy or fully use delivery body before returning.
  846. Accessing the body at a later point is unsafe as its memory can
  847. be already released.
  848. </remarks>
  849. </member>
  850. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  851. <summary>
  852. Called when the model (channel) this consumer was registered on terminates.
  853. </summary>
  854. <param name="model">A channel this consumer was registered on.</param>
  855. <param name="reason">Shutdown context.</param>
  856. </member>
  857. <member name="M:RabbitMQ.Client.DefaultBasicConsumer.OnCancel(System.String[])">
  858. <summary>
  859. Default implementation - overridable in subclasses.</summary>
  860. <param name="consumerTags">The set of consumer tags that where cancelled</param>
  861. <remarks>
  862. This default implementation simply sets the <see cref="P:RabbitMQ.Client.DefaultBasicConsumer.IsRunning"/>
  863. property to false, and takes no further action.
  864. </remarks>
  865. </member>
  866. <member name="T:RabbitMQ.Client.ExchangeType">
  867. <summary>
  868. Convenience class providing compile-time names for standard exchange types.
  869. </summary>
  870. <remarks>
  871. Use the static members of this class as values for the
  872. "exchangeType" arguments for IModel methods such as
  873. ExchangeDeclare. The broker may be extended with additional
  874. exchange types that do not appear in this class.
  875. </remarks>
  876. </member>
  877. <member name="F:RabbitMQ.Client.ExchangeType.Direct">
  878. <summary>
  879. Exchange type used for AMQP direct exchanges.
  880. </summary>
  881. </member>
  882. <member name="F:RabbitMQ.Client.ExchangeType.Fanout">
  883. <summary>
  884. Exchange type used for AMQP fanout exchanges.
  885. </summary>
  886. </member>
  887. <member name="F:RabbitMQ.Client.ExchangeType.Headers">
  888. <summary>
  889. Exchange type used for AMQP headers exchanges.
  890. </summary>
  891. </member>
  892. <member name="F:RabbitMQ.Client.ExchangeType.Topic">
  893. <summary>
  894. Exchange type used for AMQP topic exchanges.
  895. </summary>
  896. </member>
  897. <member name="M:RabbitMQ.Client.ExchangeType.All">
  898. <summary>
  899. Retrieve a collection containing all standard exchange types.
  900. </summary>
  901. </member>
  902. <member name="M:RabbitMQ.Client.ExternalMechanism.handleChallenge(System.Byte[],RabbitMQ.Client.IConnectionFactory)">
  903. <summary>
  904. Handle one round of challenge-response.
  905. </summary>
  906. </member>
  907. <member name="P:RabbitMQ.Client.ExternalMechanismFactory.Name">
  908. <summary>
  909. The name of the authentication mechanism, as negotiated on the wire.
  910. </summary>
  911. </member>
  912. <member name="M:RabbitMQ.Client.ExternalMechanismFactory.GetInstance">
  913. <summary>
  914. Return a new authentication mechanism implementation.
  915. </summary>
  916. </member>
  917. <member name="T:RabbitMQ.Client.Headers">
  918. <summary>
  919. Convenience class providing compile-time names for standard headers.
  920. </summary>
  921. <remarks>
  922. Use the static members of this class as headers for the
  923. arguments for Queue and Exchange declaration or Consumer creation.
  924. The broker may be extended with additional
  925. headers that do not appear in this class.
  926. </remarks>
  927. </member>
  928. <member name="F:RabbitMQ.Client.Headers.XMaxPriority">
  929. <summary>
  930. x-max-priority header
  931. </summary>
  932. </member>
  933. <member name="F:RabbitMQ.Client.Headers.XMaxLength">
  934. <summary>
  935. x-max-length header
  936. </summary>
  937. </member>
  938. <member name="F:RabbitMQ.Client.Headers.XMaxLengthInBytes">
  939. <summary>
  940. x-max-length-bytes header
  941. </summary>
  942. </member>
  943. <member name="F:RabbitMQ.Client.Headers.XDeadLetterExchange">
  944. <summary>
  945. x-dead-letter-exchange header
  946. </summary>
  947. </member>
  948. <member name="F:RabbitMQ.Client.Headers.XDeadLetterRoutingKey">
  949. <summary>
  950. x-dead-letter-routing-key header
  951. </summary>
  952. </member>
  953. <member name="F:RabbitMQ.Client.Headers.XMessageTTL">
  954. <summary>
  955. x-message-ttl header
  956. </summary>
  957. </member>
  958. <member name="F:RabbitMQ.Client.Headers.XExpires">
  959. <summary>
  960. x-expires header
  961. </summary>
  962. </member>
  963. <member name="F:RabbitMQ.Client.Headers.AlternateExchange">
  964. <summary>
  965. alternate-exchange header
  966. </summary>
  967. </member>
  968. <member name="F:RabbitMQ.Client.Headers.XPriority">
  969. <summary>
  970. x-priority header
  971. </summary>
  972. </member>
  973. <member name="F:RabbitMQ.Client.Headers.XQueueMode">
  974. <summary>
  975. x-queue-mode header.
  976. Available modes: "default" and "lazy"
  977. </summary>
  978. </member>
  979. <member name="F:RabbitMQ.Client.Headers.XQueueType">
  980. <summary>
  981. x-queue-type header.
  982. Available types: "quorum" and "classic"(default)
  983. </summary>
  984. </member>
  985. <member name="F:RabbitMQ.Client.Headers.XQuorumInitialGroupSize">
  986. <summary>
  987. x-quorum-initial-group-size header.
  988. Use to control the number of quorum queue members
  989. </summary>
  990. </member>
  991. <member name="F:RabbitMQ.Client.Headers.XSingleActiveConsumer">
  992. <summary>
  993. x-single-active-consumer header.
  994. Available modes: true and false(default).
  995. Allows to have only one consumer at a time consuming from a queue
  996. and to fail over to another registered consumer in case the active one is cancelled or dies
  997. </summary>
  998. </member>
  999. <member name="F:RabbitMQ.Client.Headers.XOverflow">
  1000. <summary>
  1001. x-overflow header.
  1002. Available strategies: "reject-publish" and "drop-head"(default).
  1003. Allows to configure strategy when <see cref="F:RabbitMQ.Client.Headers.XMaxLength"/> or <see cref="F:RabbitMQ.Client.Headers.XMaxLengthInBytes"/> hits limits
  1004. </summary>
  1005. </member>
  1006. <member name="P:RabbitMQ.Client.IAsyncBasicConsumer.Model">
  1007. <summary>
  1008. Retrieve the <see cref="T:RabbitMQ.Client.IModel"/> this consumer is associated with,
  1009. for use in acknowledging received messages, for instance.
  1010. </summary>
  1011. </member>
  1012. <member name="E:RabbitMQ.Client.IAsyncBasicConsumer.ConsumerCancelled">
  1013. <summary>
  1014. Signalled when the consumer gets cancelled.
  1015. </summary>
  1016. </member>
  1017. <member name="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleBasicCancel(System.String)">
  1018. <summary>
  1019. Called when the consumer is cancelled for reasons other than by a basicCancel:
  1020. e.g. the queue has been deleted (either by this channel or by any other channel).
  1021. See <see cref="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleBasicCancelOk(System.String)"/> for notification of consumer cancellation due to basicCancel
  1022. </summary>
  1023. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1024. </member>
  1025. <member name="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleBasicCancelOk(System.String)">
  1026. <summary>
  1027. Called upon successful deregistration of the consumer from the broker.
  1028. </summary>
  1029. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1030. </member>
  1031. <member name="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleBasicConsumeOk(System.String)">
  1032. <summary>
  1033. Called upon successful registration of the consumer with the broker.
  1034. </summary>
  1035. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1036. </member>
  1037. <member name="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  1038. <summary>
  1039. Called each time a message arrives for this consumer.
  1040. </summary>
  1041. <remarks>
  1042. Does nothing with the passed in information.
  1043. Note that in particular, some delivered messages may require acknowledgement via <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>.
  1044. The implementation of this method in this class does NOT acknowledge such messages.
  1045. </remarks>
  1046. </member>
  1047. <member name="M:RabbitMQ.Client.IAsyncBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  1048. <summary>
  1049. Called when the model shuts down.
  1050. </summary>
  1051. <param name="model"> Common AMQP model.</param>
  1052. <param name="reason"> Information about the reason why a particular model, session, or connection was destroyed.</param>
  1053. </member>
  1054. <member name="T:RabbitMQ.Client.IAsyncConnectionFactory">
  1055. <summary>
  1056. Defines a connection factory capable of using an asynchronous consumer dispatcher which is compatible with <see cref="T:RabbitMQ.Client.IAsyncBasicConsumer"/>.
  1057. </summary>
  1058. <seealso cref="T:RabbitMQ.Client.IConnectionFactory" />
  1059. </member>
  1060. <member name="P:RabbitMQ.Client.IAsyncConnectionFactory.DispatchConsumersAsync">
  1061. <summary>
  1062. Gets or sets a value indicating whether an asynchronous consumer dispatcher which is compatible with <see cref="T:RabbitMQ.Client.IAsyncBasicConsumer"/> is used.
  1063. </summary>
  1064. <value><see langword="true" /> if an asynchronous consumer dispatcher which is compatible with <see cref="T:RabbitMQ.Client.IAsyncBasicConsumer"/> is used; otherwise, <see langword="false" />.</value>
  1065. </member>
  1066. <member name="T:RabbitMQ.Client.IAuthMechanism">
  1067. <summary>
  1068. A pluggable authentication mechanism.
  1069. </summary>
  1070. </member>
  1071. <member name="M:RabbitMQ.Client.IAuthMechanism.handleChallenge(System.Byte[],RabbitMQ.Client.IConnectionFactory)">
  1072. <summary>
  1073. Handle one round of challenge-response.
  1074. </summary>
  1075. </member>
  1076. <member name="P:RabbitMQ.Client.IAuthMechanismFactory.Name">
  1077. <summary>
  1078. The name of the authentication mechanism, as negotiated on the wire.
  1079. </summary>
  1080. </member>
  1081. <member name="M:RabbitMQ.Client.IAuthMechanismFactory.GetInstance">
  1082. <summary>
  1083. Return a new authentication mechanism implementation.
  1084. </summary>
  1085. </member>
  1086. <member name="T:RabbitMQ.Client.IAutorecoveringConnection">
  1087. <summary>
  1088. Interface to an auto-recovering AMQP connection.
  1089. </summary>
  1090. </member>
  1091. <member name="T:RabbitMQ.Client.IBasicConsumer">
  1092. <summary>Consumer interface. Used to
  1093. receive messages from a queue by subscription.</summary>
  1094. <remarks>
  1095. <para>
  1096. See IModel.BasicConsume, IModel.BasicCancel.
  1097. </para>
  1098. <para>
  1099. Note that the "Handle*" methods run in the connection's
  1100. thread! Consider using <see cref="T:RabbitMQ.Client.Events.EventingBasicConsumer"/>, which uses a
  1101. SharedQueue instance to safely pass received messages across
  1102. to user threads.
  1103. </para>
  1104. </remarks>
  1105. </member>
  1106. <member name="P:RabbitMQ.Client.IBasicConsumer.Model">
  1107. <summary>
  1108. Retrieve the <see cref="T:RabbitMQ.Client.IModel"/> this consumer is associated with,
  1109. for use in acknowledging received messages, for instance.
  1110. </summary>
  1111. </member>
  1112. <member name="E:RabbitMQ.Client.IBasicConsumer.ConsumerCancelled">
  1113. <summary>
  1114. Signalled when the consumer gets cancelled.
  1115. </summary>
  1116. </member>
  1117. <member name="M:RabbitMQ.Client.IBasicConsumer.HandleBasicCancel(System.String)">
  1118. <summary>
  1119. Called when the consumer is cancelled for reasons other than by a basicCancel:
  1120. e.g. the queue has been deleted (either by this channel or by any other channel).
  1121. See <see cref="M:RabbitMQ.Client.IBasicConsumer.HandleBasicCancelOk(System.String)"/> for notification of consumer cancellation due to basicCancel
  1122. </summary>
  1123. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1124. </member>
  1125. <member name="M:RabbitMQ.Client.IBasicConsumer.HandleBasicCancelOk(System.String)">
  1126. <summary>
  1127. Called upon successful deregistration of the consumer from the broker.
  1128. </summary>
  1129. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1130. </member>
  1131. <member name="M:RabbitMQ.Client.IBasicConsumer.HandleBasicConsumeOk(System.String)">
  1132. <summary>
  1133. Called upon successful registration of the consumer with the broker.
  1134. </summary>
  1135. <param name="consumerTag">Consumer tag this consumer is registered.</param>
  1136. </member>
  1137. <member name="M:RabbitMQ.Client.IBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  1138. <summary>
  1139. Called each time a message arrives for this consumer.
  1140. </summary>
  1141. <remarks>
  1142. Does nothing with the passed in information.
  1143. Note that in particular, some delivered messages may require acknowledgement via <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>.
  1144. The implementation of this method in this class does NOT acknowledge such messages.
  1145. </remarks>
  1146. </member>
  1147. <member name="M:RabbitMQ.Client.IBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  1148. <summary>
  1149. Called when the model shuts down.
  1150. </summary>
  1151. <param name="model"> Common AMQP model.</param>
  1152. <param name="reason"> Information about the reason why a particular model, session, or connection was destroyed.</param>
  1153. </member>
  1154. <member name="T:RabbitMQ.Client.IBasicProperties">
  1155. <summary>Common AMQP Basic content-class headers interface,
  1156. spanning the union of the functionality offered by versions
  1157. 0-8, 0-8qpid, 0-9 and 0-9-1 of AMQP.</summary>
  1158. <remarks>
  1159. <para>
  1160. The specification code generator provides
  1161. protocol-version-specific implementations of this interface. To
  1162. obtain an implementation of this interface in a
  1163. protocol-version-neutral way, use <see cref="M:RabbitMQ.Client.IModel.CreateBasicProperties"/>.
  1164. </para>
  1165. <para>
  1166. Each property is readable, writable and clearable: a cleared
  1167. property will not be transmitted over the wire. Properties on a
  1168. fresh instance are clear by default.
  1169. </para>
  1170. </remarks>
  1171. </member>
  1172. <member name="P:RabbitMQ.Client.IBasicProperties.AppId">
  1173. <summary>
  1174. Application Id.
  1175. </summary>
  1176. </member>
  1177. <member name="P:RabbitMQ.Client.IBasicProperties.ClusterId">
  1178. <summary>
  1179. Intra-cluster routing identifier (cluster id is deprecated in AMQP 0-9-1).
  1180. </summary>
  1181. </member>
  1182. <member name="P:RabbitMQ.Client.IBasicProperties.ContentEncoding">
  1183. <summary>
  1184. MIME content encoding.
  1185. </summary>
  1186. </member>
  1187. <member name="P:RabbitMQ.Client.IBasicProperties.ContentType">
  1188. <summary>
  1189. MIME content type.
  1190. </summary>
  1191. </member>
  1192. <member name="P:RabbitMQ.Client.IBasicProperties.CorrelationId">
  1193. <summary>
  1194. Application correlation identifier.
  1195. </summary>
  1196. </member>
  1197. <member name="P:RabbitMQ.Client.IBasicProperties.DeliveryMode">
  1198. <summary>
  1199. Non-persistent (1) or persistent (2).
  1200. </summary>
  1201. </member>
  1202. <member name="P:RabbitMQ.Client.IBasicProperties.Expiration">
  1203. <summary>
  1204. Message expiration specification.
  1205. </summary>
  1206. </member>
  1207. <member name="P:RabbitMQ.Client.IBasicProperties.Headers">
  1208. <summary>
  1209. Message header field table. Is of type <see cref="T:System.Collections.Generic.IDictionary`2" />.
  1210. </summary>
  1211. </member>
  1212. <member name="P:RabbitMQ.Client.IBasicProperties.MessageId">
  1213. <summary>
  1214. Application message Id.
  1215. </summary>
  1216. </member>
  1217. <member name="P:RabbitMQ.Client.IBasicProperties.Persistent">
  1218. <summary>
  1219. Sets <see cref="P:RabbitMQ.Client.IBasicProperties.DeliveryMode"/> to either persistent (2) or non-persistent (1).
  1220. </summary>
  1221. </member>
  1222. <member name="P:RabbitMQ.Client.IBasicProperties.Priority">
  1223. <summary>
  1224. Message priority, 0 to 9.
  1225. </summary>
  1226. </member>
  1227. <member name="P:RabbitMQ.Client.IBasicProperties.ReplyTo">
  1228. <summary>
  1229. Destination to reply to.
  1230. </summary>
  1231. </member>
  1232. <member name="P:RabbitMQ.Client.IBasicProperties.ReplyToAddress">
  1233. <summary>
  1234. Convenience property; parses <see cref="P:RabbitMQ.Client.IBasicProperties.ReplyTo"/> property using <see cref="M:RabbitMQ.Client.PublicationAddress.TryParse(System.String,RabbitMQ.Client.PublicationAddress@)"/>,
  1235. and serializes it using <see cref="M:RabbitMQ.Client.PublicationAddress.ToString"/>.
  1236. Returns null if <see cref="P:RabbitMQ.Client.IBasicProperties.ReplyTo"/> property cannot be parsed by <see cref="M:RabbitMQ.Client.PublicationAddress.TryParse(System.String,RabbitMQ.Client.PublicationAddress@)"/>.
  1237. </summary>
  1238. </member>
  1239. <member name="P:RabbitMQ.Client.IBasicProperties.Timestamp">
  1240. <summary>
  1241. Message timestamp.
  1242. </summary>
  1243. </member>
  1244. <member name="P:RabbitMQ.Client.IBasicProperties.Type">
  1245. <summary>
  1246. Message type name.
  1247. </summary>
  1248. </member>
  1249. <member name="P:RabbitMQ.Client.IBasicProperties.UserId">
  1250. <summary>
  1251. User Id.
  1252. </summary>
  1253. </member>
  1254. <member name="M:RabbitMQ.Client.IBasicProperties.ClearAppId">
  1255. <summary>
  1256. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.AppId"/> property.
  1257. </summary>
  1258. </member>
  1259. <member name="M:RabbitMQ.Client.IBasicProperties.ClearClusterId">
  1260. <summary>
  1261. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.ClusterId"/> property (cluster id is deprecated in AMQP 0-9-1).
  1262. </summary>
  1263. </member>
  1264. <member name="M:RabbitMQ.Client.IBasicProperties.ClearContentEncoding">
  1265. <summary>
  1266. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.ContentEncoding"/> property.
  1267. </summary>
  1268. </member>
  1269. <member name="M:RabbitMQ.Client.IBasicProperties.ClearContentType">
  1270. <summary>
  1271. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.ContentType"/> property.
  1272. </summary>
  1273. </member>
  1274. <member name="M:RabbitMQ.Client.IBasicProperties.ClearCorrelationId">
  1275. <summary>
  1276. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.CorrelationId"/> property.
  1277. </summary>
  1278. </member>
  1279. <member name="M:RabbitMQ.Client.IBasicProperties.ClearDeliveryMode">
  1280. <summary>
  1281. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.DeliveryMode"/> property.
  1282. </summary>
  1283. </member>
  1284. <member name="M:RabbitMQ.Client.IBasicProperties.ClearExpiration">
  1285. <summary>
  1286. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.Expiration"/> property.
  1287. </summary>
  1288. </member>
  1289. <member name="M:RabbitMQ.Client.IBasicProperties.ClearHeaders">
  1290. <summary>
  1291. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.Headers"/> property.
  1292. </summary>
  1293. </member>
  1294. <member name="M:RabbitMQ.Client.IBasicProperties.ClearMessageId">
  1295. <summary>
  1296. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.MessageId"/> property.
  1297. </summary>
  1298. </member>
  1299. <member name="M:RabbitMQ.Client.IBasicProperties.ClearPriority">
  1300. <summary>
  1301. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.Priority"/> property.
  1302. </summary>
  1303. </member>
  1304. <member name="M:RabbitMQ.Client.IBasicProperties.ClearReplyTo">
  1305. <summary>
  1306. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.ReplyTo"/> property.
  1307. </summary>
  1308. </member>
  1309. <member name="M:RabbitMQ.Client.IBasicProperties.ClearTimestamp">
  1310. <summary>
  1311. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.Timestamp"/> property.
  1312. </summary>
  1313. </member>
  1314. <member name="M:RabbitMQ.Client.IBasicProperties.ClearType">
  1315. <summary>
  1316. Clear the Type property.
  1317. </summary>
  1318. </member>
  1319. <member name="M:RabbitMQ.Client.IBasicProperties.ClearUserId">
  1320. <summary>
  1321. Clear the <see cref="P:RabbitMQ.Client.IBasicProperties.UserId"/> property.
  1322. </summary>
  1323. </member>
  1324. <member name="M:RabbitMQ.Client.IBasicProperties.IsAppIdPresent">
  1325. <summary>
  1326. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.AppId"/> property is present.
  1327. </summary>
  1328. </member>
  1329. <member name="M:RabbitMQ.Client.IBasicProperties.IsClusterIdPresent">
  1330. <summary>
  1331. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.ClusterId"/> property is present (cluster id is deprecated in AMQP 0-9-1).
  1332. </summary>
  1333. </member>
  1334. <member name="M:RabbitMQ.Client.IBasicProperties.IsContentEncodingPresent">
  1335. <summary>
  1336. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.ContentEncoding"/> property is present.
  1337. </summary>
  1338. </member>
  1339. <member name="M:RabbitMQ.Client.IBasicProperties.IsContentTypePresent">
  1340. <summary>
  1341. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.ContentType"/> property is present.
  1342. </summary>
  1343. </member>
  1344. <member name="M:RabbitMQ.Client.IBasicProperties.IsCorrelationIdPresent">
  1345. <summary>
  1346. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.CorrelationId"/> property is present.
  1347. </summary>
  1348. </member>
  1349. <member name="M:RabbitMQ.Client.IBasicProperties.IsDeliveryModePresent">
  1350. <summary>
  1351. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.DeliveryMode"/> property is present.
  1352. </summary>
  1353. </member>
  1354. <member name="M:RabbitMQ.Client.IBasicProperties.IsExpirationPresent">
  1355. <summary>
  1356. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.Expiration"/> property is present.
  1357. </summary>
  1358. </member>
  1359. <member name="M:RabbitMQ.Client.IBasicProperties.IsHeadersPresent">
  1360. <summary>
  1361. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.Headers"/> property is present.
  1362. </summary>
  1363. </member>
  1364. <member name="M:RabbitMQ.Client.IBasicProperties.IsMessageIdPresent">
  1365. <summary>
  1366. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.MessageId"/> property is present.
  1367. </summary>
  1368. </member>
  1369. <member name="M:RabbitMQ.Client.IBasicProperties.IsPriorityPresent">
  1370. <summary>
  1371. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.Priority"/> property is present.
  1372. </summary>
  1373. </member>
  1374. <member name="M:RabbitMQ.Client.IBasicProperties.IsReplyToPresent">
  1375. <summary>
  1376. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.ReplyTo"/> property is present.
  1377. </summary>
  1378. </member>
  1379. <member name="M:RabbitMQ.Client.IBasicProperties.IsTimestampPresent">
  1380. <summary>
  1381. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.Timestamp"/> property is present.
  1382. </summary>
  1383. </member>
  1384. <member name="M:RabbitMQ.Client.IBasicProperties.IsTypePresent">
  1385. <summary>
  1386. Returns true if the Type property is present.
  1387. </summary>
  1388. </member>
  1389. <member name="M:RabbitMQ.Client.IBasicProperties.IsUserIdPresent">
  1390. <summary>
  1391. Returns true if the <see cref="P:RabbitMQ.Client.IBasicProperties.UserId"/> UserId property is present.
  1392. </summary>
  1393. </member>
  1394. <member name="T:RabbitMQ.Client.IConnection">
  1395. <summary>
  1396. Main interface to an AMQP connection.
  1397. </summary>
  1398. <remarks>
  1399. <para>
  1400. Instances of <see cref="T:RabbitMQ.Client.IConnection"/> are used to create fresh
  1401. sessions/channels. The <see cref="T:RabbitMQ.Client.ConnectionFactory"/> class is used to
  1402. construct <see cref="T:RabbitMQ.Client.IConnection"/> instances.
  1403. Please see the documentation for ConnectionFactory for an example of usage.
  1404. Alternatively, an API tutorial can be found in the User Guide.
  1405. </para>
  1406. <para>
  1407. Extends the <see cref="T:System.IDisposable"/> interface, so that the "using"
  1408. statement can be used to scope the lifetime of a channel when
  1409. appropriate.
  1410. </para>
  1411. </remarks>
  1412. </member>
  1413. <member name="P:RabbitMQ.Client.IConnection.ChannelMax">
  1414. <summary>
  1415. The maximum channel number this connection supports (0 if unlimited).
  1416. Usable channel numbers range from 1 to this number, inclusive.
  1417. </summary>
  1418. </member>
  1419. <member name="P:RabbitMQ.Client.IConnection.ClientProperties">
  1420. <summary>
  1421. A copy of the client properties that has been sent to the server.
  1422. </summary>
  1423. </member>
  1424. <member name="P:RabbitMQ.Client.IConnection.CloseReason">
  1425. <summary>
  1426. Returns null if the connection is still in a state
  1427. where it can be used, or the cause of its closure otherwise.
  1428. </summary>
  1429. <remarks>
  1430. <para>
  1431. Applications should use the ConnectionShutdown event to
  1432. avoid race conditions. The scenario to avoid is checking
  1433. <see cref="P:RabbitMQ.Client.IConnection.CloseReason"/>, seeing it is null (meaning the <see cref="T:RabbitMQ.Client.IConnection"/>
  1434. was available for use at the time of the check), and
  1435. interpreting this mistakenly as a guarantee that the
  1436. <see cref="T:RabbitMQ.Client.IConnection"/> will remain usable for a time. Instead, the
  1437. operation of interest should simply be attempted: if the
  1438. <see cref="T:RabbitMQ.Client.IConnection"/> is not in a usable state, an exception will be
  1439. thrown (most likely <see cref="T:RabbitMQ.Client.Exceptions.OperationInterruptedException"/>, but may
  1440. vary depending on the particular operation being attempted).
  1441. </para>
  1442. </remarks>
  1443. </member>
  1444. <member name="P:RabbitMQ.Client.IConnection.Endpoint">
  1445. <summary>
  1446. Retrieve the endpoint this connection is connected to.
  1447. </summary>
  1448. </member>
  1449. <member name="P:RabbitMQ.Client.IConnection.FrameMax">
  1450. <summary>
  1451. The maximum frame size this connection supports (0 if unlimited).
  1452. </summary>
  1453. </member>
  1454. <member name="P:RabbitMQ.Client.IConnection.Heartbeat">
  1455. <summary>
  1456. The current heartbeat setting for this connection (System.TimeSpan.Zero for disabled).
  1457. </summary>
  1458. </member>
  1459. <member name="P:RabbitMQ.Client.IConnection.IsOpen">
  1460. <summary>
  1461. Returns true if the connection is still in a state where it can be used.
  1462. Identical to checking if <see cref="P:RabbitMQ.Client.IConnection.CloseReason"/> equal null.
  1463. </summary>
  1464. </member>
  1465. <member name="P:RabbitMQ.Client.IConnection.KnownHosts">
  1466. <summary>
  1467. Returns the known hosts that came back from the
  1468. broker in the connection.open-ok method at connection
  1469. startup time. Null until the connection is completely open and ready for use.
  1470. </summary>
  1471. </member>
  1472. <member name="P:RabbitMQ.Client.IConnection.Protocol">
  1473. <summary>
  1474. The <see cref="T:RabbitMQ.Client.IProtocol"/> this connection is using to communicate with its peer.
  1475. </summary>
  1476. </member>
  1477. <member name="P:RabbitMQ.Client.IConnection.ServerProperties">
  1478. <summary>
  1479. A dictionary of the server properties sent by the server while establishing the connection.
  1480. This typically includes the product name and version of the server.
  1481. </summary>
  1482. </member>
  1483. <member name="P:RabbitMQ.Client.IConnection.ShutdownReport">
  1484. <summary>
  1485. Returns the list of <see cref="T:RabbitMQ.Client.ShutdownReportEntry"/> objects that contain information
  1486. about any errors reported while closing the connection in the order they appeared
  1487. </summary>
  1488. </member>
  1489. <member name="P:RabbitMQ.Client.IConnection.ClientProvidedName">
  1490. <summary>
  1491. Application-specific connection name, will be displayed in the management UI
  1492. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  1493. be used as a connection identifier, e.g. in HTTP API requests.
  1494. This value is supposed to be human-readable.
  1495. </summary>
  1496. </member>
  1497. <member name="E:RabbitMQ.Client.IConnection.CallbackException">
  1498. <summary>
  1499. Signalled when an exception occurs in a callback invoked by the connection.
  1500. </summary>
  1501. <remarks>
  1502. This event is signalled when a ConnectionShutdown handler
  1503. throws an exception. If, in future, more events appear on
  1504. <see cref="T:RabbitMQ.Client.IConnection"/>, then this event will be signalled whenever one
  1505. of those event handlers throws an exception, as well.
  1506. </remarks>
  1507. </member>
  1508. <member name="E:RabbitMQ.Client.IConnection.ConnectionShutdown">
  1509. <summary>
  1510. Raised when the connection is destroyed.
  1511. </summary>
  1512. <remarks>
  1513. If the connection is already destroyed at the time an
  1514. event handler is added to this event, the event handler
  1515. will be fired immediately.
  1516. </remarks>
  1517. </member>
  1518. <member name="M:RabbitMQ.Client.IConnection.UpdateSecret(System.String,System.String)">
  1519. <summary>
  1520. This method updates the secret used to authenticate this connection.
  1521. It is used when secrets have an expiration date and need to be renewed,
  1522. like OAuth 2 tokens.
  1523. </summary>
  1524. <param name="newSecret">The new secret.</param>
  1525. <param name="reason">The reason for the secret update.</param>
  1526. </member>
  1527. <member name="M:RabbitMQ.Client.IConnection.Abort">
  1528. <summary>
  1529. Abort this connection and all its channels.
  1530. </summary>
  1531. <remarks>
  1532. Note that all active channels, sessions, and models will be closed if this method is called.
  1533. In comparison to normal <see cref="M:RabbitMQ.Client.IConnection.Close"/> method, <see cref="M:RabbitMQ.Client.IConnection.Abort"/> will not throw
  1534. <see cref="T:System.IO.IOException"/> during closing connection.
  1535. This method waits infinitely for the in-progress close operation to complete.
  1536. </remarks>
  1537. </member>
  1538. <member name="M:RabbitMQ.Client.IConnection.Abort(System.UInt16,System.String)">
  1539. <summary>
  1540. Abort this connection and all its channels.
  1541. </summary>
  1542. <remarks>
  1543. The method behaves in the same way as <see cref="M:RabbitMQ.Client.IConnection.Abort"/>, with the only
  1544. difference that the connection is closed with the given connection close code and message.
  1545. <para>
  1546. The close code (See under "Reply Codes" in the AMQP 0-9-1 specification)
  1547. </para>
  1548. <para>
  1549. A message indicating the reason for closing the connection
  1550. </para>
  1551. </remarks>
  1552. </member>
  1553. <member name="M:RabbitMQ.Client.IConnection.Abort(System.TimeSpan)">
  1554. <summary>
  1555. Abort this connection and all its channels and wait with a
  1556. timeout for all the in-progress close operations to complete.
  1557. </summary>
  1558. <remarks>
  1559. This method, behaves in a similar way as method <see cref="M:RabbitMQ.Client.IConnection.Abort"/> with the
  1560. only difference that it explictly specifies a timeout given
  1561. for all the in-progress close operations to complete.
  1562. If timeout is reached and the close operations haven't finished, then socket is forced to close.
  1563. <para>
  1564. To wait infinitely for the close operations to complete use <see cref="F:System.Threading.Timeout.Infinite"/>.
  1565. </para>
  1566. </remarks>
  1567. </member>
  1568. <member name="M:RabbitMQ.Client.IConnection.Abort(System.UInt16,System.String,System.TimeSpan)">
  1569. <summary>
  1570. Abort this connection and all its channels and wait with a
  1571. timeout for all the in-progress close operations to complete.
  1572. </summary>
  1573. <remarks>
  1574. The method behaves in the same way as <see cref="M:RabbitMQ.Client.IConnection.Abort(System.TimeSpan)"/>, with the only
  1575. difference that the connection is closed with the given connection close code and message.
  1576. <para>
  1577. The close code (See under "Reply Codes" in the AMQP 0-9-1 specification).
  1578. </para>
  1579. <para>
  1580. A message indicating the reason for closing the connection.
  1581. </para>
  1582. </remarks>
  1583. </member>
  1584. <member name="M:RabbitMQ.Client.IConnection.Close">
  1585. <summary>
  1586. Close this connection and all its channels.
  1587. </summary>
  1588. <remarks>
  1589. Note that all active channels, sessions, and models will be
  1590. closed if this method is called. It will wait for the in-progress
  1591. close operation to complete. This method will not return to the caller
  1592. until the shutdown is complete. If the connection is already closed
  1593. (or closing), then this method will do nothing.
  1594. It can also throw <see cref="T:System.IO.IOException"/> when socket was closed unexpectedly.
  1595. </remarks>
  1596. </member>
  1597. <member name="M:RabbitMQ.Client.IConnection.Close(System.UInt16,System.String)">
  1598. <summary>
  1599. Close this connection and all its channels.
  1600. </summary>
  1601. <remarks>
  1602. The method behaves in the same way as <see cref="M:RabbitMQ.Client.IConnection.Close"/>, with the only
  1603. difference that the connection is closed with the given connection close code and message.
  1604. <para>
  1605. The close code (See under "Reply Codes" in the AMQP specification).
  1606. </para>
  1607. <para>
  1608. A message indicating the reason for closing the connection.
  1609. </para>
  1610. </remarks>
  1611. </member>
  1612. <member name="M:RabbitMQ.Client.IConnection.Close(System.TimeSpan)">
  1613. <summary>
  1614. Close this connection and all its channels
  1615. and wait with a timeout for all the in-progress close operations to complete.
  1616. </summary>
  1617. <remarks>
  1618. Note that all active channels, sessions, and models will be
  1619. closed if this method is called. It will wait for the in-progress
  1620. close operation to complete with a timeout. If the connection is
  1621. already closed (or closing), then this method will do nothing.
  1622. It can also throw <see cref="T:System.IO.IOException"/> when socket was closed unexpectedly.
  1623. If timeout is reached and the close operations haven't finished, then socket is forced to close.
  1624. <para>
  1625. To wait infinitely for the close operations to complete use <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/>.
  1626. </para>
  1627. </remarks>
  1628. </member>
  1629. <member name="M:RabbitMQ.Client.IConnection.Close(System.UInt16,System.String,System.TimeSpan)">
  1630. <summary>
  1631. Close this connection and all its channels
  1632. and wait with a timeout for all the in-progress close operations to complete.
  1633. </summary>
  1634. <remarks>
  1635. The method behaves in the same way as <see cref="M:RabbitMQ.Client.IConnection.Close(System.TimeSpan)"/>, with the only
  1636. difference that the connection is closed with the given connection close code and message.
  1637. <para>
  1638. The close code (See under "Reply Codes" in the AMQP 0-9-1 specification).
  1639. </para>
  1640. <para>
  1641. A message indicating the reason for closing the connection.
  1642. </para>
  1643. <para>
  1644. Operation timeout.
  1645. </para>
  1646. </remarks>
  1647. </member>
  1648. <member name="M:RabbitMQ.Client.IConnection.CreateModel">
  1649. <summary>
  1650. Create and return a fresh channel, session, and model.
  1651. </summary>
  1652. </member>
  1653. <member name="M:RabbitMQ.Client.IConnection.HandleConnectionBlocked(System.String)">
  1654. <summary>
  1655. Handle incoming Connection.Blocked methods.
  1656. </summary>
  1657. </member>
  1658. <member name="M:RabbitMQ.Client.IConnection.HandleConnectionUnblocked">
  1659. <summary>
  1660. Handle incoming Connection.Unblocked methods.
  1661. </summary>
  1662. </member>
  1663. <member name="P:RabbitMQ.Client.IConnectionFactory.ClientProperties">
  1664. <summary>
  1665. Dictionary of client properties to be sent to the server.
  1666. </summary>
  1667. </member>
  1668. <member name="P:RabbitMQ.Client.IConnectionFactory.Password">
  1669. <summary>
  1670. Password to use when authenticating to the server.
  1671. </summary>
  1672. </member>
  1673. <member name="P:RabbitMQ.Client.IConnectionFactory.RequestedChannelMax">
  1674. <summary>
  1675. Maximum channel number to ask for.
  1676. </summary>
  1677. </member>
  1678. <member name="P:RabbitMQ.Client.IConnectionFactory.RequestedFrameMax">
  1679. <summary>
  1680. Frame-max parameter to ask for (in bytes).
  1681. </summary>
  1682. </member>
  1683. <member name="P:RabbitMQ.Client.IConnectionFactory.RequestedHeartbeat">
  1684. <summary>
  1685. Heartbeat setting to request.
  1686. </summary>
  1687. </member>
  1688. <member name="P:RabbitMQ.Client.IConnectionFactory.UseBackgroundThreadsForIO">
  1689. <summary>
  1690. When set to true, background threads will be used for I/O and heartbeats.
  1691. </summary>
  1692. </member>
  1693. <member name="P:RabbitMQ.Client.IConnectionFactory.UserName">
  1694. <summary>
  1695. Username to use when authenticating to the server.
  1696. </summary>
  1697. </member>
  1698. <member name="P:RabbitMQ.Client.IConnectionFactory.VirtualHost">
  1699. <summary>
  1700. Virtual host to access during this connection.
  1701. </summary>
  1702. </member>
  1703. <member name="P:RabbitMQ.Client.IConnectionFactory.Uri">
  1704. <summary>
  1705. Sets or gets the AMQP Uri to be used for connections.
  1706. </summary>
  1707. </member>
  1708. <member name="P:RabbitMQ.Client.IConnectionFactory.ClientProvidedName">
  1709. <summary>
  1710. Default client provided name to be used for connections.
  1711. </summary>
  1712. </member>
  1713. <member name="M:RabbitMQ.Client.IConnectionFactory.AuthMechanismFactory(System.Collections.Generic.IList{System.String})">
  1714. <summary>
  1715. Given a list of mechanism names supported by the server, select a preferred mechanism,
  1716. or null if we have none in common.
  1717. </summary>
  1718. </member>
  1719. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection">
  1720. <summary>
  1721. Create a connection to the specified endpoint.
  1722. </summary>
  1723. </member>
  1724. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection(System.String)">
  1725. <summary>
  1726. Create a connection to the specified endpoint.
  1727. </summary>
  1728. <param name="clientProvidedName">
  1729. Application-specific connection name, will be displayed in the management UI
  1730. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  1731. be used as a connection identifier, e.g. in HTTP API requests.
  1732. This value is supposed to be human-readable.
  1733. </param>
  1734. <returns>Open connection</returns>
  1735. </member>
  1736. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection(System.Collections.Generic.IList{System.String})">
  1737. <summary>
  1738. Connects to the first reachable hostname from the list.
  1739. </summary>
  1740. <param name="hostnames">List of host names to use</param>
  1741. <returns>Open connection</returns>
  1742. </member>
  1743. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection(System.Collections.Generic.IList{System.String},System.String)">
  1744. <summary>
  1745. Connects to the first reachable hostname from the list.
  1746. </summary>
  1747. <param name="hostnames">List of host names to use</param>
  1748. <param name="clientProvidedName">
  1749. Application-specific connection name, will be displayed in the management UI
  1750. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  1751. be used as a connection identifier, e.g. in HTTP API requests.
  1752. This value is supposed to be human-readable.
  1753. </param>
  1754. <returns>Open connection</returns>
  1755. </member>
  1756. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection(System.Collections.Generic.IList{RabbitMQ.Client.AmqpTcpEndpoint})">
  1757. <summary>
  1758. Create a connection using a list of endpoints.
  1759. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  1760. </summary>
  1761. <param name="endpoints">
  1762. List of endpoints to use for the initial
  1763. connection and recovery.
  1764. </param>
  1765. <returns>Open connection</returns>
  1766. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  1767. When no hostname was reachable.
  1768. </exception>
  1769. </member>
  1770. <member name="M:RabbitMQ.Client.IConnectionFactory.CreateConnection(System.Collections.Generic.IList{RabbitMQ.Client.AmqpTcpEndpoint},System.String)">
  1771. <summary>
  1772. Create a connection using a list of endpoints.
  1773. The selection behaviour can be overridden by configuring the EndpointResolverFactory.
  1774. </summary>
  1775. <param name="endpoints">
  1776. List of endpoints to use for the initial
  1777. connection and recovery.
  1778. </param>
  1779. <param name="clientProvidedName">
  1780. Application-specific connection name, will be displayed in the management UI
  1781. if RabbitMQ server supports it. This value doesn't have to be unique and cannot
  1782. be used as a connection identifier, e.g. in HTTP API requests.
  1783. This value is supposed to be human-readable.
  1784. </param>
  1785. <returns>Open connection</returns>
  1786. <exception cref="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  1787. When no hostname was reachable.
  1788. </exception>
  1789. </member>
  1790. <member name="P:RabbitMQ.Client.IConnectionFactory.HandshakeContinuationTimeout">
  1791. <summary>
  1792. Amount of time protocol handshake operations are allowed to take before
  1793. timing out.
  1794. </summary>
  1795. </member>
  1796. <member name="P:RabbitMQ.Client.IConnectionFactory.ContinuationTimeout">
  1797. <summary>
  1798. Amount of time protocol operations (e.g. <code>queue.declare</code>) are allowed to take before
  1799. timing out.
  1800. </summary>
  1801. </member>
  1802. <member name="T:RabbitMQ.Client.IContentHeader">
  1803. <summary>
  1804. A decoded AMQP content header frame.
  1805. </summary>
  1806. </member>
  1807. <member name="P:RabbitMQ.Client.IContentHeader.ProtocolClassId">
  1808. <summary>
  1809. Retrieve the AMQP class ID of this content header.
  1810. </summary>
  1811. </member>
  1812. <member name="P:RabbitMQ.Client.IContentHeader.ProtocolClassName">
  1813. <summary>
  1814. Retrieve the AMQP class name of this content header.
  1815. </summary>
  1816. </member>
  1817. <member name="M:RabbitMQ.Client.IEndpointResolver.All">
  1818. <summary>
  1819. Return all AmqpTcpEndpoints in the order they should be tried.
  1820. </summary>
  1821. </member>
  1822. <member name="T:RabbitMQ.Client.IMethod">
  1823. <summary>
  1824. A decoded AMQP method frame.
  1825. </summary>
  1826. <remarks>
  1827. <para>
  1828. AMQP methods can be RPC requests, RPC responses, exceptions
  1829. (ChannelClose, ConnectionClose), or one-way asynchronous
  1830. messages. Currently this information is not recorded in their
  1831. type or interface: it is implicit in the way the method is
  1832. used, and the way it is defined in the AMQP specification. A
  1833. future revision of the RabbitMQ .NET client library may extend
  1834. the IMethod interface to represent this information
  1835. explicitly.
  1836. </para>
  1837. </remarks>
  1838. </member>
  1839. <member name="P:RabbitMQ.Client.IMethod.ProtocolClassId">
  1840. <summary>
  1841. Retrieves the class ID number of this method, as defined in the AMQP specification XML.
  1842. </summary>
  1843. </member>
  1844. <member name="P:RabbitMQ.Client.IMethod.ProtocolMethodId">
  1845. <summary>
  1846. Retrieves the method ID number of this method, as defined in the AMQP specification XML.
  1847. </summary>
  1848. </member>
  1849. <member name="P:RabbitMQ.Client.IMethod.ProtocolMethodName">
  1850. <summary>
  1851. Retrieves the name of this method - for debugging use.
  1852. </summary>
  1853. </member>
  1854. <member name="T:RabbitMQ.Client.IModel">
  1855. <summary>
  1856. Common AMQP model, spanning the union of the
  1857. functionality offered by versions 0-8, 0-8qpid, 0-9 and 0-9-1 of AMQP.
  1858. </summary>
  1859. <remarks>
  1860. Extends the <see cref="T:System.IDisposable"/> interface, so that the "using"
  1861. statement can be used to scope the lifetime of a channel when appropriate.
  1862. </remarks>
  1863. </member>
  1864. <member name="P:RabbitMQ.Client.IModel.ChannelNumber">
  1865. <summary>
  1866. Channel number, unique per connections.
  1867. </summary>
  1868. </member>
  1869. <member name="P:RabbitMQ.Client.IModel.CloseReason">
  1870. <summary>
  1871. Returns null if the session is still in a state where it can be used,
  1872. or the cause of its closure otherwise.
  1873. </summary>
  1874. </member>
  1875. <member name="P:RabbitMQ.Client.IModel.DefaultConsumer">
  1876. <summary>Signalled when an unexpected message is delivered
  1877. Under certain circumstances it is possible for a channel to receive a
  1878. message delivery which does not match any consumer which is currently
  1879. set up via basicConsume(). This will occur after the following sequence
  1880. of events:
  1881. ctag = basicConsume(queue, consumer); // i.e. with explicit acks
  1882. // some deliveries take place but are not acked
  1883. basicCancel(ctag);
  1884. basicRecover(false);
  1885. Since requeue is specified to be false in the basicRecover, the spec
  1886. states that the message must be redelivered to "the original recipient"
  1887. - i.e. the same channel / consumer-tag. But the consumer is no longer
  1888. active.
  1889. In these circumstances, you can register a default consumer to handle
  1890. such deliveries. If no default consumer is registered an
  1891. InvalidOperationException will be thrown when such a delivery arrives.
  1892. Most people will not need to use this.</summary>
  1893. </member>
  1894. <member name="P:RabbitMQ.Client.IModel.IsClosed">
  1895. <summary>
  1896. Returns true if the model is no longer in a state where it can be used.
  1897. </summary>
  1898. </member>
  1899. <member name="P:RabbitMQ.Client.IModel.IsOpen">
  1900. <summary>
  1901. Returns true if the model is still in a state where it can be used.
  1902. Identical to checking if <see cref="P:RabbitMQ.Client.IModel.CloseReason"/> equals null.</summary>
  1903. </member>
  1904. <member name="P:RabbitMQ.Client.IModel.NextPublishSeqNo">
  1905. <summary>
  1906. When in confirm mode, return the sequence number of the next message to be published.
  1907. </summary>
  1908. </member>
  1909. <member name="E:RabbitMQ.Client.IModel.BasicAcks">
  1910. <summary>
  1911. Signalled when a Basic.Ack command arrives from the broker.
  1912. </summary>
  1913. </member>
  1914. <member name="E:RabbitMQ.Client.IModel.BasicNacks">
  1915. <summary>
  1916. Signalled when a Basic.Nack command arrives from the broker.
  1917. </summary>
  1918. </member>
  1919. <member name="E:RabbitMQ.Client.IModel.BasicRecoverOk">
  1920. <summary>
  1921. All messages received before this fires that haven't been ack'ed will be redelivered.
  1922. All messages received afterwards won't be.
  1923. </summary>
  1924. <remarks>
  1925. Handlers for this event are invoked by the connection thread.
  1926. It is sometimes useful to allow that thread to know that a recover-ok
  1927. has been received, rather than the thread that invoked <see cref="M:RabbitMQ.Client.IModel.BasicRecover(System.Boolean)"/>.
  1928. </remarks>
  1929. </member>
  1930. <member name="E:RabbitMQ.Client.IModel.BasicReturn">
  1931. <summary>
  1932. Signalled when a Basic.Return command arrives from the broker.
  1933. </summary>
  1934. </member>
  1935. <member name="E:RabbitMQ.Client.IModel.CallbackException">
  1936. <summary>
  1937. Signalled when an exception occurs in a callback invoked by the model.
  1938. Examples of cases where this event will be signalled
  1939. include exceptions thrown in <see cref="T:RabbitMQ.Client.IBasicConsumer"/> methods, or
  1940. exceptions thrown in <see cref="E:RabbitMQ.Client.IModel.ModelShutdown"/> delegates etc.
  1941. </summary>
  1942. </member>
  1943. <member name="E:RabbitMQ.Client.IModel.ModelShutdown">
  1944. <summary>
  1945. Notifies the destruction of the model.
  1946. </summary>
  1947. <remarks>
  1948. If the model is already destroyed at the time an event
  1949. handler is added to this event, the event handler will be fired immediately.
  1950. </remarks>
  1951. </member>
  1952. <member name="M:RabbitMQ.Client.IModel.Abort">
  1953. <summary>
  1954. Abort this session.
  1955. </summary>
  1956. <remarks>
  1957. If the session is already closed (or closing), then this
  1958. method does nothing but wait for the in-progress close
  1959. operation to complete. This method will not return to the
  1960. caller until the shutdown is complete.
  1961. In comparison to normal <see cref="M:RabbitMQ.Client.IModel.Close"/> method, <see cref="M:RabbitMQ.Client.IModel.Abort"/> will not throw
  1962. <see cref="T:RabbitMQ.Client.Exceptions.AlreadyClosedException"/> or <see cref="T:System.IO.IOException"/> or any other <see cref="T:System.Exception"/> during closing model.
  1963. </remarks>
  1964. </member>
  1965. <member name="M:RabbitMQ.Client.IModel.Abort(System.UInt16,System.String)">
  1966. <summary>
  1967. Abort this session.
  1968. </summary>
  1969. <remarks>
  1970. The method behaves in the same way as <see cref="M:RabbitMQ.Client.IModel.Abort"/>, with the only
  1971. difference that the model is closed with the given model close code and message.
  1972. <para>
  1973. The close code (See under "Reply Codes" in the AMQP specification)
  1974. </para>
  1975. <para>
  1976. A message indicating the reason for closing the model
  1977. </para>
  1978. </remarks>
  1979. </member>
  1980. <member name="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)">
  1981. <summary>
  1982. Acknowledge one or more delivered message(s).
  1983. </summary>
  1984. </member>
  1985. <member name="M:RabbitMQ.Client.IModel.BasicCancel(System.String)">
  1986. <summary>
  1987. Delete a Basic content-class consumer.
  1988. </summary>
  1989. </member>
  1990. <member name="M:RabbitMQ.Client.IModel.BasicCancelNoWait(System.String)">
  1991. <summary>
  1992. Same as BasicCancel but sets nowait to true and returns void (as there
  1993. will be no response from the server).
  1994. </summary>
  1995. </member>
  1996. <member name="M:RabbitMQ.Client.IModel.BasicConsume(System.String,System.Boolean,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object},RabbitMQ.Client.IBasicConsumer)">
  1997. <summary>Start a Basic content-class consumer.</summary>
  1998. </member>
  1999. <member name="M:RabbitMQ.Client.IModel.BasicGet(System.String,System.Boolean)">
  2000. <summary>
  2001. Retrieve an individual message, if
  2002. one is available; returns null if the server answers that
  2003. no messages are currently available. See also <see cref="M:RabbitMQ.Client.IModel.BasicAck(System.UInt64,System.Boolean)"/>.
  2004. </summary>
  2005. </member>
  2006. <member name="M:RabbitMQ.Client.IModel.BasicNack(System.UInt64,System.Boolean,System.Boolean)">
  2007. <summary>Reject one or more delivered message(s).</summary>
  2008. </member>
  2009. <member name="M:RabbitMQ.Client.IModel.BasicPublish(System.String,System.String,System.Boolean,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2010. <summary>
  2011. Publishes a message.
  2012. </summary>
  2013. <remarks>
  2014. <para>
  2015. Routing key must be shorter than 255 bytes.
  2016. </para>
  2017. </remarks>
  2018. </member>
  2019. <member name="M:RabbitMQ.Client.IModel.BasicQos(System.UInt32,System.UInt16,System.Boolean)">
  2020. <summary>
  2021. Configures QoS parameters of the Basic content-class.
  2022. </summary>
  2023. </member>
  2024. <member name="M:RabbitMQ.Client.IModel.BasicRecover(System.Boolean)">
  2025. <summary>
  2026. Indicates that a consumer has recovered.
  2027. Deprecated. Should not be used.
  2028. </summary>
  2029. </member>
  2030. <member name="M:RabbitMQ.Client.IModel.BasicRecoverAsync(System.Boolean)">
  2031. <summary>
  2032. Indicates that a consumer has recovered.
  2033. Deprecated. Should not be used.
  2034. </summary>
  2035. </member>
  2036. <member name="M:RabbitMQ.Client.IModel.BasicReject(System.UInt64,System.Boolean)">
  2037. <summary> Reject a delivered message.</summary>
  2038. </member>
  2039. <member name="M:RabbitMQ.Client.IModel.Close">
  2040. <summary>Close this session.</summary>
  2041. <remarks>
  2042. If the session is already closed (or closing), then this
  2043. method does nothing but wait for the in-progress close
  2044. operation to complete. This method will not return to the
  2045. caller until the shutdown is complete.
  2046. </remarks>
  2047. </member>
  2048. <member name="M:RabbitMQ.Client.IModel.Close(System.UInt16,System.String)">
  2049. <summary>Close this session.</summary>
  2050. <remarks>
  2051. The method behaves in the same way as Close(), with the only
  2052. difference that the model is closed with the given model
  2053. close code and message.
  2054. <para>
  2055. The close code (See under "Reply Codes" in the AMQP specification)
  2056. </para>
  2057. <para>
  2058. A message indicating the reason for closing the model
  2059. </para>
  2060. </remarks>
  2061. </member>
  2062. <member name="M:RabbitMQ.Client.IModel.ConfirmSelect">
  2063. <summary>
  2064. Enable publisher acknowledgements.
  2065. </summary>
  2066. </member>
  2067. <member name="M:RabbitMQ.Client.IModel.CreateBasicPublishBatch">
  2068. <summary>
  2069. Creates a BasicPublishBatch instance
  2070. </summary>
  2071. </member>
  2072. <member name="M:RabbitMQ.Client.IModel.CreateBasicProperties">
  2073. <summary>
  2074. Construct a completely empty content header for use with the Basic content class.
  2075. </summary>
  2076. </member>
  2077. <member name="M:RabbitMQ.Client.IModel.ExchangeBind(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2078. <summary>
  2079. Bind an exchange to an exchange.
  2080. </summary>
  2081. <remarks>
  2082. <para>
  2083. Routing key must be shorter than 255 bytes.
  2084. </para>
  2085. </remarks>
  2086. </member>
  2087. <member name="M:RabbitMQ.Client.IModel.ExchangeBindNoWait(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2088. <summary>
  2089. Like ExchangeBind but sets nowait to true.
  2090. </summary>
  2091. <remarks>
  2092. <para>
  2093. Routing key must be shorter than 255 bytes.
  2094. </para>
  2095. </remarks>
  2096. </member>
  2097. <member name="M:RabbitMQ.Client.IModel.ExchangeDeclare(System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2098. <summary>Declare an exchange.</summary>
  2099. <remarks>
  2100. The exchange is declared non-passive and non-internal.
  2101. The "nowait" option is not exercised.
  2102. </remarks>
  2103. </member>
  2104. <member name="M:RabbitMQ.Client.IModel.ExchangeDeclareNoWait(System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2105. <summary>
  2106. Same as ExchangeDeclare but sets nowait to true and returns void (as there
  2107. will be no response from the server).
  2108. </summary>
  2109. </member>
  2110. <member name="M:RabbitMQ.Client.IModel.ExchangeDeclarePassive(System.String)">
  2111. <summary>
  2112. Do a passive exchange declaration.
  2113. </summary>
  2114. <remarks>
  2115. This method performs a "passive declare" on an exchange,
  2116. which checks whether an exchange exists.
  2117. It will do nothing if the exchange already exists and result
  2118. in a channel-level protocol exception (channel closure) if not.
  2119. </remarks>
  2120. </member>
  2121. <member name="M:RabbitMQ.Client.IModel.ExchangeDelete(System.String,System.Boolean)">
  2122. <summary>
  2123. Delete an exchange.
  2124. </summary>
  2125. </member>
  2126. <member name="M:RabbitMQ.Client.IModel.ExchangeDeleteNoWait(System.String,System.Boolean)">
  2127. <summary>
  2128. Like ExchangeDelete but sets nowait to true.
  2129. </summary>
  2130. </member>
  2131. <member name="M:RabbitMQ.Client.IModel.ExchangeUnbind(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2132. <summary>
  2133. Unbind an exchange from an exchange.
  2134. </summary>
  2135. <remarks>
  2136. Routing key must be shorter than 255 bytes.
  2137. </remarks>
  2138. </member>
  2139. <member name="M:RabbitMQ.Client.IModel.ExchangeUnbindNoWait(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2140. <summary>
  2141. Like ExchangeUnbind but sets nowait to true.
  2142. </summary>
  2143. <remarks>
  2144. <para>
  2145. Routing key must be shorter than 255 bytes.
  2146. </para>
  2147. </remarks>
  2148. </member>
  2149. <member name="M:RabbitMQ.Client.IModel.QueueBind(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2150. <summary>
  2151. Bind a queue to an exchange.
  2152. </summary>
  2153. <remarks>
  2154. <para>
  2155. Routing key must be shorter than 255 bytes.
  2156. </para>
  2157. </remarks>
  2158. </member>
  2159. <member name="M:RabbitMQ.Client.IModel.QueueBindNoWait(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2160. <summary>Same as QueueBind but sets nowait parameter to true.</summary>
  2161. <remarks>
  2162. <para>
  2163. Routing key must be shorter than 255 bytes.
  2164. </para>
  2165. </remarks>
  2166. </member>
  2167. <member name="M:RabbitMQ.Client.IModel.QueueDeclare(System.String,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2168. <summary>
  2169. Declares a queue. See the <a href="https://www.rabbitmq.com/queues.html">Queues guide</a> to learn more.
  2170. </summary>
  2171. <param name="queue">The name of the queue. Pass an empty string to make the server generate a name.</param>
  2172. <param name="durable">Should this queue will survive a broker restart?</param>
  2173. <param name="exclusive">Should this queue use be limited to its declaring connection? Such a queue will be deleted when its declaring connection closes.</param>
  2174. <param name="autoDelete">Should this queue be auto-deleted when its last consumer (if any) unsubscribes?</param>
  2175. <param name="arguments">Optional; additional queue arguments, e.g. "x-queue-type"</param>
  2176. </member>
  2177. <member name="M:RabbitMQ.Client.IModel.QueueDeclareNoWait(System.String,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2178. <summary>
  2179. Same as QueueDeclare but sets nowait to true and returns void (as there
  2180. will be no response from the server).
  2181. </summary>
  2182. </member>
  2183. <member name="M:RabbitMQ.Client.IModel.QueueDeclarePassive(System.String)">
  2184. <summary>Declare a queue passively.</summary>
  2185. <remarks>
  2186. The queue is declared passive, non-durable,
  2187. non-exclusive, and non-autodelete, with no arguments.
  2188. The queue is declared passively; i.e. only check if it exists.
  2189. </remarks>
  2190. </member>
  2191. <member name="M:RabbitMQ.Client.IModel.MessageCount(System.String)">
  2192. <summary>
  2193. Returns the number of messages in a queue ready to be delivered
  2194. to consumers. This method assumes the queue exists. If it doesn't,
  2195. an exception will be closed with an exception.
  2196. </summary>
  2197. <param name="queue">The name of the queue</param>
  2198. </member>
  2199. <member name="M:RabbitMQ.Client.IModel.ConsumerCount(System.String)">
  2200. <summary>
  2201. Returns the number of consumers on a queue.
  2202. This method assumes the queue exists. If it doesn't,
  2203. an exception will be closed with an exception.
  2204. </summary>
  2205. <param name="queue">The name of the queue</param>
  2206. </member>
  2207. <member name="M:RabbitMQ.Client.IModel.QueueDelete(System.String,System.Boolean,System.Boolean)">
  2208. <summary>
  2209. Delete a queue.
  2210. </summary>
  2211. <remarks>
  2212. Returns the number of messages purged during queue deletion.
  2213. <code>uint.MaxValue</code>.
  2214. </remarks>
  2215. </member>
  2216. <member name="M:RabbitMQ.Client.IModel.QueueDeleteNoWait(System.String,System.Boolean,System.Boolean)">
  2217. <summary>
  2218. Same as QueueDelete but sets nowait parameter to true
  2219. and returns void (as there will be no response from the server)
  2220. </summary>
  2221. </member>
  2222. <member name="M:RabbitMQ.Client.IModel.QueuePurge(System.String)">
  2223. <summary>
  2224. Purge a queue of messages.
  2225. </summary>
  2226. <remarks>
  2227. Returns the number of messages purged.
  2228. </remarks>
  2229. </member>
  2230. <member name="M:RabbitMQ.Client.IModel.QueueUnbind(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2231. <summary>
  2232. Unbind a queue from an exchange.
  2233. </summary>
  2234. <remarks>
  2235. <para>
  2236. Routing key must be shorter than 255 bytes.
  2237. </para>
  2238. </remarks>
  2239. </member>
  2240. <member name="M:RabbitMQ.Client.IModel.TxCommit">
  2241. <summary>
  2242. Commit this session's active TX transaction.
  2243. </summary>
  2244. </member>
  2245. <member name="M:RabbitMQ.Client.IModel.TxRollback">
  2246. <summary>
  2247. Roll back this session's active TX transaction.
  2248. </summary>
  2249. </member>
  2250. <member name="M:RabbitMQ.Client.IModel.TxSelect">
  2251. <summary>
  2252. Enable TX mode for this session.
  2253. </summary>
  2254. </member>
  2255. <member name="M:RabbitMQ.Client.IModel.WaitForConfirms">
  2256. <summary>Wait until all published messages have been confirmed.
  2257. </summary>
  2258. <remarks>
  2259. Waits until all messages published since the last call have
  2260. been either ack'd or nack'd by the broker. Returns whether
  2261. all the messages were ack'd (and none were nack'd). Note,
  2262. throws an exception when called on a non-Confirm channel.
  2263. </remarks>
  2264. </member>
  2265. <member name="M:RabbitMQ.Client.IModel.WaitForConfirms(System.TimeSpan)">
  2266. <summary>
  2267. Wait until all published messages have been confirmed.
  2268. </summary>
  2269. <returns>True if no nacks were received within the timeout, otherwise false.</returns>
  2270. <param name="timeout">How long to wait (at most) before returning
  2271. whether or not any nacks were returned.
  2272. </param>
  2273. <remarks>
  2274. Waits until all messages published since the last call have
  2275. been either ack'd or nack'd by the broker. Returns whether
  2276. all the messages were ack'd (and none were nack'd). Note,
  2277. throws an exception when called on a non-Confirm channel.
  2278. </remarks>
  2279. </member>
  2280. <member name="M:RabbitMQ.Client.IModel.WaitForConfirms(System.TimeSpan,System.Boolean@)">
  2281. <summary>
  2282. Wait until all published messages have been confirmed.
  2283. </summary>
  2284. <returns>True if no nacks were received within the timeout, otherwise false.</returns>
  2285. <param name="timeout">How long to wait (at most) before returning
  2286. whether or not any nacks were returned.
  2287. </param>
  2288. <param name="timedOut">True if the method returned because
  2289. the timeout elapsed, not because all messages were ack'd or at least one nack'd.
  2290. </param>
  2291. <remarks>
  2292. Waits until all messages published since the last call have
  2293. been either ack'd or nack'd by the broker. Returns whether
  2294. all the messages were ack'd (and none were nack'd). Note,
  2295. throws an exception when called on a non-Confirm channel.
  2296. </remarks>
  2297. </member>
  2298. <member name="M:RabbitMQ.Client.IModel.WaitForConfirmsOrDie">
  2299. <summary>
  2300. Wait until all published messages have been confirmed.
  2301. </summary>
  2302. <remarks>
  2303. Waits until all messages published since the last call have
  2304. been ack'd by the broker. If a nack is received, throws an
  2305. OperationInterrupedException exception immediately.
  2306. </remarks>
  2307. </member>
  2308. <member name="M:RabbitMQ.Client.IModel.WaitForConfirmsOrDie(System.TimeSpan)">
  2309. <summary>
  2310. Wait until all published messages have been confirmed.
  2311. </summary>
  2312. <remarks>
  2313. Waits until all messages published since the last call have
  2314. been ack'd by the broker. If a nack is received or the timeout
  2315. elapses, throws an OperationInterruptedException exception immediately.
  2316. </remarks>
  2317. </member>
  2318. <member name="P:RabbitMQ.Client.IModel.ContinuationTimeout">
  2319. <summary>
  2320. Amount of time protocol operations (e.g. <code>queue.declare</code>) are allowed to take before
  2321. timing out.
  2322. </summary>
  2323. </member>
  2324. <member name="M:RabbitMQ.Client.IModelExensions.BasicConsume(RabbitMQ.Client.IModel,RabbitMQ.Client.IBasicConsumer,System.String,System.Boolean,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2325. <summary>Start a Basic content-class consumer.</summary>
  2326. </member>
  2327. <member name="M:RabbitMQ.Client.IModelExensions.BasicConsume(RabbitMQ.Client.IModel,System.String,System.Boolean,RabbitMQ.Client.IBasicConsumer)">
  2328. <summary>Start a Basic content-class consumer.</summary>
  2329. </member>
  2330. <member name="M:RabbitMQ.Client.IModelExensions.BasicConsume(RabbitMQ.Client.IModel,System.String,System.Boolean,System.String,RabbitMQ.Client.IBasicConsumer)">
  2331. <summary>Start a Basic content-class consumer.</summary>
  2332. </member>
  2333. <member name="M:RabbitMQ.Client.IModelExensions.BasicConsume(RabbitMQ.Client.IModel,System.String,System.Boolean,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},RabbitMQ.Client.IBasicConsumer)">
  2334. <summary>Start a Basic content-class consumer.</summary>
  2335. </member>
  2336. <member name="M:RabbitMQ.Client.IModelExensions.BasicPublish(RabbitMQ.Client.IModel,RabbitMQ.Client.PublicationAddress,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2337. <summary>
  2338. (Extension method) Convenience overload of BasicPublish.
  2339. </summary>
  2340. <remarks>
  2341. The publication occurs with mandatory=false and immediate=false.
  2342. </remarks>
  2343. </member>
  2344. <member name="M:RabbitMQ.Client.IModelExensions.BasicPublish(RabbitMQ.Client.IModel,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2345. <summary>
  2346. (Extension method) Convenience overload of BasicPublish.
  2347. </summary>
  2348. <remarks>
  2349. The publication occurs with mandatory=false
  2350. </remarks>
  2351. </member>
  2352. <member name="M:RabbitMQ.Client.IModelExensions.BasicPublish(RabbitMQ.Client.IModel,System.String,System.String,System.Boolean,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2353. <summary>
  2354. (Spec method) Convenience overload of BasicPublish.
  2355. </summary>
  2356. </member>
  2357. <member name="M:RabbitMQ.Client.IModelExensions.QueueDeclare(RabbitMQ.Client.IModel,System.String,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2358. <summary>
  2359. (Spec method) Declare a queue.
  2360. </summary>
  2361. </member>
  2362. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeBind(RabbitMQ.Client.IModel,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2363. <summary>
  2364. (Extension method) Bind an exchange to an exchange.
  2365. </summary>
  2366. </member>
  2367. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeBindNoWait(RabbitMQ.Client.IModel,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2368. <summary>
  2369. (Extension method) Like exchange bind but sets nowait to true.
  2370. </summary>
  2371. </member>
  2372. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeDeclare(RabbitMQ.Client.IModel,System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2373. <summary>
  2374. (Spec method) Declare an exchange.
  2375. </summary>
  2376. </member>
  2377. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeDeclareNoWait(RabbitMQ.Client.IModel,System.String,System.String,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2378. <summary>
  2379. (Extension method) Like ExchangeDeclare but sets nowait to true.
  2380. </summary>
  2381. </member>
  2382. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeUnbind(RabbitMQ.Client.IModel,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2383. <summary>
  2384. (Spec method) Unbinds an exchange.
  2385. </summary>
  2386. </member>
  2387. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeDelete(RabbitMQ.Client.IModel,System.String,System.Boolean)">
  2388. <summary>
  2389. (Spec method) Deletes an exchange.
  2390. </summary>
  2391. </member>
  2392. <member name="M:RabbitMQ.Client.IModelExensions.ExchangeDeleteNoWait(RabbitMQ.Client.IModel,System.String,System.Boolean)">
  2393. <summary>
  2394. (Extension method) Like ExchangeDelete but sets nowait to true.
  2395. </summary>
  2396. </member>
  2397. <member name="M:RabbitMQ.Client.IModelExensions.QueueBind(RabbitMQ.Client.IModel,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2398. <summary>
  2399. (Spec method) Binds a queue.
  2400. </summary>
  2401. </member>
  2402. <member name="M:RabbitMQ.Client.IModelExensions.QueueDelete(RabbitMQ.Client.IModel,System.String,System.Boolean,System.Boolean)">
  2403. <summary>
  2404. (Spec method) Deletes a queue.
  2405. </summary>
  2406. </member>
  2407. <member name="M:RabbitMQ.Client.IModelExensions.QueueDeleteNoWait(RabbitMQ.Client.IModel,System.String,System.Boolean,System.Boolean)">
  2408. <summary>
  2409. (Extension method) Like QueueDelete but sets nowait to true.
  2410. </summary>
  2411. </member>
  2412. <member name="M:RabbitMQ.Client.IModelExensions.QueueUnbind(RabbitMQ.Client.IModel,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  2413. <summary>
  2414. (Spec method) Unbinds a queue.
  2415. </summary>
  2416. </member>
  2417. <member name="T:RabbitMQ.Client.INetworkConnection">
  2418. <summary>
  2419. Common interface for network (TCP/IP) connection classes.
  2420. </summary>
  2421. </member>
  2422. <member name="P:RabbitMQ.Client.INetworkConnection.LocalPort">
  2423. <summary>
  2424. Local port.
  2425. </summary>
  2426. </member>
  2427. <member name="P:RabbitMQ.Client.INetworkConnection.RemotePort">
  2428. <summary>
  2429. Remote port.
  2430. </summary>
  2431. </member>
  2432. <member name="T:RabbitMQ.Client.IProtocol">
  2433. <summary>
  2434. Object describing various overarching parameters
  2435. associated with a particular AMQP protocol variant.
  2436. </summary>
  2437. </member>
  2438. <member name="P:RabbitMQ.Client.IProtocol.ApiName">
  2439. <summary>
  2440. Retrieve the protocol's API name, used for printing,
  2441. configuration properties, IDE integration, Protocols.cs etc.
  2442. </summary>
  2443. </member>
  2444. <member name="P:RabbitMQ.Client.IProtocol.DefaultPort">
  2445. <summary>
  2446. Retrieve the protocol's default TCP port.
  2447. </summary>
  2448. </member>
  2449. <member name="P:RabbitMQ.Client.IProtocol.MajorVersion">
  2450. <summary>
  2451. Retrieve the protocol's major version number.
  2452. </summary>
  2453. </member>
  2454. <member name="P:RabbitMQ.Client.IProtocol.MinorVersion">
  2455. <summary>
  2456. Retrieve the protocol's minor version number.
  2457. </summary>
  2458. </member>
  2459. <member name="P:RabbitMQ.Client.IProtocol.Revision">
  2460. <summary>
  2461. Retrieve the protocol's revision (if specified).
  2462. </summary>
  2463. </member>
  2464. <member name="T:RabbitMQ.Client.IRecoverable">
  2465. <summary>
  2466. A marker interface for entities that are recoverable (currently connection or channel).
  2467. </summary>
  2468. </member>
  2469. <member name="T:RabbitMQ.Client.IStreamProperties">
  2470. <summary>
  2471. Common AMQP Stream content-class headers interface,
  2472. spanning the union of the functionality offered by versions 0-8, 0-8qpid, 0-9 and 0-9-1 of AMQP.
  2473. </summary>
  2474. <remarks>
  2475. <para>
  2476. The specification code generator provides
  2477. protocol-version-specific implementations of this interface. To
  2478. obtain an implementation of this interface in a
  2479. protocol-version-neutral way, use IModel.CreateStreamProperties().
  2480. </para>
  2481. <para>
  2482. Each property is readable, writable and clearable: a cleared
  2483. property will not be transmitted over the wire. Properties on a fresh instance are clear by default.
  2484. </para>
  2485. </remarks>
  2486. </member>
  2487. <member name="P:RabbitMQ.Client.IStreamProperties.ContentEncoding">
  2488. <summary>
  2489. MIME content encoding.
  2490. </summary>
  2491. </member>
  2492. <member name="P:RabbitMQ.Client.IStreamProperties.ContentType">
  2493. <summary>
  2494. MIME content type.
  2495. </summary>
  2496. </member>
  2497. <member name="P:RabbitMQ.Client.IStreamProperties.Headers">
  2498. <summary>
  2499. Message header field table.
  2500. </summary>
  2501. </member>
  2502. <member name="P:RabbitMQ.Client.IStreamProperties.Priority">
  2503. <summary>
  2504. Message priority, 0 to 9.
  2505. </summary>
  2506. </member>
  2507. <member name="P:RabbitMQ.Client.IStreamProperties.Timestamp">
  2508. <summary>
  2509. Message timestamp.
  2510. </summary>
  2511. </member>
  2512. <member name="M:RabbitMQ.Client.IStreamProperties.ClearContentEncoding">
  2513. <summary>
  2514. Clear the <see cref="P:RabbitMQ.Client.IStreamProperties.ContentEncoding"/> property.
  2515. </summary>
  2516. </member>
  2517. <member name="M:RabbitMQ.Client.IStreamProperties.ClearContentType">
  2518. <summary>
  2519. Clear the <see cref="P:RabbitMQ.Client.IStreamProperties.ContentType"/> property.
  2520. </summary>
  2521. </member>
  2522. <member name="M:RabbitMQ.Client.IStreamProperties.ClearHeaders">
  2523. <summary>
  2524. Clear the <see cref="P:RabbitMQ.Client.IStreamProperties.Headers"/> property.
  2525. </summary>
  2526. </member>
  2527. <member name="M:RabbitMQ.Client.IStreamProperties.ClearPriority">
  2528. <summary>
  2529. Clear the <see cref="P:RabbitMQ.Client.IStreamProperties.Priority"/> property.
  2530. </summary>
  2531. </member>
  2532. <member name="M:RabbitMQ.Client.IStreamProperties.ClearTimestamp">
  2533. <summary>
  2534. Clear the <see cref="P:RabbitMQ.Client.IStreamProperties.Timestamp"/> property.
  2535. </summary>
  2536. </member>
  2537. <member name="M:RabbitMQ.Client.IStreamProperties.IsContentEncodingPresent">
  2538. <summary>
  2539. Returns true if the <see cref="P:RabbitMQ.Client.IStreamProperties.ContentEncoding"/> property is present.
  2540. </summary>
  2541. </member>
  2542. <member name="M:RabbitMQ.Client.IStreamProperties.IsContentTypePresent">
  2543. <summary>
  2544. Returns true if the <see cref="P:RabbitMQ.Client.IStreamProperties.ContentType"/> property is present.
  2545. </summary>
  2546. </member>
  2547. <member name="M:RabbitMQ.Client.IStreamProperties.IsHeadersPresent">
  2548. <summary>
  2549. Returns true if the <see cref="P:RabbitMQ.Client.IStreamProperties.Headers"/> property is present.
  2550. </summary>
  2551. </member>
  2552. <member name="M:RabbitMQ.Client.IStreamProperties.IsPriorityPresent">
  2553. <summary>
  2554. Returns true if the <see cref="P:RabbitMQ.Client.IStreamProperties.Priority"/> property is present.
  2555. </summary>
  2556. </member>
  2557. <member name="M:RabbitMQ.Client.IStreamProperties.IsTimestampPresent">
  2558. <summary>
  2559. Returns true if the <see cref="P:RabbitMQ.Client.IStreamProperties.Timestamp"/> property is present.
  2560. </summary>
  2561. </member>
  2562. <member name="T:RabbitMQ.Client.ITcpClient">
  2563. <summary>
  2564. Wrapper interface for standard TCP-client. Provides socket for socket frame handler class.
  2565. </summary>
  2566. <remarks>Contains all methods that are currenty in use in rabbitmq client.</remarks>
  2567. </member>
  2568. <member name="P:RabbitMQ.Client.PlainMechanismFactory.Name">
  2569. <summary>
  2570. The name of the authentication mechanism, as negotiated on the wire.
  2571. </summary>
  2572. </member>
  2573. <member name="M:RabbitMQ.Client.PlainMechanismFactory.GetInstance">
  2574. <summary>
  2575. Return a new authentication mechanism implementation.
  2576. </summary>
  2577. </member>
  2578. <member name="T:RabbitMQ.Client.Protocols">
  2579. <summary>
  2580. Provides access to the supported <see cref="T:RabbitMQ.Client.IProtocol"/> implementations.
  2581. </summary>
  2582. </member>
  2583. <member name="P:RabbitMQ.Client.Protocols.AMQP_0_9_1">
  2584. <summary>
  2585. Protocol version 0-9-1 as modified by Pivotal.
  2586. </summary>
  2587. </member>
  2588. <member name="P:RabbitMQ.Client.Protocols.DefaultProtocol">
  2589. <summary>
  2590. Retrieve the current default protocol variant (currently AMQP_0_9_1).
  2591. </summary>
  2592. </member>
  2593. <member name="T:RabbitMQ.Client.PublicationAddress">
  2594. <summary>
  2595. Container for an exchange name, exchange type and
  2596. routing key, usable as the target address of a message to be published.
  2597. </summary>
  2598. <remarks>
  2599. <para>
  2600. The syntax used for the external representation of instances
  2601. of this class is compatible with QPid's "Reply-To" field
  2602. pseudo-URI format. The pseudo-URI format is
  2603. (exchange-type)://(exchange-name)/(routing-key), where
  2604. exchange-type is one of the permitted exchange type names (see
  2605. class ExchangeType), exchange-name must be present but may be
  2606. empty, and routing-key must be present but may be empty.
  2607. </para>
  2608. <para>
  2609. The syntax is as it is solely for compatibility with QPid's
  2610. existing usage of the ReplyTo field; the AMQP specifications
  2611. 0-8 and 0-9 do not define the format of the field, and do not
  2612. define any format for the triple (exchange name, exchange
  2613. type, routing key) that could be used instead.
  2614. </para>
  2615. </remarks>
  2616. </member>
  2617. <member name="F:RabbitMQ.Client.PublicationAddress.PSEUDO_URI_PARSER">
  2618. <summary>
  2619. Regular expression used to extract the exchange-type,
  2620. exchange-name and routing-key from a string.
  2621. </summary>
  2622. </member>
  2623. <member name="M:RabbitMQ.Client.PublicationAddress.#ctor(System.String,System.String,System.String)">
  2624. <summary>
  2625. Creates a new instance of the <see cref="T:RabbitMQ.Client.PublicationAddress"/>.
  2626. </summary>
  2627. <param name="exchangeType">Exchange type.</param>
  2628. <param name="exchangeName">Exchange name.</param>
  2629. <param name="routingKey">Routing key.</param>
  2630. </member>
  2631. <member name="P:RabbitMQ.Client.PublicationAddress.ExchangeName">
  2632. <summary>
  2633. Retrieve the exchange name.
  2634. </summary>
  2635. </member>
  2636. <member name="P:RabbitMQ.Client.PublicationAddress.ExchangeType">
  2637. <summary>
  2638. Retrieve the exchange type string.
  2639. </summary>
  2640. </member>
  2641. <member name="P:RabbitMQ.Client.PublicationAddress.RoutingKey">
  2642. <summary>
  2643. Retrieve the routing key.
  2644. </summary>
  2645. </member>
  2646. <member name="M:RabbitMQ.Client.PublicationAddress.Parse(System.String)">
  2647. <summary>
  2648. Parse a <see cref="T:RabbitMQ.Client.PublicationAddress"/> out of the given string,
  2649. using the <see cref="F:RabbitMQ.Client.PublicationAddress.PSEUDO_URI_PARSER"/> regex.
  2650. </summary>
  2651. </member>
  2652. <member name="M:RabbitMQ.Client.PublicationAddress.ToString">
  2653. <summary>
  2654. Reconstruct the "uri" from its constituents.
  2655. </summary>
  2656. </member>
  2657. <member name="T:RabbitMQ.Client.QueueDeclareOk">
  2658. <summary>
  2659. Represents Queue info.
  2660. </summary>
  2661. </member>
  2662. <member name="M:RabbitMQ.Client.QueueDeclareOk.#ctor(System.String,System.UInt32,System.UInt32)">
  2663. <summary>
  2664. Creates a new instance of the <see cref="T:RabbitMQ.Client.QueueDeclareOk"/>.
  2665. </summary>
  2666. <param name="queueName">Queue name.</param>
  2667. <param name="messageCount">Message count.</param>
  2668. <param name="consumerCount">Consumer count.</param>
  2669. </member>
  2670. <member name="P:RabbitMQ.Client.QueueDeclareOk.ConsumerCount">
  2671. <summary>
  2672. Consumer count.
  2673. </summary>
  2674. </member>
  2675. <member name="P:RabbitMQ.Client.QueueDeclareOk.MessageCount">
  2676. <summary>
  2677. Message count.
  2678. </summary>
  2679. </member>
  2680. <member name="P:RabbitMQ.Client.QueueDeclareOk.QueueName">
  2681. <summary>
  2682. Queue name.
  2683. </summary>
  2684. </member>
  2685. <member name="T:RabbitMQ.Client.ShutdownEventArgs">
  2686. <summary>
  2687. Information about the reason why a particular model, session, or connection was destroyed.
  2688. </summary>
  2689. <remarks>
  2690. The <see cref="P:RabbitMQ.Client.ShutdownEventArgs.ClassId"/> and <see cref="P:RabbitMQ.Client.ShutdownEventArgs.Initiator"/> properties should be used to determine the originator of the shutdown event.
  2691. </remarks>
  2692. </member>
  2693. <member name="M:RabbitMQ.Client.ShutdownEventArgs.#ctor(RabbitMQ.Client.ShutdownInitiator,System.UInt16,System.String,System.Object)">
  2694. <summary>
  2695. Construct a <see cref="T:RabbitMQ.Client.ShutdownEventArgs"/> with the given parameters and
  2696. 0 for <see cref="P:RabbitMQ.Client.ShutdownEventArgs.ClassId"/> and <see cref="P:RabbitMQ.Client.ShutdownEventArgs.MethodId"/>.
  2697. </summary>
  2698. </member>
  2699. <member name="M:RabbitMQ.Client.ShutdownEventArgs.#ctor(RabbitMQ.Client.ShutdownInitiator,System.UInt16,System.String,System.UInt16,System.UInt16,System.Object)">
  2700. <summary>
  2701. Construct a <see cref="T:RabbitMQ.Client.ShutdownEventArgs"/> with the given parameters.
  2702. </summary>
  2703. </member>
  2704. <member name="P:RabbitMQ.Client.ShutdownEventArgs.Cause">
  2705. <summary>
  2706. Object causing the shutdown, or null if none.
  2707. </summary>
  2708. </member>
  2709. <member name="P:RabbitMQ.Client.ShutdownEventArgs.ClassId">
  2710. <summary>
  2711. AMQP content-class ID, or 0 if none.
  2712. </summary>
  2713. </member>
  2714. <member name="P:RabbitMQ.Client.ShutdownEventArgs.Initiator">
  2715. <summary>
  2716. Returns the source of the shutdown event: either the application, the library, or the remote peer.
  2717. </summary>
  2718. </member>
  2719. <member name="P:RabbitMQ.Client.ShutdownEventArgs.MethodId">
  2720. <summary>
  2721. AMQP method ID within a content-class, or 0 if none.
  2722. </summary>
  2723. </member>
  2724. <member name="P:RabbitMQ.Client.ShutdownEventArgs.ReplyCode">
  2725. <summary>
  2726. One of the standardised AMQP reason codes. See RabbitMQ.Client.Framing.*.Constants.
  2727. </summary>
  2728. </member>
  2729. <member name="P:RabbitMQ.Client.ShutdownEventArgs.ReplyText">
  2730. <summary>
  2731. Informative human-readable reason text.
  2732. </summary>
  2733. </member>
  2734. <member name="M:RabbitMQ.Client.ShutdownEventArgs.ToString">
  2735. <summary>
  2736. Override ToString to be useful for debugging.
  2737. </summary>
  2738. </member>
  2739. <member name="T:RabbitMQ.Client.ShutdownInitiator">
  2740. <summary>
  2741. Describes the source of a shutdown event.
  2742. </summary>
  2743. </member>
  2744. <member name="F:RabbitMQ.Client.ShutdownInitiator.Application">
  2745. <summary>
  2746. The shutdown event originated from the application using the RabbitMQ .NET client library.
  2747. </summary>
  2748. </member>
  2749. <member name="F:RabbitMQ.Client.ShutdownInitiator.Library">
  2750. <summary>
  2751. The shutdown event originated from the RabbitMQ .NET client library itself.
  2752. </summary>
  2753. <remarks>
  2754. Shutdowns with this ShutdownInitiator code may appear if,
  2755. for example, an internal error is detected by the client,
  2756. or if the server sends a syntactically invalid
  2757. frame. Another potential use is on IConnection AutoClose.
  2758. </remarks>
  2759. </member>
  2760. <member name="F:RabbitMQ.Client.ShutdownInitiator.Peer">
  2761. <summary>
  2762. The shutdown event originated from the remote AMQP peer.
  2763. </summary>
  2764. <remarks>
  2765. A valid received connection.close or channel.close event
  2766. will manifest as a shutdown with this ShutdownInitiator.
  2767. </remarks>
  2768. </member>
  2769. <member name="T:RabbitMQ.Client.ShutdownReportEntry">
  2770. <summary>
  2771. Single entry object in the shutdown report that encapsulates description
  2772. of the error which occured during shutdown.
  2773. </summary>
  2774. </member>
  2775. <member name="P:RabbitMQ.Client.ShutdownReportEntry.Description">
  2776. <summary>
  2777. Description provided in the error.
  2778. </summary>
  2779. </member>
  2780. <member name="P:RabbitMQ.Client.ShutdownReportEntry.Exception">
  2781. <summary>
  2782. <see cref="P:RabbitMQ.Client.ShutdownReportEntry.Exception"/> object that occured during shutdown, or null if unspecified.
  2783. </summary>
  2784. </member>
  2785. <member name="T:RabbitMQ.Client.SslOption">
  2786. <summary>
  2787. Represents a set of configurable TLS options for a connection. Use this class to configure
  2788. TLS version used, client certificate list or file location, peer certificate verification
  2789. (validation) functions, expected server name (Subject Alternative Name or Common Name),
  2790. and so on.
  2791. </summary>
  2792. </member>
  2793. <member name="M:RabbitMQ.Client.SslOption.#ctor(System.String,System.String,System.Boolean)">
  2794. <summary>
  2795. Constructs an SslOption specifying both the server cannonical name and the client's certificate path.
  2796. </summary>
  2797. </member>
  2798. <member name="M:RabbitMQ.Client.SslOption.#ctor">
  2799. <summary>
  2800. Constructs an <see cref="T:RabbitMQ.Client.SslOption"/> with no parameters set.
  2801. </summary>
  2802. </member>
  2803. <member name="P:RabbitMQ.Client.SslOption.AcceptablePolicyErrors">
  2804. <summary>
  2805. Retrieve or set the set of TLS policy (peer verification) errors that are deemed acceptable.
  2806. </summary>
  2807. </member>
  2808. <member name="P:RabbitMQ.Client.SslOption.CertPassphrase">
  2809. <summary>
  2810. Retrieve or set the client certificate passphrase.
  2811. </summary>
  2812. </member>
  2813. <member name="P:RabbitMQ.Client.SslOption.CertPath">
  2814. <summary>
  2815. Retrieve or set the path to client certificate.
  2816. </summary>
  2817. </member>
  2818. <member name="P:RabbitMQ.Client.SslOption.CertificateSelectionCallback">
  2819. <summary>
  2820. An optional client TLS certificate selection callback. If this is not specified,
  2821. the first valid certificate found will be used.
  2822. </summary>
  2823. </member>
  2824. <member name="P:RabbitMQ.Client.SslOption.CertificateValidationCallback">
  2825. <summary>
  2826. An optional peer verification (TLS certificate validation) callback. If this is not specified,
  2827. the default callback will be used in conjunction with the <see cref="P:RabbitMQ.Client.SslOption.AcceptablePolicyErrors"/> property to
  2828. determine if the peer's (server's) certificate should be considered valid (acceptable).
  2829. </summary>
  2830. </member>
  2831. <member name="P:RabbitMQ.Client.SslOption.Certs">
  2832. <summary>
  2833. Retrieve or set the X509CertificateCollection containing the client certificate.
  2834. If no collection is set, the client will attempt to load one from the specified <see cref="P:RabbitMQ.Client.SslOption.CertPath"/>.
  2835. </summary>
  2836. </member>
  2837. <member name="P:RabbitMQ.Client.SslOption.CheckCertificateRevocation">
  2838. <summary>
  2839. Attempts to check certificate revocation status. Default is false.
  2840. Set to true to check peer certificate for revocation.
  2841. </summary>
  2842. <remarks>
  2843. Uses the built-in .NET TLS implementation machinery for checking a certificate against
  2844. certificate revocation lists.
  2845. </remarks>
  2846. </member>
  2847. <member name="P:RabbitMQ.Client.SslOption.Enabled">
  2848. <summary>
  2849. Controls if TLS should indeed be used. Set to false to disable TLS
  2850. on the connection.
  2851. </summary>
  2852. </member>
  2853. <member name="P:RabbitMQ.Client.SslOption.ServerName">
  2854. <summary>
  2855. Retrieve or set server's expected name.
  2856. This MUST match the Subject Alternative Name (SAN) or CN on the peer's (server's) leaf certificate,
  2857. otherwise the TLS connection will fail.
  2858. </summary>
  2859. </member>
  2860. <member name="P:RabbitMQ.Client.SslOption.Version">
  2861. <summary>
  2862. Retrieve or set the TLS protocol version.
  2863. The client will let the OS pick a suitable version by using <see cref="F:System.Security.Authentication.SslProtocols.None" />.
  2864. If this option is disabled, e.g.see via app context, the client will attempt to fall back
  2865. to TLSv1.2.
  2866. </summary>
  2867. <seealso cref="T:System.Security.Authentication.SslProtocols" />
  2868. <seealso href="https://www.rabbitmq.com/ssl.html#dotnet-client" />
  2869. <seealso href="https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls?view=netframework-4.6.2" />
  2870. <seealso href="https://docs.microsoft.com/en-us/dotnet/api/system.security.authentication.sslprotocols?view=netframework-4.8" />
  2871. </member>
  2872. <member name="M:RabbitMQ.Client.SslOption.UseFallbackTlsVersions">
  2873. <summary>
  2874. Reconfigures the instance to enable/use TLSv1.2.
  2875. Only used in environments where System.Security.Authentication.SslProtocols.None
  2876. is unavailable or effectively disabled, as reported by System.Net.ServicePointManager.
  2877. </summary>
  2878. </member>
  2879. <member name="M:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.#ctor(RabbitMQ.Client.IModel)">
  2880. <summary>Constructor which sets the Model property to the
  2881. given value.</summary>
  2882. </member>
  2883. <member name="E:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Received">
  2884. <summary>
  2885. Event fired when a delivery arrives for the consumer.
  2886. </summary>
  2887. <remarks>
  2888. Handlers must copy or fully use delivery body before returning.
  2889. Accessing the body at a later point is unsafe as its memory can
  2890. be already released.
  2891. </remarks>
  2892. </member>
  2893. <member name="E:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Registered">
  2894. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  2895. </member>
  2896. <member name="E:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Shutdown">
  2897. <summary>Fires on model (channel) shutdown, both client and server initiated.</summary>
  2898. </member>
  2899. <member name="E:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Unregistered">
  2900. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  2901. </member>
  2902. <member name="M:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.HandleBasicCancelOk(System.String)">
  2903. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  2904. </member>
  2905. <member name="M:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.HandleBasicConsumeOk(System.String)">
  2906. <summary>Fires when the server confirms successful consumer registration.</summary>
  2907. </member>
  2908. <member name="M:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2909. <summary>Fires the Received event.</summary>
  2910. </member>
  2911. <member name="M:RabbitMQ.Client.Events.AsyncEventingBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  2912. <summary>Fires the Shutdown event.</summary>
  2913. </member>
  2914. <member name="T:RabbitMQ.Client.Events.BasicAckEventArgs">
  2915. <summary>Contains all the information about a message acknowledged
  2916. from an AMQP broker within the Basic content-class.</summary>
  2917. </member>
  2918. <member name="P:RabbitMQ.Client.Events.BasicAckEventArgs.DeliveryTag">
  2919. <summary>The sequence number of the acknowledged message, or
  2920. the closed upper bound of acknowledged messages if multiple
  2921. is true.</summary>
  2922. </member>
  2923. <member name="P:RabbitMQ.Client.Events.BasicAckEventArgs.Multiple">
  2924. <summary>Whether this acknoledgement applies to one message
  2925. or multiple messages.</summary>
  2926. </member>
  2927. <member name="T:RabbitMQ.Client.Events.BasicDeliverEventArgs">
  2928. <summary>Contains all the information about a message delivered
  2929. from an AMQP broker within the Basic content-class.</summary>
  2930. </member>
  2931. <member name="M:RabbitMQ.Client.Events.BasicDeliverEventArgs.#ctor">
  2932. <summary>Default constructor.</summary>
  2933. </member>
  2934. <member name="M:RabbitMQ.Client.Events.BasicDeliverEventArgs.#ctor(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  2935. <summary>Constructor that fills the event's properties from
  2936. its arguments.</summary>
  2937. </member>
  2938. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.BasicProperties">
  2939. <summary>The content header of the message.</summary>
  2940. </member>
  2941. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.Body">
  2942. <summary>The message body.</summary>
  2943. </member>
  2944. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.ConsumerTag">
  2945. <summary>The consumer tag of the consumer that the message
  2946. was delivered to.</summary>
  2947. </member>
  2948. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.DeliveryTag">
  2949. <summary>The delivery tag for this delivery. See
  2950. IModel.BasicAck.</summary>
  2951. </member>
  2952. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.Exchange">
  2953. <summary>The exchange the message was originally published
  2954. to.</summary>
  2955. </member>
  2956. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.Redelivered">
  2957. <summary>The AMQP "redelivered" flag.</summary>
  2958. </member>
  2959. <member name="P:RabbitMQ.Client.Events.BasicDeliverEventArgs.RoutingKey">
  2960. <summary>The routing key used when the message was
  2961. originally published.</summary>
  2962. </member>
  2963. <member name="T:RabbitMQ.Client.Events.BasicNackEventArgs">
  2964. <summary>Contains all the information about a message nack'd
  2965. from an AMQP broker within the Basic content-class.</summary>
  2966. </member>
  2967. <member name="P:RabbitMQ.Client.Events.BasicNackEventArgs.DeliveryTag">
  2968. <summary>The sequence number of the nack'd message, or the
  2969. closed upper bound of nack'd messages if multiple is
  2970. true.</summary>
  2971. </member>
  2972. <member name="P:RabbitMQ.Client.Events.BasicNackEventArgs.Multiple">
  2973. <summary>Whether this nack applies to one message or
  2974. multiple messages.</summary>
  2975. </member>
  2976. <member name="P:RabbitMQ.Client.Events.BasicNackEventArgs.Requeue">
  2977. <summary>Ignore</summary>
  2978. <remarks>Clients should ignore this field.</remarks>
  2979. </member>
  2980. <member name="T:RabbitMQ.Client.Events.BasicReturnEventArgs">
  2981. <summary>Contains all the information about a message returned
  2982. from an AMQP broker within the Basic content-class.</summary>
  2983. </member>
  2984. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.BasicProperties">
  2985. <summary>The content header of the message.</summary>
  2986. </member>
  2987. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.Body">
  2988. <summary>The message body.</summary>
  2989. </member>
  2990. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.Exchange">
  2991. <summary>The exchange the returned message was originally
  2992. published to.</summary>
  2993. </member>
  2994. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.ReplyCode">
  2995. <summary>The AMQP reason code for the return. See
  2996. RabbitMQ.Client.Framing.*.Constants.</summary>
  2997. </member>
  2998. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.ReplyText">
  2999. <summary>Human-readable text from the broker describing the
  3000. reason for the return.</summary>
  3001. </member>
  3002. <member name="P:RabbitMQ.Client.Events.BasicReturnEventArgs.RoutingKey">
  3003. <summary>The routing key used when the message was
  3004. originally published.</summary>
  3005. </member>
  3006. <member name="M:RabbitMQ.Client.Events.BaseExceptionEventArgs.#ctor(System.Exception)">
  3007. <summary>Wrap an exception thrown by a callback.</summary>
  3008. </member>
  3009. <member name="P:RabbitMQ.Client.Events.BaseExceptionEventArgs.Detail">
  3010. <summary>Access helpful information about the context in
  3011. which the wrapped exception was thrown.</summary>
  3012. </member>
  3013. <member name="P:RabbitMQ.Client.Events.BaseExceptionEventArgs.Exception">
  3014. <summary>Access the wrapped exception.</summary>
  3015. </member>
  3016. <member name="T:RabbitMQ.Client.Events.CallbackExceptionEventArgs">
  3017. <summary>Describes an exception that was thrown during the
  3018. library's invocation of an application-supplied callback
  3019. handler.</summary>
  3020. <remarks>
  3021. <para>
  3022. When an exception is thrown from a callback registered with
  3023. part of the RabbitMQ .NET client library, it is caught,
  3024. packaged into a CallbackExceptionEventArgs, and passed through
  3025. the appropriate IModel's or IConnection's CallbackException
  3026. event handlers. If an exception is thrown in a
  3027. CallbackException handler, it is silently swallowed, as
  3028. CallbackException is the last chance to handle these kinds of
  3029. exception.
  3030. </para>
  3031. <para>
  3032. Code constructing CallbackExceptionEventArgs instances will
  3033. usually place helpful information about the context of the
  3034. call in the IDictionary available through the Detail property.
  3035. </para>
  3036. </remarks>
  3037. </member>
  3038. <member name="T:RabbitMQ.Client.Events.ConnectionBlockedEventArgs">
  3039. <summary>
  3040. Event relating to connection being blocked.
  3041. </summary>
  3042. </member>
  3043. <member name="P:RabbitMQ.Client.Events.ConnectionBlockedEventArgs.Reason">
  3044. <summary>
  3045. Access the reason why connection is blocked.
  3046. </summary>
  3047. </member>
  3048. <member name="T:RabbitMQ.Client.Events.ConsumerEventArgs">
  3049. <summary>Event relating to a successful consumer registration
  3050. or cancellation.</summary>
  3051. </member>
  3052. <member name="M:RabbitMQ.Client.Events.ConsumerEventArgs.#ctor(System.String[])">
  3053. <summary>Construct an event containing the consumer-tags of
  3054. the consumer the event relates to.</summary>
  3055. </member>
  3056. <member name="P:RabbitMQ.Client.Events.ConsumerEventArgs.ConsumerTags">
  3057. <summary>Access the consumer-tags of the consumer the event
  3058. relates to.</summary>
  3059. </member>
  3060. <member name="M:RabbitMQ.Client.Events.ConsumerTagChangedAfterRecoveryEventArgs.#ctor(System.String,System.String)">
  3061. <summary>
  3062. Initializes a new instance of the <see cref="T:RabbitMQ.Client.Events.ConsumerTagChangedAfterRecoveryEventArgs"/> class.
  3063. </summary>
  3064. <param name="tagBefore">The tag before.</param>
  3065. <param name="tagAfter">The tag after.</param>
  3066. </member>
  3067. <member name="P:RabbitMQ.Client.Events.ConsumerTagChangedAfterRecoveryEventArgs.TagBefore">
  3068. <summary>
  3069. Gets the tag before.
  3070. </summary>
  3071. </member>
  3072. <member name="P:RabbitMQ.Client.Events.ConsumerTagChangedAfterRecoveryEventArgs.TagAfter">
  3073. <summary>
  3074. Gets the tag after.
  3075. </summary>
  3076. </member>
  3077. <member name="T:RabbitMQ.Client.Events.EventingBasicConsumer">
  3078. <summary>Experimental class exposing an IBasicConsumer's
  3079. methods as separate events.</summary>
  3080. </member>
  3081. <member name="M:RabbitMQ.Client.Events.EventingBasicConsumer.#ctor(RabbitMQ.Client.IModel)">
  3082. <summary>Constructor which sets the Model property to the
  3083. given value.</summary>
  3084. </member>
  3085. <member name="E:RabbitMQ.Client.Events.EventingBasicConsumer.Received">
  3086. <summary>
  3087. Event fired when a delivery arrives for the consumer.
  3088. </summary>
  3089. <remarks>
  3090. Handlers must copy or fully use delivery body before returning.
  3091. Accessing the body at a later point is unsafe as its memory can
  3092. be already released.
  3093. </remarks>
  3094. </member>
  3095. <member name="E:RabbitMQ.Client.Events.EventingBasicConsumer.Registered">
  3096. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  3097. </member>
  3098. <member name="E:RabbitMQ.Client.Events.EventingBasicConsumer.Shutdown">
  3099. <summary>Fires on model (channel) shutdown, both client and server initiated.</summary>
  3100. </member>
  3101. <member name="E:RabbitMQ.Client.Events.EventingBasicConsumer.Unregistered">
  3102. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  3103. </member>
  3104. <member name="M:RabbitMQ.Client.Events.EventingBasicConsumer.HandleBasicCancelOk(System.String)">
  3105. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  3106. </member>
  3107. <member name="M:RabbitMQ.Client.Events.EventingBasicConsumer.HandleBasicConsumeOk(System.String)">
  3108. <summary>Fires when the server confirms successful consumer cancelation.</summary>
  3109. </member>
  3110. <member name="M:RabbitMQ.Client.Events.EventingBasicConsumer.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  3111. <summary>
  3112. Invoked when a delivery arrives for the consumer.
  3113. </summary>
  3114. <remarks>
  3115. Handlers must copy or fully use delivery body before returning.
  3116. Accessing the body at a later point is unsafe as its memory can
  3117. be already released.
  3118. </remarks>
  3119. </member>
  3120. <member name="M:RabbitMQ.Client.Events.EventingBasicConsumer.HandleModelShutdown(System.Object,RabbitMQ.Client.ShutdownEventArgs)">
  3121. <summary>Fires the Shutdown event.</summary>
  3122. </member>
  3123. <member name="T:RabbitMQ.Client.Events.FlowControlEventArgs">
  3124. <summary>
  3125. Event relating to flow control.
  3126. </summary>
  3127. </member>
  3128. <member name="P:RabbitMQ.Client.Events.FlowControlEventArgs.Active">
  3129. <summary>
  3130. Access the flow control setting.
  3131. </summary>
  3132. </member>
  3133. <member name="M:RabbitMQ.Client.Events.QueueNameChangedAfterRecoveryEventArgs.#ctor(System.String,System.String)">
  3134. <summary>
  3135. Initializes a new instance of the <see cref="T:RabbitMQ.Client.Events.QueueNameChangedAfterRecoveryEventArgs"/> class.
  3136. </summary>
  3137. <param name="nameBefore">The name before.</param>
  3138. <param name="nameAfter">The name after.</param>
  3139. </member>
  3140. <member name="P:RabbitMQ.Client.Events.QueueNameChangedAfterRecoveryEventArgs.NameBefore">
  3141. <summary>
  3142. Gets the name before.
  3143. </summary>
  3144. </member>
  3145. <member name="P:RabbitMQ.Client.Events.QueueNameChangedAfterRecoveryEventArgs.NameAfter">
  3146. <summary>
  3147. Gets the name after.
  3148. </summary>
  3149. </member>
  3150. <member name="T:RabbitMQ.Client.Events.RecoveryExceptionEventArgs">
  3151. <summary>
  3152. Describes an exception that was thrown during
  3153. automatic connection recovery performed by the library.
  3154. </summary>
  3155. </member>
  3156. <member name="T:RabbitMQ.Client.Exceptions.AlreadyClosedException">
  3157. <summary>Thrown when the application tries to make use of a
  3158. session or connection that has already been shut
  3159. down.</summary>
  3160. </member>
  3161. <member name="M:RabbitMQ.Client.Exceptions.AlreadyClosedException.#ctor(RabbitMQ.Client.ShutdownEventArgs)">
  3162. <summary>Construct an instance containing the given
  3163. shutdown reason.</summary>
  3164. </member>
  3165. <member name="T:RabbitMQ.Client.Exceptions.AuthenticationFailureException">
  3166. <summary> Thrown when the cause is an
  3167. authentication failure. </summary>
  3168. </member>
  3169. <member name="T:RabbitMQ.Client.Exceptions.BrokerUnreachableException">
  3170. <summary>Thrown when no connection could be opened during a
  3171. ConnectionFactory.CreateConnection attempt.</summary>
  3172. </member>
  3173. <member name="M:RabbitMQ.Client.Exceptions.BrokerUnreachableException.#ctor(System.Exception)">
  3174. <summary>Construct a BrokerUnreachableException. The inner exception is
  3175. an AggregateException holding the errors from multiple connection attempts.</summary>
  3176. </member>
  3177. <member name="T:RabbitMQ.Client.Exceptions.ChannelAllocationException">
  3178. <summary> Thrown when a SessionManager cannot allocate a new
  3179. channel number, or the requested channel number is already in
  3180. use. </summary>
  3181. </member>
  3182. <member name="M:RabbitMQ.Client.Exceptions.ChannelAllocationException.#ctor">
  3183. <summary>
  3184. Indicates that there are no more free channels.
  3185. </summary>
  3186. </member>
  3187. <member name="M:RabbitMQ.Client.Exceptions.ChannelAllocationException.#ctor(System.Int32)">
  3188. <summary>
  3189. Indicates that the specified channel is in use
  3190. </summary>
  3191. <param name="channel">The requested channel number</param>
  3192. </member>
  3193. <member name="P:RabbitMQ.Client.Exceptions.ChannelAllocationException.Channel">
  3194. <summary>Retrieves the channel number concerned; will
  3195. return -1 in the case where "no more free channels" is
  3196. being signaled, or a non-negative integer when "channel is
  3197. in use" is being signaled.</summary>
  3198. </member>
  3199. <member name="T:RabbitMQ.Client.Exceptions.ChannelErrorException">
  3200. <summary> Thrown when the server sends a frame along a channel
  3201. that we do not currently have a Session entry in our
  3202. SessionManager for. </summary>
  3203. </member>
  3204. <member name="P:RabbitMQ.Client.Exceptions.ChannelErrorException.Channel">
  3205. <summary>The channel number concerned.</summary>
  3206. </member>
  3207. <member name="T:RabbitMQ.Client.Exceptions.ConnectFailureException">
  3208. <summary>Thrown when a connection to the broker fails</summary>
  3209. </member>
  3210. <member name="T:RabbitMQ.Client.Exceptions.HardProtocolException">
  3211. <summary>Subclass of ProtocolException representing problems
  3212. requiring a connection.close.</summary>
  3213. </member>
  3214. <member name="T:RabbitMQ.Client.Exceptions.MalformedFrameException">
  3215. <summary>Thrown when frame parsing code detects an error in the
  3216. wire-protocol encoding of a frame.</summary>
  3217. <remarks>
  3218. For example, potential MalformedFrameException conditions
  3219. include frames too short, frames missing their end marker, and
  3220. invalid protocol negotiation headers.
  3221. </remarks>
  3222. </member>
  3223. <member name="T:RabbitMQ.Client.Exceptions.OperationInterruptedException">
  3224. <summary>
  3225. Thrown when a session is destroyed during an RPC call to a
  3226. broker. For example, if a TCP connection dropping causes the
  3227. destruction of a session in the middle of a QueueDeclare
  3228. operation, an OperationInterruptedException will be thrown to
  3229. the caller of IModel.QueueDeclare.
  3230. </summary>
  3231. </member>
  3232. <member name="M:RabbitMQ.Client.Exceptions.OperationInterruptedException.#ctor(RabbitMQ.Client.ShutdownEventArgs)">
  3233. <summary>Construct an OperationInterruptedException with
  3234. the passed-in explanation, if any.</summary>
  3235. </member>
  3236. <member name="M:RabbitMQ.Client.Exceptions.OperationInterruptedException.#ctor(RabbitMQ.Client.ShutdownEventArgs,System.String)">
  3237. <summary>Construct an OperationInterruptedException with
  3238. the passed-in explanation and prefix, if any.</summary>
  3239. </member>
  3240. <member name="P:RabbitMQ.Client.Exceptions.OperationInterruptedException.ShutdownReason">
  3241. <summary>Retrieves the explanation for the shutdown. May
  3242. return null if no explanation is available.</summary>
  3243. </member>
  3244. <member name="T:RabbitMQ.Client.Exceptions.PacketNotRecognizedException">
  3245. <summary>Thrown to indicate that the peer didn't understand
  3246. the packet received from the client. Peer sent default message
  3247. describing protocol version it is using and transport parameters.
  3248. </summary>
  3249. <remarks>
  3250. The peer's {'A','M','Q','P',txHi,txLo,major,minor} packet is
  3251. decoded into instances of this class.
  3252. </remarks>
  3253. </member>
  3254. <member name="M:RabbitMQ.Client.Exceptions.PacketNotRecognizedException.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  3255. <summary>Fills the new instance's properties with the values passed in.</summary>
  3256. </member>
  3257. <member name="P:RabbitMQ.Client.Exceptions.PacketNotRecognizedException.ServerMajor">
  3258. <summary>The peer's AMQP specification major version.</summary>
  3259. </member>
  3260. <member name="P:RabbitMQ.Client.Exceptions.PacketNotRecognizedException.ServerMinor">
  3261. <summary>The peer's AMQP specification minor version.</summary>
  3262. </member>
  3263. <member name="P:RabbitMQ.Client.Exceptions.PacketNotRecognizedException.TransportHigh">
  3264. <summary>The peer's high transport byte.</summary>
  3265. </member>
  3266. <member name="P:RabbitMQ.Client.Exceptions.PacketNotRecognizedException.TransportLow">
  3267. <summary>The peer's low transport byte.</summary>
  3268. </member>
  3269. <member name="T:RabbitMQ.Client.Exceptions.PossibleAuthenticationFailureException">
  3270. <summary> Thrown when the likely cause is an
  3271. authentication failure. </summary>
  3272. </member>
  3273. <member name="T:RabbitMQ.Client.Exceptions.ProtocolException">
  3274. <summary> Instances of subclasses of subclasses
  3275. HardProtocolException and SoftProtocolException are thrown in
  3276. situations when we detect a problem with the connection-,
  3277. channel- or wire-level parts of the AMQP protocol. </summary>
  3278. </member>
  3279. <member name="P:RabbitMQ.Client.Exceptions.ProtocolException.ReplyCode">
  3280. <summary>Retrieve the reply code to use in a
  3281. connection/channel close method.</summary>
  3282. </member>
  3283. <member name="P:RabbitMQ.Client.Exceptions.ProtocolException.ShutdownReason">
  3284. <summary>Retrieve the shutdown details to use in a
  3285. connection/channel close method. Defaults to using
  3286. ShutdownInitiator.Library, and this.ReplyCode and
  3287. this.Message as the reply code and text,
  3288. respectively.</summary>
  3289. </member>
  3290. <member name="T:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException">
  3291. <summary>Thrown to indicate that the peer does not support the
  3292. wire protocol version we requested immediately after opening
  3293. the TCP socket.</summary>
  3294. </member>
  3295. <member name="M:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  3296. <summary>Fills the new instance's properties with the values passed in.</summary>
  3297. </member>
  3298. <member name="P:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException.ClientMajor">
  3299. <summary>The client's AMQP specification major version.</summary>
  3300. </member>
  3301. <member name="P:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException.ClientMinor">
  3302. <summary>The client's AMQP specification minor version.</summary>
  3303. </member>
  3304. <member name="P:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException.ServerMajor">
  3305. <summary>The peer's AMQP specification major version.</summary>
  3306. </member>
  3307. <member name="P:RabbitMQ.Client.Exceptions.ProtocolVersionMismatchException.ServerMinor">
  3308. <summary>The peer's AMQP specification minor version.</summary>
  3309. </member>
  3310. <member name="M:RabbitMQ.Client.Exceptions.RabbitMQClientException.#ctor">
  3311. <summary>Initializes a new instance of the <see cref="T:RabbitMQ.Client.Exceptions.RabbitMQClientException" /> class.</summary>
  3312. </member>
  3313. <member name="M:RabbitMQ.Client.Exceptions.RabbitMQClientException.#ctor(System.String)">
  3314. <summary>Initializes a new instance of the <see cref="T:RabbitMQ.Client.Exceptions.RabbitMQClientException" /> class with a specified error message.</summary>
  3315. <param name="message">The message that describes the error. </param>
  3316. </member>
  3317. <member name="M:RabbitMQ.Client.Exceptions.RabbitMQClientException.#ctor(System.String,System.Exception)">
  3318. <summary>Initializes a new instance of the <see cref="T:RabbitMQ.Client.Exceptions.RabbitMQClientException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
  3319. <param name="message">The error message that explains the reason for the exception. </param>
  3320. <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
  3321. </member>
  3322. <member name="T:RabbitMQ.Client.Exceptions.SoftProtocolException">
  3323. <summary>Subclass of ProtocolException representing problems
  3324. requiring a channel.close.</summary>
  3325. </member>
  3326. <member name="T:RabbitMQ.Client.Exceptions.SyntaxErrorException">
  3327. <summary> Thrown when our peer sends a frame that contains
  3328. illegal values for one or more fields. </summary>
  3329. </member>
  3330. <member name="T:RabbitMQ.Client.Exceptions.UnexpectedFrameException">
  3331. <summary>
  3332. Thrown when the connection receives a frame that it wasn't expecting.
  3333. </summary>
  3334. </member>
  3335. <member name="T:RabbitMQ.Client.Exceptions.UnexpectedMethodException">
  3336. <summary>
  3337. Thrown when the model receives an RPC reply that it wasn't expecting.
  3338. </summary>
  3339. </member>
  3340. <member name="P:RabbitMQ.Client.Exceptions.UnexpectedMethodException.Method">
  3341. <summary>The unexpected reply method.</summary>
  3342. </member>
  3343. <member name="T:RabbitMQ.Client.Exceptions.UnknownClassOrMethodException">
  3344. <summary>
  3345. Thrown when the protocol handlers detect an unknown class
  3346. number or method number.
  3347. </summary>
  3348. </member>
  3349. <member name="P:RabbitMQ.Client.Exceptions.UnknownClassOrMethodException.ClassId">
  3350. <summary>The AMQP content-class ID.</summary>
  3351. </member>
  3352. <member name="P:RabbitMQ.Client.Exceptions.UnknownClassOrMethodException.MethodId">
  3353. <summary>The AMQP method ID within the content-class, or 0 if none.</summary>
  3354. </member>
  3355. <member name="T:RabbitMQ.Client.Exceptions.UnsupportedMethodException">
  3356. <summary>
  3357. Thrown when the model receives an RPC request it cannot satisfy.
  3358. </summary>
  3359. </member>
  3360. <member name="P:RabbitMQ.Client.Exceptions.UnsupportedMethodException.MethodName">
  3361. <summary>The name of the RPC request that could not be sent.</summary>
  3362. </member>
  3363. <member name="T:RabbitMQ.Client.Exceptions.UnsupportedMethodFieldException">
  3364. <summary>Thrown when the model cannot transmit a method field
  3365. because the version of the protocol the model is implementing
  3366. does not contain a definition for the field in
  3367. question.</summary>
  3368. </member>
  3369. <member name="P:RabbitMQ.Client.Exceptions.UnsupportedMethodFieldException.FieldName">
  3370. <summary>The name of the unsupported field.</summary>
  3371. </member>
  3372. <member name="P:RabbitMQ.Client.Exceptions.UnsupportedMethodFieldException.MethodName">
  3373. <summary>The name of the method involved.</summary>
  3374. </member>
  3375. <member name="T:RabbitMQ.Client.Exceptions.WireFormattingException">
  3376. <summary> Thrown when the wire-formatting code cannot encode a
  3377. particular .NET value to AMQP protocol format. </summary>
  3378. </member>
  3379. <member name="M:RabbitMQ.Client.Exceptions.WireFormattingException.#ctor(System.String)">
  3380. <summary>Construct a WireFormattingException with no
  3381. particular offender (i.e. null)</summary>
  3382. </member>
  3383. <member name="M:RabbitMQ.Client.Exceptions.WireFormattingException.#ctor(System.String,System.Object)">
  3384. <summary>Construct a WireFormattingException with the given
  3385. offender</summary>
  3386. </member>
  3387. <member name="P:RabbitMQ.Client.Exceptions.WireFormattingException.Offender">
  3388. <summary>Object which this exception is complaining about;
  3389. may be null if no particular offender exists</summary>
  3390. </member>
  3391. <member name="T:RabbitMQ.Client.Framing.Impl.AmqpVersion">
  3392. <summary>Represents a version of the AMQP specification.</summary>
  3393. <remarks>
  3394. <para>
  3395. Vendor-specific variants of particular official specification
  3396. versions exist: this class simply represents the AMQP
  3397. specification version, and does not try to represent
  3398. information about any custom variations involved.
  3399. </para>
  3400. <para>
  3401. AMQP version 0-8 peers sometimes advertise themselves as
  3402. version 8-0: for this reason, this class's constructor
  3403. special-cases 8-0, rewriting it at construction time to be 0-8 instead.
  3404. </para>
  3405. </remarks>
  3406. </member>
  3407. <member name="M:RabbitMQ.Client.Framing.Impl.AmqpVersion.#ctor(System.Int32,System.Int32)">
  3408. <summary>
  3409. Construct an <see cref="T:RabbitMQ.Client.Framing.Impl.AmqpVersion"/> from major and minor version numbers.
  3410. </summary>
  3411. <remarks>
  3412. Converts major=8 and minor=0 into major=0 and minor=8. Please see the class comment.
  3413. </remarks>
  3414. </member>
  3415. <member name="P:RabbitMQ.Client.Framing.Impl.AmqpVersion.Major">
  3416. <summary>
  3417. The AMQP specification major version number.
  3418. </summary>
  3419. </member>
  3420. <member name="P:RabbitMQ.Client.Framing.Impl.AmqpVersion.Minor">
  3421. <summary>
  3422. The AMQP specification minor version number.
  3423. </summary>
  3424. </member>
  3425. <member name="M:RabbitMQ.Client.Framing.Impl.AmqpVersion.Equals(System.Object)">
  3426. <summary>
  3427. Implement value-equality comparison.
  3428. </summary>
  3429. </member>
  3430. <member name="M:RabbitMQ.Client.Framing.Impl.AmqpVersion.GetHashCode">
  3431. <summary>
  3432. Implement hashing as for value-equality.
  3433. </summary>
  3434. </member>
  3435. <member name="M:RabbitMQ.Client.Framing.Impl.AmqpVersion.ToString">
  3436. <summary>
  3437. Format appropriately for display.
  3438. </summary>
  3439. <remarks>
  3440. The specification currently uses "MAJOR-MINOR" as a display format.
  3441. </remarks>
  3442. </member>
  3443. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.UpdateSecret(System.String,System.String)">
  3444. <summary>API-side invocation of updating the secret.</summary>
  3445. </member>
  3446. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Abort">
  3447. <summary>API-side invocation of connection abort.</summary>
  3448. </member>
  3449. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Abort(System.UInt16,System.String)">
  3450. <summary>API-side invocation of connection abort.</summary>
  3451. </member>
  3452. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Abort(System.TimeSpan)">
  3453. <summary>API-side invocation of connection abort with timeout.</summary>
  3454. </member>
  3455. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Abort(System.UInt16,System.String,System.TimeSpan)">
  3456. <summary>API-side invocation of connection abort with timeout.</summary>
  3457. </member>
  3458. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Close">
  3459. <summary>API-side invocation of connection.close.</summary>
  3460. </member>
  3461. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Close(System.UInt16,System.String)">
  3462. <summary>API-side invocation of connection.close.</summary>
  3463. </member>
  3464. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Close(System.TimeSpan)">
  3465. <summary>API-side invocation of connection.close with timeout.</summary>
  3466. </member>
  3467. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.Close(System.UInt16,System.String,System.TimeSpan)">
  3468. <summary>API-side invocation of connection.close with timeout.</summary>
  3469. </member>
  3470. <member name="F:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryCommand.BeginAutomaticRecovery">
  3471. <summary>
  3472. Transition to auto-recovery state if not already in that state.
  3473. </summary>
  3474. </member>
  3475. <member name="F:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryCommand.PerformAutomaticRecovery">
  3476. <summary>
  3477. Attempt to recover connection. If connection is recovered, return
  3478. to connected state.
  3479. </summary>
  3480. </member>
  3481. <member name="F:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryConnectionState.Connected">
  3482. <summary>
  3483. Underlying connection is open.
  3484. </summary>
  3485. </member>
  3486. <member name="F:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryConnectionState.Recovering">
  3487. <summary>
  3488. In the process of recovering underlying connection.
  3489. </summary>
  3490. </member>
  3491. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.MainRecoveryLoop">
  3492. <summary>
  3493. This is the main loop for the auto-recovery thread.
  3494. </summary>
  3495. </member>
  3496. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.StopRecoveryLoop">
  3497. <summary>
  3498. Cancels the main recovery loop and will block until the loop finishes, or the timeout
  3499. expires, to prevent Close operations overlapping with recovery operations.
  3500. </summary>
  3501. </member>
  3502. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryLoopRecoveringHandler(RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryCommand)">
  3503. <summary>
  3504. Handles commands when in the Recovering state.
  3505. </summary>
  3506. <param name="command"></param>
  3507. </member>
  3508. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryLoopConnectedHandler(RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.RecoveryCommand)">
  3509. <summary>
  3510. Handles commands when in the Connected state.
  3511. </summary>
  3512. <param name="command"></param>
  3513. </member>
  3514. <member name="M:RabbitMQ.Client.Framing.Impl.AutorecoveringConnection.ScheduleRecoveryRetry">
  3515. <summary>
  3516. Schedule a background Task to signal the command queue when the retry duration has elapsed.
  3517. </summary>
  3518. </member>
  3519. <member name="F:RabbitMQ.Client.Framing.Impl.Connection._appContinuation">
  3520. <summary>Heartbeat frame for transmission. Reusable across connections.</summary>
  3521. </member>
  3522. <member name="P:RabbitMQ.Client.Framing.Impl.Connection.Protocol">
  3523. <summary>Another overload of a Protocol property, useful
  3524. for exposing a tighter type.</summary>
  3525. </member>
  3526. <member name="P:RabbitMQ.Client.Framing.Impl.Connection.RabbitMQ#Client#IConnection#Protocol">
  3527. <summary>Explicit implementation of IConnection.Protocol.</summary>
  3528. </member>
  3529. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Close(RabbitMQ.Client.ShutdownEventArgs,System.Boolean,System.TimeSpan)">
  3530. <summary>Try to close connection in a graceful way</summary>
  3531. <remarks>
  3532. <para>
  3533. Shutdown reason contains code and text assigned when closing the connection,
  3534. as well as the information about what initiated the close
  3535. </para>
  3536. <para>
  3537. Abort flag, if true, signals to close the ongoing connection immediately
  3538. and do not report any errors if it was already closed.
  3539. </para>
  3540. <para>
  3541. Timeout determines how much time internal close operations should be given
  3542. to complete. System.Threading.Timeout.InfiniteTimeSpan value means infinity.
  3543. </para>
  3544. </remarks>
  3545. </member>
  3546. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.ClosingLoop">
  3547. <remarks>
  3548. Loop only used while quiescing. Use only to cleanly close connection
  3549. </remarks>
  3550. </member>
  3551. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.HandleDomainUnload(System.Object,System.EventArgs)">
  3552. <remarks>
  3553. We need to close the socket, otherwise attempting to unload the domain
  3554. could cause a CannotUnloadAppDomainException
  3555. </remarks>
  3556. </member>
  3557. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.OnShutdown">
  3558. <summary>Broadcasts notification of the final shutdown of the connection.</summary>
  3559. </member>
  3560. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.QuiesceChannel(RabbitMQ.Client.Exceptions.SoftProtocolException)">
  3561. <summary>
  3562. Sets the channel named in the SoftProtocolException into
  3563. "quiescing mode", where we issue a channel.close and
  3564. ignore everything except for subsequent channel.close
  3565. messages and the channel.close-ok reply that should
  3566. eventually arrive.
  3567. </summary>
  3568. <remarks>
  3569. <para>
  3570. Since a well-behaved peer will not wait indefinitely before
  3571. issuing the close-ok, we don't bother with a timeout here;
  3572. compare this to the case of a connection.close-ok, where a
  3573. timeout is necessary.
  3574. </para>
  3575. <para>
  3576. We need to send the close method and politely wait for a
  3577. reply before marking the channel as available for reuse.
  3578. </para>
  3579. <para>
  3580. As soon as SoftProtocolException is detected, we should stop
  3581. servicing ordinary application work, and should concentrate
  3582. on bringing down the channel as quickly and gracefully as
  3583. possible. The way this is done, as per the close-protocol,
  3584. is to signal closure up the stack *before* sending the
  3585. channel.close, by invoking ISession.Close. Once the upper
  3586. layers have been signalled, we are free to do what we need
  3587. to do to clean up and shut down the channel.
  3588. </para>
  3589. </remarks>
  3590. </member>
  3591. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.TerminateMainloop">
  3592. <remarks>
  3593. May be called more than once. Should therefore be idempotent.
  3594. </remarks>
  3595. </member>
  3596. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Abort">
  3597. <summary>API-side invocation of connection abort.</summary>
  3598. </member>
  3599. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Abort(System.UInt16,System.String)">
  3600. <summary>API-side invocation of connection abort.</summary>
  3601. </member>
  3602. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Abort(System.TimeSpan)">
  3603. <summary>API-side invocation of connection abort with timeout.</summary>
  3604. </member>
  3605. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Abort(System.UInt16,System.String,System.TimeSpan)">
  3606. <summary>API-side invocation of connection abort with timeout.</summary>
  3607. </member>
  3608. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Close">
  3609. <summary>API-side invocation of connection.close.</summary>
  3610. </member>
  3611. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Close(System.UInt16,System.String)">
  3612. <summary>API-side invocation of connection.close.</summary>
  3613. </member>
  3614. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Close(System.TimeSpan)">
  3615. <summary>API-side invocation of connection.close with timeout.</summary>
  3616. </member>
  3617. <member name="M:RabbitMQ.Client.Framing.Impl.Connection.Close(System.UInt16,System.String,System.TimeSpan)">
  3618. <summary>API-side invocation of connection.close with timeout.</summary>
  3619. </member>
  3620. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionStart">
  3621. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3622. </member>
  3623. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionStartOk">
  3624. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3625. </member>
  3626. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionSecure">
  3627. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3628. </member>
  3629. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionSecureOk">
  3630. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3631. </member>
  3632. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionTune">
  3633. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3634. </member>
  3635. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionTuneOk">
  3636. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3637. </member>
  3638. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionOpen">
  3639. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3640. </member>
  3641. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionOpenOk">
  3642. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3643. </member>
  3644. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionClose">
  3645. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3646. </member>
  3647. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionCloseOk">
  3648. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3649. </member>
  3650. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionBlocked">
  3651. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3652. </member>
  3653. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionUnblocked">
  3654. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3655. </member>
  3656. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionUpdateSecret">
  3657. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3658. </member>
  3659. <member name="T:RabbitMQ.Client.Framing.Impl.ConnectionUpdateSecretOk">
  3660. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3661. </member>
  3662. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelOpen">
  3663. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3664. </member>
  3665. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelOpenOk">
  3666. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3667. </member>
  3668. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelFlow">
  3669. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3670. </member>
  3671. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelFlowOk">
  3672. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3673. </member>
  3674. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelClose">
  3675. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3676. </member>
  3677. <member name="T:RabbitMQ.Client.Framing.Impl.ChannelCloseOk">
  3678. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3679. </member>
  3680. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeDeclare">
  3681. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3682. </member>
  3683. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeDeclareOk">
  3684. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3685. </member>
  3686. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeDelete">
  3687. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3688. </member>
  3689. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeDeleteOk">
  3690. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3691. </member>
  3692. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeBind">
  3693. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3694. </member>
  3695. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeBindOk">
  3696. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3697. </member>
  3698. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeUnbind">
  3699. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3700. </member>
  3701. <member name="T:RabbitMQ.Client.Framing.Impl.ExchangeUnbindOk">
  3702. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3703. </member>
  3704. <member name="T:RabbitMQ.Client.Framing.Impl.QueueDeclare">
  3705. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3706. </member>
  3707. <member name="T:RabbitMQ.Client.Framing.Impl.QueueDeclareOk">
  3708. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3709. </member>
  3710. <member name="T:RabbitMQ.Client.Framing.Impl.QueueBind">
  3711. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3712. </member>
  3713. <member name="T:RabbitMQ.Client.Framing.Impl.QueueBindOk">
  3714. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3715. </member>
  3716. <member name="T:RabbitMQ.Client.Framing.Impl.QueueUnbind">
  3717. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3718. </member>
  3719. <member name="T:RabbitMQ.Client.Framing.Impl.QueueUnbindOk">
  3720. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3721. </member>
  3722. <member name="T:RabbitMQ.Client.Framing.Impl.QueuePurge">
  3723. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3724. </member>
  3725. <member name="T:RabbitMQ.Client.Framing.Impl.QueuePurgeOk">
  3726. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3727. </member>
  3728. <member name="T:RabbitMQ.Client.Framing.Impl.QueueDelete">
  3729. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3730. </member>
  3731. <member name="T:RabbitMQ.Client.Framing.Impl.QueueDeleteOk">
  3732. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3733. </member>
  3734. <member name="T:RabbitMQ.Client.Framing.Impl.BasicQos">
  3735. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3736. </member>
  3737. <member name="T:RabbitMQ.Client.Framing.Impl.BasicQosOk">
  3738. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3739. </member>
  3740. <member name="T:RabbitMQ.Client.Framing.Impl.BasicConsume">
  3741. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3742. </member>
  3743. <member name="T:RabbitMQ.Client.Framing.Impl.BasicConsumeOk">
  3744. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3745. </member>
  3746. <member name="T:RabbitMQ.Client.Framing.Impl.BasicCancel">
  3747. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3748. </member>
  3749. <member name="T:RabbitMQ.Client.Framing.Impl.BasicCancelOk">
  3750. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3751. </member>
  3752. <member name="T:RabbitMQ.Client.Framing.Impl.BasicPublish">
  3753. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3754. </member>
  3755. <member name="T:RabbitMQ.Client.Framing.Impl.BasicReturn">
  3756. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3757. </member>
  3758. <member name="T:RabbitMQ.Client.Framing.Impl.BasicDeliver">
  3759. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3760. </member>
  3761. <member name="T:RabbitMQ.Client.Framing.Impl.BasicGet">
  3762. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3763. </member>
  3764. <member name="T:RabbitMQ.Client.Framing.Impl.BasicGetOk">
  3765. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3766. </member>
  3767. <member name="T:RabbitMQ.Client.Framing.Impl.BasicGetEmpty">
  3768. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3769. </member>
  3770. <member name="T:RabbitMQ.Client.Framing.Impl.BasicAck">
  3771. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3772. </member>
  3773. <member name="T:RabbitMQ.Client.Framing.Impl.BasicReject">
  3774. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3775. </member>
  3776. <member name="T:RabbitMQ.Client.Framing.Impl.BasicRecoverAsync">
  3777. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3778. </member>
  3779. <member name="T:RabbitMQ.Client.Framing.Impl.BasicRecover">
  3780. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3781. </member>
  3782. <member name="T:RabbitMQ.Client.Framing.Impl.BasicRecoverOk">
  3783. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3784. </member>
  3785. <member name="T:RabbitMQ.Client.Framing.Impl.BasicNack">
  3786. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3787. </member>
  3788. <member name="T:RabbitMQ.Client.Framing.Impl.TxSelect">
  3789. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3790. </member>
  3791. <member name="T:RabbitMQ.Client.Framing.Impl.TxSelectOk">
  3792. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3793. </member>
  3794. <member name="T:RabbitMQ.Client.Framing.Impl.TxCommit">
  3795. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3796. </member>
  3797. <member name="T:RabbitMQ.Client.Framing.Impl.TxCommitOk">
  3798. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3799. </member>
  3800. <member name="T:RabbitMQ.Client.Framing.Impl.TxRollback">
  3801. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3802. </member>
  3803. <member name="T:RabbitMQ.Client.Framing.Impl.TxRollbackOk">
  3804. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3805. </member>
  3806. <member name="T:RabbitMQ.Client.Framing.Impl.ConfirmSelect">
  3807. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3808. </member>
  3809. <member name="T:RabbitMQ.Client.Framing.Impl.ConfirmSelectOk">
  3810. <summary>Autogenerated type. Private implementation class - do not use directly.</summary>
  3811. </member>
  3812. <member name="P:RabbitMQ.Client.Framing.Protocol.MajorVersion">
  3813. <summary>Protocol major version (= 0)</summary>
  3814. </member>
  3815. <member name="P:RabbitMQ.Client.Framing.Protocol.MinorVersion">
  3816. <summary>Protocol minor version (= 9)</summary>
  3817. </member>
  3818. <member name="P:RabbitMQ.Client.Framing.Protocol.Revision">
  3819. <summary>Protocol revision (= 1)</summary>
  3820. </member>
  3821. <member name="P:RabbitMQ.Client.Framing.Protocol.ApiName">
  3822. <summary>Protocol API name (= :AMQP_0_9_1)</summary>
  3823. </member>
  3824. <member name="P:RabbitMQ.Client.Framing.Protocol.DefaultPort">
  3825. <summary>Default TCP port (= 5672)</summary>
  3826. </member>
  3827. <member name="T:RabbitMQ.Client.Framing.IConnectionStart">
  3828. <summary>Autogenerated type. AMQP specification method "connection.start".</summary>
  3829. </member>
  3830. <member name="T:RabbitMQ.Client.Framing.IConnectionStartOk">
  3831. <summary>Autogenerated type. AMQP specification method "connection.start-ok".</summary>
  3832. </member>
  3833. <member name="T:RabbitMQ.Client.Framing.IConnectionSecure">
  3834. <summary>Autogenerated type. AMQP specification method "connection.secure".</summary>
  3835. </member>
  3836. <member name="T:RabbitMQ.Client.Framing.IConnectionSecureOk">
  3837. <summary>Autogenerated type. AMQP specification method "connection.secure-ok".</summary>
  3838. </member>
  3839. <member name="T:RabbitMQ.Client.Framing.IConnectionTune">
  3840. <summary>Autogenerated type. AMQP specification method "connection.tune".</summary>
  3841. </member>
  3842. <member name="T:RabbitMQ.Client.Framing.IConnectionTuneOk">
  3843. <summary>Autogenerated type. AMQP specification method "connection.tune-ok".</summary>
  3844. </member>
  3845. <member name="T:RabbitMQ.Client.Framing.IConnectionOpen">
  3846. <summary>Autogenerated type. AMQP specification method "connection.open".</summary>
  3847. </member>
  3848. <member name="T:RabbitMQ.Client.Framing.IConnectionOpenOk">
  3849. <summary>Autogenerated type. AMQP specification method "connection.open-ok".</summary>
  3850. </member>
  3851. <member name="T:RabbitMQ.Client.Framing.IConnectionClose">
  3852. <summary>Autogenerated type. AMQP specification method "connection.close".</summary>
  3853. </member>
  3854. <member name="T:RabbitMQ.Client.Framing.IConnectionCloseOk">
  3855. <summary>Autogenerated type. AMQP specification method "connection.close-ok".</summary>
  3856. </member>
  3857. <member name="T:RabbitMQ.Client.Framing.IConnectionBlocked">
  3858. <summary>Autogenerated type. AMQP specification method "connection.blocked".</summary>
  3859. </member>
  3860. <member name="T:RabbitMQ.Client.Framing.IConnectionUnblocked">
  3861. <summary>Autogenerated type. AMQP specification method "connection.unblocked".</summary>
  3862. </member>
  3863. <member name="T:RabbitMQ.Client.Framing.IConnectionUpdateSecret">
  3864. <summary>Autogenerated type. AMQP specification method "connection.update-secret".</summary>
  3865. </member>
  3866. <member name="T:RabbitMQ.Client.Framing.IConnectionUpdateSecretOk">
  3867. <summary>Autogenerated type. AMQP specification method "connection.update-secret-ok".</summary>
  3868. </member>
  3869. <member name="T:RabbitMQ.Client.Framing.IChannelOpen">
  3870. <summary>Autogenerated type. AMQP specification method "channel.open".</summary>
  3871. </member>
  3872. <member name="T:RabbitMQ.Client.Framing.IChannelOpenOk">
  3873. <summary>Autogenerated type. AMQP specification method "channel.open-ok".</summary>
  3874. </member>
  3875. <member name="T:RabbitMQ.Client.Framing.IChannelFlow">
  3876. <summary>Autogenerated type. AMQP specification method "channel.flow".</summary>
  3877. </member>
  3878. <member name="T:RabbitMQ.Client.Framing.IChannelFlowOk">
  3879. <summary>Autogenerated type. AMQP specification method "channel.flow-ok".</summary>
  3880. </member>
  3881. <member name="T:RabbitMQ.Client.Framing.IChannelClose">
  3882. <summary>Autogenerated type. AMQP specification method "channel.close".</summary>
  3883. </member>
  3884. <member name="T:RabbitMQ.Client.Framing.IChannelCloseOk">
  3885. <summary>Autogenerated type. AMQP specification method "channel.close-ok".</summary>
  3886. </member>
  3887. <member name="T:RabbitMQ.Client.Framing.IExchangeDeclare">
  3888. <summary>Autogenerated type. AMQP specification method "exchange.declare".</summary>
  3889. </member>
  3890. <member name="T:RabbitMQ.Client.Framing.IExchangeDeclareOk">
  3891. <summary>Autogenerated type. AMQP specification method "exchange.declare-ok".</summary>
  3892. </member>
  3893. <member name="T:RabbitMQ.Client.Framing.IExchangeDelete">
  3894. <summary>Autogenerated type. AMQP specification method "exchange.delete".</summary>
  3895. </member>
  3896. <member name="T:RabbitMQ.Client.Framing.IExchangeDeleteOk">
  3897. <summary>Autogenerated type. AMQP specification method "exchange.delete-ok".</summary>
  3898. </member>
  3899. <member name="T:RabbitMQ.Client.Framing.IExchangeBind">
  3900. <summary>Autogenerated type. AMQP specification method "exchange.bind".</summary>
  3901. </member>
  3902. <member name="T:RabbitMQ.Client.Framing.IExchangeBindOk">
  3903. <summary>Autogenerated type. AMQP specification method "exchange.bind-ok".</summary>
  3904. </member>
  3905. <member name="T:RabbitMQ.Client.Framing.IExchangeUnbind">
  3906. <summary>Autogenerated type. AMQP specification method "exchange.unbind".</summary>
  3907. </member>
  3908. <member name="T:RabbitMQ.Client.Framing.IExchangeUnbindOk">
  3909. <summary>Autogenerated type. AMQP specification method "exchange.unbind-ok".</summary>
  3910. </member>
  3911. <member name="T:RabbitMQ.Client.Framing.IQueueDeclare">
  3912. <summary>Autogenerated type. AMQP specification method "queue.declare".</summary>
  3913. </member>
  3914. <member name="T:RabbitMQ.Client.Framing.IQueueDeclareOk">
  3915. <summary>Autogenerated type. AMQP specification method "queue.declare-ok".</summary>
  3916. </member>
  3917. <member name="T:RabbitMQ.Client.Framing.IQueueBind">
  3918. <summary>Autogenerated type. AMQP specification method "queue.bind".</summary>
  3919. </member>
  3920. <member name="T:RabbitMQ.Client.Framing.IQueueBindOk">
  3921. <summary>Autogenerated type. AMQP specification method "queue.bind-ok".</summary>
  3922. </member>
  3923. <member name="T:RabbitMQ.Client.Framing.IQueueUnbind">
  3924. <summary>Autogenerated type. AMQP specification method "queue.unbind".</summary>
  3925. </member>
  3926. <member name="T:RabbitMQ.Client.Framing.IQueueUnbindOk">
  3927. <summary>Autogenerated type. AMQP specification method "queue.unbind-ok".</summary>
  3928. </member>
  3929. <member name="T:RabbitMQ.Client.Framing.IQueuePurge">
  3930. <summary>Autogenerated type. AMQP specification method "queue.purge".</summary>
  3931. </member>
  3932. <member name="T:RabbitMQ.Client.Framing.IQueuePurgeOk">
  3933. <summary>Autogenerated type. AMQP specification method "queue.purge-ok".</summary>
  3934. </member>
  3935. <member name="T:RabbitMQ.Client.Framing.IQueueDelete">
  3936. <summary>Autogenerated type. AMQP specification method "queue.delete".</summary>
  3937. </member>
  3938. <member name="T:RabbitMQ.Client.Framing.IQueueDeleteOk">
  3939. <summary>Autogenerated type. AMQP specification method "queue.delete-ok".</summary>
  3940. </member>
  3941. <member name="T:RabbitMQ.Client.Framing.IBasicQos">
  3942. <summary>Autogenerated type. AMQP specification method "basic.qos".</summary>
  3943. </member>
  3944. <member name="T:RabbitMQ.Client.Framing.IBasicQosOk">
  3945. <summary>Autogenerated type. AMQP specification method "basic.qos-ok".</summary>
  3946. </member>
  3947. <member name="T:RabbitMQ.Client.Framing.IBasicConsume">
  3948. <summary>Autogenerated type. AMQP specification method "basic.consume".</summary>
  3949. </member>
  3950. <member name="T:RabbitMQ.Client.Framing.IBasicConsumeOk">
  3951. <summary>Autogenerated type. AMQP specification method "basic.consume-ok".</summary>
  3952. </member>
  3953. <member name="T:RabbitMQ.Client.Framing.IBasicCancel">
  3954. <summary>Autogenerated type. AMQP specification method "basic.cancel".</summary>
  3955. </member>
  3956. <member name="T:RabbitMQ.Client.Framing.IBasicCancelOk">
  3957. <summary>Autogenerated type. AMQP specification method "basic.cancel-ok".</summary>
  3958. </member>
  3959. <member name="T:RabbitMQ.Client.Framing.IBasicPublish">
  3960. <summary>Autogenerated type. AMQP specification method "basic.publish".</summary>
  3961. </member>
  3962. <member name="T:RabbitMQ.Client.Framing.IBasicReturn">
  3963. <summary>Autogenerated type. AMQP specification method "basic.return".</summary>
  3964. </member>
  3965. <member name="T:RabbitMQ.Client.Framing.IBasicDeliver">
  3966. <summary>Autogenerated type. AMQP specification method "basic.deliver".</summary>
  3967. </member>
  3968. <member name="T:RabbitMQ.Client.Framing.IBasicGet">
  3969. <summary>Autogenerated type. AMQP specification method "basic.get".</summary>
  3970. </member>
  3971. <member name="T:RabbitMQ.Client.Framing.IBasicGetOk">
  3972. <summary>Autogenerated type. AMQP specification method "basic.get-ok".</summary>
  3973. </member>
  3974. <member name="T:RabbitMQ.Client.Framing.IBasicGetEmpty">
  3975. <summary>Autogenerated type. AMQP specification method "basic.get-empty".</summary>
  3976. </member>
  3977. <member name="T:RabbitMQ.Client.Framing.IBasicAck">
  3978. <summary>Autogenerated type. AMQP specification method "basic.ack".</summary>
  3979. </member>
  3980. <member name="T:RabbitMQ.Client.Framing.IBasicReject">
  3981. <summary>Autogenerated type. AMQP specification method "basic.reject".</summary>
  3982. </member>
  3983. <member name="T:RabbitMQ.Client.Framing.IBasicRecoverAsync">
  3984. <summary>Autogenerated type. AMQP specification method "basic.recover-async".</summary>
  3985. </member>
  3986. <member name="T:RabbitMQ.Client.Framing.IBasicRecover">
  3987. <summary>Autogenerated type. AMQP specification method "basic.recover".</summary>
  3988. </member>
  3989. <member name="T:RabbitMQ.Client.Framing.IBasicRecoverOk">
  3990. <summary>Autogenerated type. AMQP specification method "basic.recover-ok".</summary>
  3991. </member>
  3992. <member name="T:RabbitMQ.Client.Framing.IBasicNack">
  3993. <summary>Autogenerated type. AMQP specification method "basic.nack".</summary>
  3994. </member>
  3995. <member name="T:RabbitMQ.Client.Framing.ITxSelect">
  3996. <summary>Autogenerated type. AMQP specification method "tx.select".</summary>
  3997. </member>
  3998. <member name="T:RabbitMQ.Client.Framing.ITxSelectOk">
  3999. <summary>Autogenerated type. AMQP specification method "tx.select-ok".</summary>
  4000. </member>
  4001. <member name="T:RabbitMQ.Client.Framing.ITxCommit">
  4002. <summary>Autogenerated type. AMQP specification method "tx.commit".</summary>
  4003. </member>
  4004. <member name="T:RabbitMQ.Client.Framing.ITxCommitOk">
  4005. <summary>Autogenerated type. AMQP specification method "tx.commit-ok".</summary>
  4006. </member>
  4007. <member name="T:RabbitMQ.Client.Framing.ITxRollback">
  4008. <summary>Autogenerated type. AMQP specification method "tx.rollback".</summary>
  4009. </member>
  4010. <member name="T:RabbitMQ.Client.Framing.ITxRollbackOk">
  4011. <summary>Autogenerated type. AMQP specification method "tx.rollback-ok".</summary>
  4012. </member>
  4013. <member name="T:RabbitMQ.Client.Framing.IConfirmSelect">
  4014. <summary>Autogenerated type. AMQP specification method "confirm.select".</summary>
  4015. </member>
  4016. <member name="T:RabbitMQ.Client.Framing.IConfirmSelectOk">
  4017. <summary>Autogenerated type. AMQP specification method "confirm.select-ok".</summary>
  4018. </member>
  4019. <member name="T:RabbitMQ.Client.Framing.BasicProperties">
  4020. <summary>Autogenerated type. AMQP specification content header properties for content class "basic"</summary>
  4021. </member>
  4022. <member name="P:RabbitMQ.Client.Impl.BasicProperties.AppId">
  4023. <summary>
  4024. Application Id.
  4025. </summary>
  4026. </member>
  4027. <member name="P:RabbitMQ.Client.Impl.BasicProperties.ClusterId">
  4028. <summary>
  4029. Intra-cluster routing identifier (cluster id is deprecated in AMQP 0-9-1).
  4030. </summary>
  4031. </member>
  4032. <member name="P:RabbitMQ.Client.Impl.BasicProperties.ContentEncoding">
  4033. <summary>
  4034. MIME content encoding.
  4035. </summary>
  4036. </member>
  4037. <member name="P:RabbitMQ.Client.Impl.BasicProperties.ContentType">
  4038. <summary>
  4039. MIME content type.
  4040. </summary>
  4041. </member>
  4042. <member name="P:RabbitMQ.Client.Impl.BasicProperties.CorrelationId">
  4043. <summary>
  4044. Application correlation identifier.
  4045. </summary>
  4046. </member>
  4047. <member name="P:RabbitMQ.Client.Impl.BasicProperties.DeliveryMode">
  4048. <summary>
  4049. Non-persistent (1) or persistent (2).
  4050. </summary>
  4051. </member>
  4052. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Expiration">
  4053. <summary>
  4054. Message expiration specification.
  4055. </summary>
  4056. </member>
  4057. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Headers">
  4058. <summary>
  4059. Message header field table. Is of type <see cref="T:System.Collections.Generic.IDictionary`2" />.
  4060. </summary>
  4061. </member>
  4062. <member name="P:RabbitMQ.Client.Impl.BasicProperties.MessageId">
  4063. <summary>
  4064. Application message Id.
  4065. </summary>
  4066. </member>
  4067. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Persistent">
  4068. <summary>
  4069. Sets <see cref="P:RabbitMQ.Client.Impl.BasicProperties.DeliveryMode"/> to either persistent (2) or non-persistent (1).
  4070. </summary>
  4071. </member>
  4072. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Priority">
  4073. <summary>
  4074. Message priority, 0 to 9.
  4075. </summary>
  4076. </member>
  4077. <member name="P:RabbitMQ.Client.Impl.BasicProperties.ReplyTo">
  4078. <summary>
  4079. Destination to reply to.
  4080. </summary>
  4081. </member>
  4082. <member name="P:RabbitMQ.Client.Impl.BasicProperties.ReplyToAddress">
  4083. <summary>
  4084. Convenience property; parses <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ReplyTo"/> property using <see cref="M:RabbitMQ.Client.PublicationAddress.TryParse(System.String,RabbitMQ.Client.PublicationAddress@)"/>,
  4085. and serializes it using <see cref="M:RabbitMQ.Client.PublicationAddress.ToString"/>.
  4086. Returns null if <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ReplyTo"/> property cannot be parsed by <see cref="M:RabbitMQ.Client.PublicationAddress.TryParse(System.String,RabbitMQ.Client.PublicationAddress@)"/>.
  4087. </summary>
  4088. </member>
  4089. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Timestamp">
  4090. <summary>
  4091. Message timestamp.
  4092. </summary>
  4093. </member>
  4094. <member name="P:RabbitMQ.Client.Impl.BasicProperties.Type">
  4095. <summary>
  4096. Message type name.
  4097. </summary>
  4098. </member>
  4099. <member name="P:RabbitMQ.Client.Impl.BasicProperties.UserId">
  4100. <summary>
  4101. User Id.
  4102. </summary>
  4103. </member>
  4104. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearAppId">
  4105. <summary>
  4106. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.AppId"/> property.
  4107. </summary>
  4108. </member>
  4109. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearClusterId">
  4110. <summary>
  4111. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ClusterId"/> property (cluster id is deprecated in AMQP 0-9-1).
  4112. </summary>
  4113. </member>
  4114. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearContentEncoding">
  4115. <summary>
  4116. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ContentEncoding"/> property.
  4117. </summary>
  4118. </member>
  4119. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearContentType">
  4120. <summary>
  4121. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ContentType"/> property.
  4122. </summary>
  4123. </member>
  4124. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearCorrelationId">
  4125. <summary>
  4126. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.CorrelationId"/> property.
  4127. </summary>
  4128. </member>
  4129. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearDeliveryMode">
  4130. <summary>
  4131. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.DeliveryMode"/> property.
  4132. </summary>
  4133. </member>
  4134. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearExpiration">
  4135. <summary>
  4136. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Expiration"/> property.
  4137. </summary>
  4138. </member>
  4139. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearHeaders">
  4140. <summary>
  4141. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Headers"/> property.
  4142. </summary>
  4143. </member>
  4144. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearMessageId">
  4145. <summary>
  4146. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.MessageId"/> property.
  4147. </summary>
  4148. </member>
  4149. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearPriority">
  4150. <summary>
  4151. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Priority"/> property.
  4152. </summary>
  4153. </member>
  4154. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearReplyTo">
  4155. <summary>
  4156. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ReplyTo"/> property.
  4157. </summary>
  4158. </member>
  4159. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearTimestamp">
  4160. <summary>
  4161. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Timestamp"/> property.
  4162. </summary>
  4163. </member>
  4164. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearType">
  4165. <summary>
  4166. Clear the Type property.
  4167. </summary>
  4168. </member>
  4169. <member name="M:RabbitMQ.Client.Impl.BasicProperties.ClearUserId">
  4170. <summary>
  4171. Clear the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.UserId"/> property.
  4172. </summary>
  4173. </member>
  4174. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsAppIdPresent">
  4175. <summary>
  4176. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.AppId"/> property is present.
  4177. </summary>
  4178. </member>
  4179. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsClusterIdPresent">
  4180. <summary>
  4181. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ClusterId"/> property is present (cluster id is deprecated in AMQP 0-9-1).
  4182. </summary>
  4183. </member>
  4184. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsContentEncodingPresent">
  4185. <summary>
  4186. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ContentEncoding"/> property is present.
  4187. </summary>
  4188. </member>
  4189. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsContentTypePresent">
  4190. <summary>
  4191. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ContentType"/> property is present.
  4192. </summary>
  4193. </member>
  4194. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsCorrelationIdPresent">
  4195. <summary>
  4196. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.CorrelationId"/> property is present.
  4197. </summary>
  4198. </member>
  4199. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsDeliveryModePresent">
  4200. <summary>
  4201. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.DeliveryMode"/> property is present.
  4202. </summary>
  4203. </member>
  4204. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsExpirationPresent">
  4205. <summary>
  4206. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Expiration"/> property is present.
  4207. </summary>
  4208. </member>
  4209. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsHeadersPresent">
  4210. <summary>
  4211. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Headers"/> property is present.
  4212. </summary>
  4213. </member>
  4214. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsMessageIdPresent">
  4215. <summary>
  4216. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.MessageId"/> property is present.
  4217. </summary>
  4218. </member>
  4219. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsPriorityPresent">
  4220. <summary>
  4221. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Priority"/> property is present.
  4222. </summary>
  4223. </member>
  4224. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsReplyToPresent">
  4225. <summary>
  4226. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.ReplyTo"/> property is present.
  4227. </summary>
  4228. </member>
  4229. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsTimestampPresent">
  4230. <summary>
  4231. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.Timestamp"/> property is present.
  4232. </summary>
  4233. </member>
  4234. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsTypePresent">
  4235. <summary>
  4236. Returns true if the Type property is present.
  4237. </summary>
  4238. </member>
  4239. <member name="M:RabbitMQ.Client.Impl.BasicProperties.IsUserIdPresent">
  4240. <summary>
  4241. Returns true if the <see cref="P:RabbitMQ.Client.Impl.BasicProperties.UserId"/> UserId property is present.
  4242. </summary>
  4243. </member>
  4244. <member name="P:RabbitMQ.Client.Impl.ContentHeaderBase.ProtocolClassId">
  4245. <summary>
  4246. Retrieve the AMQP class ID of this content header.
  4247. </summary>
  4248. </member>
  4249. <member name="P:RabbitMQ.Client.Impl.ContentHeaderBase.ProtocolClassName">
  4250. <summary>
  4251. Retrieve the AMQP class name of this content header.
  4252. </summary>
  4253. </member>
  4254. <member name="M:RabbitMQ.Client.Impl.ContentHeaderBase.ReadFrom(System.ReadOnlySpan{System.Byte})">
  4255. <summary>
  4256. Fill this instance from the given byte buffer stream.
  4257. </summary>
  4258. </member>
  4259. <member name="M:RabbitMQ.Client.Impl.ContentHeaderPropertyReader.ReadTable">
  4260. <returns>A type of <seealso cref="T:System.Collections.Generic.IDictionary`2"/>.</returns>
  4261. </member>
  4262. <member name="P:RabbitMQ.Client.Impl.Framing.Heartbeat.Payload">
  4263. <summary>
  4264. Compiler trick to directly refer to static data in the assembly, see here: https://github.com/dotnet/roslyn/pull/24621
  4265. </summary>
  4266. </member>
  4267. <member name="P:RabbitMQ.Client.Impl.IFrameHandler.ReadTimeout">
  4268. <summary>Socket read timeout. System.Threading.Timeout.InfiniteTimeSpan signals "infinity".</summary>
  4269. </member>
  4270. <member name="P:RabbitMQ.Client.Impl.IFrameHandler.WriteTimeout">
  4271. <summary>Socket write timeout. System.Threading.Timeout.InfiniteTimeSpan signals "infinity".</summary>
  4272. </member>
  4273. <member name="M:RabbitMQ.Client.Impl.IFrameHandler.ReadFrame">
  4274. <summary>Read a frame from the underlying
  4275. transport. Returns null if the read operation timed out
  4276. (see Timeout property).</summary>
  4277. </member>
  4278. <member name="T:RabbitMQ.Client.Impl.IFullModel">
  4279. <summary>Not part of the public API. Extension of IModel to
  4280. include utilities and connection-setup routines needed by the
  4281. implementation side.</summary>
  4282. <remarks>This interface is used by the API autogeneration
  4283. process. The AMQP XML specifications are read by the spec
  4284. compilation tool, and after the basic method interface and
  4285. implementation classes are generated, this interface is
  4286. scanned, and a spec-version-specific implementation is
  4287. autogenerated. Annotations are used on certain methods, return
  4288. types, and parameters, to customise the details of the
  4289. autogeneration process.</remarks>
  4290. <see cref="T:RabbitMQ.Client.Impl.ModelBase"/>
  4291. <see cref="T:RabbitMQ.Client.Framing.Impl.Model"/>
  4292. </member>
  4293. <member name="M:RabbitMQ.Client.Impl.IFullModel.ConnectionTuneOk(System.UInt16,System.UInt32,System.UInt16)">
  4294. <summary>Sends a Connection.TuneOk. Used during connection
  4295. initialisation.</summary>
  4296. </member>
  4297. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicAck(System.UInt64,System.Boolean)">
  4298. <summary>Handle incoming Basic.Ack methods. Signals a
  4299. BasicAckEvent.</summary>
  4300. </member>
  4301. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicCancelOk(System.String)">
  4302. <summary>Handle incoming Basic.CancelOk methods.</summary>
  4303. </member>
  4304. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicConsumeOk(System.String)">
  4305. <summary>Handle incoming Basic.ConsumeOk methods.</summary>
  4306. </member>
  4307. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicDeliver(System.String,System.UInt64,System.Boolean,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  4308. <summary>Handle incoming Basic.Deliver methods. Dispatches
  4309. to waiting consumers.</summary>
  4310. </member>
  4311. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicGetEmpty">
  4312. <summary>Handle incoming Basic.GetEmpty methods. Routes the
  4313. information to a waiting Basic.Get continuation.</summary>
  4314. <remarks>
  4315. Note that the clusterId field is ignored, as in the
  4316. specification it notes that it is "deprecated pending
  4317. review".
  4318. </remarks>
  4319. </member>
  4320. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicGetOk(System.UInt64,System.Boolean,System.String,System.String,System.UInt32,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  4321. <summary>Handle incoming Basic.GetOk methods. Routes the
  4322. information to a waiting Basic.Get continuation.</summary>
  4323. </member>
  4324. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicNack(System.UInt64,System.Boolean,System.Boolean)">
  4325. <summary>Handle incoming Basic.Nack methods. Signals a
  4326. BasicNackEvent.</summary>
  4327. </member>
  4328. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicRecoverOk">
  4329. <summary>Handle incoming Basic.RecoverOk methods
  4330. received in reply to Basic.Recover.
  4331. </summary>
  4332. </member>
  4333. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleBasicReturn(System.UInt16,System.String,System.String,System.String,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  4334. <summary>Handle incoming Basic.Return methods. Signals a
  4335. BasicReturnEvent.</summary>
  4336. </member>
  4337. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleChannelClose(System.UInt16,System.String,System.UInt16,System.UInt16)">
  4338. <summary>Handle an incoming Channel.Close. Shuts down the
  4339. session and model.</summary>
  4340. </member>
  4341. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleChannelCloseOk">
  4342. <summary>Handle an incoming Channel.CloseOk.</summary>
  4343. </member>
  4344. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleChannelFlow(System.Boolean)">
  4345. <summary>Handle incoming Channel.Flow methods. Either
  4346. stops or resumes sending the methods that have content.</summary>
  4347. </member>
  4348. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionBlocked(System.String)">
  4349. <summary>Handle an incoming Connection.Blocked.</summary>
  4350. </member>
  4351. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionClose(System.UInt16,System.String,System.UInt16,System.UInt16)">
  4352. <summary>Handle an incoming Connection.Close. Shuts down the
  4353. connection and all sessions and models.</summary>
  4354. </member>
  4355. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionOpenOk(System.String)">
  4356. <summary>Handle an incoming Connection.OpenOk.</summary>
  4357. </member>
  4358. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionSecure(System.Byte[])">
  4359. <summary>Handle incoming Connection.Secure
  4360. methods.</summary>
  4361. </member>
  4362. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionStart(System.Byte,System.Byte,System.Collections.Generic.IDictionary{System.String,System.Object},System.Byte[],System.Byte[])">
  4363. <summary>Handle an incoming Connection.Start. Used during
  4364. connection initialisation.</summary>
  4365. </member>
  4366. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionTune(System.UInt16,System.UInt32,System.UInt16)">
  4367. <summary>Handle incoming Connection.Tune
  4368. methods.</summary>
  4369. </member>
  4370. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleConnectionUnblocked">
  4371. <summary>Handle an incominga Connection.Unblocked.</summary>
  4372. </member>
  4373. <member name="M:RabbitMQ.Client.Impl.IFullModel.HandleQueueDeclareOk(System.String,System.UInt32,System.UInt32)">
  4374. <summary>Handle incoming Queue.DeclareOk methods. Routes the
  4375. information to a waiting Queue.DeclareOk continuation.</summary>
  4376. </member>
  4377. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_BasicCancel(System.String,System.Boolean)">
  4378. <summary>Used to send a Basic.Cancel method. The public
  4379. consume API calls this while also managing internal
  4380. datastructures.</summary>
  4381. </member>
  4382. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_BasicConsume(System.String,System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4383. <summary>Used to send a Basic.Consume method. The public
  4384. consume API calls this while also managing internal
  4385. datastructures.</summary>
  4386. </member>
  4387. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_BasicGet(System.String,System.Boolean)">
  4388. <summary>Used to send a Basic.Get. Basic.Get is a special
  4389. case, since it can result in a Basic.GetOk or a
  4390. Basic.GetEmpty, so this level of manual control is
  4391. required.</summary>
  4392. </member>
  4393. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_BasicPublish(System.String,System.String,System.Boolean,RabbitMQ.Client.IBasicProperties,System.ReadOnlyMemory{System.Byte})">
  4394. <summary>Used to send a Basic.Publish method. Called by the
  4395. public publish method after potential null-reference issues
  4396. have been rectified.</summary>
  4397. </member>
  4398. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ChannelClose(System.UInt16,System.String,System.UInt16,System.UInt16)">
  4399. <summary>Used to send a Channel.Close. Called during
  4400. session shutdown.</summary>
  4401. </member>
  4402. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ChannelCloseOk">
  4403. <summary>Used to send a Channel.CloseOk. Called during
  4404. session shutdown.</summary>
  4405. </member>
  4406. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ChannelFlowOk(System.Boolean)">
  4407. <summary>Used to send a Channel.FlowOk. Confirms that
  4408. Channel.Flow from the broker was processed.</summary>
  4409. </member>
  4410. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ChannelOpen(System.String)">
  4411. <summary>Used to send a Channel.Open. Called during session
  4412. initialisation.</summary>
  4413. </member>
  4414. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConfirmSelect(System.Boolean)">
  4415. <summary>Used to send a Confirm.Select method. The public
  4416. confirm API calls this while also managing internal
  4417. datastructures.</summary>
  4418. </member>
  4419. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConnectionClose(System.UInt16,System.String,System.UInt16,System.UInt16)">
  4420. <summary>Used to send a Connection.Close. Called during
  4421. connection shutdown.</summary>
  4422. </member>
  4423. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConnectionCloseOk">
  4424. <summary>Used to send a Connection.CloseOk. Called during
  4425. connection shutdown.</summary>
  4426. </member>
  4427. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConnectionOpen(System.String,System.String,System.Boolean)">
  4428. <summary>Used to send a Connection.Open. Called during
  4429. connection startup.</summary>
  4430. </member>
  4431. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConnectionSecureOk(System.Byte[])">
  4432. <summary>Used to send a Connection.SecureOk. Again, this is
  4433. special, like Basic.Get.</summary>
  4434. </member>
  4435. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ConnectionStartOk(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Byte[],System.String)">
  4436. <summary>Used to send a Connection.StartOk. This is
  4437. special, like Basic.Get.</summary>
  4438. </member>
  4439. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_UpdateSecret(System.Byte[],System.String)">
  4440. <summary>Used to send a Conection.UpdateSecret method. Called by the
  4441. public UpdateSecret method.
  4442. </summary>
  4443. </member>
  4444. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ExchangeBind(System.String,System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4445. <summary>Used to send a Exchange.Bind method. Called by the
  4446. public bind method.
  4447. </summary>
  4448. </member>
  4449. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ExchangeDeclare(System.String,System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4450. <summary>Used to send a Exchange.Declare method. Called by the
  4451. public declare method.
  4452. </summary>
  4453. </member>
  4454. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ExchangeDelete(System.String,System.Boolean,System.Boolean)">
  4455. <summary>Used to send a Exchange.Delete method. Called by the
  4456. public delete method.
  4457. </summary>
  4458. </member>
  4459. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_ExchangeUnbind(System.String,System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4460. <summary>Used to send a Exchange.Unbind method. Called by the
  4461. public unbind method.
  4462. </summary>
  4463. </member>
  4464. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_QueueBind(System.String,System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4465. <summary>Used to send a Queue.Bind method. Called by the
  4466. public bind method.</summary>
  4467. </member>
  4468. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_QueueDeclare(System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  4469. <summary>Used to send a Queue.Declare method. Called by the
  4470. public declare method.</summary>
  4471. </member>
  4472. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_QueueDelete(System.String,System.Boolean,System.Boolean,System.Boolean)">
  4473. <summary>Used to send a Queue.Delete method. Called by the
  4474. public delete method.</summary>
  4475. </member>
  4476. <member name="M:RabbitMQ.Client.Impl.IFullModel._Private_QueuePurge(System.String,System.Boolean)">
  4477. <summary>Used to send a Queue.Purge method. Called by the
  4478. public purge method.</summary>
  4479. </member>
  4480. <member name="T:RabbitMQ.Client.Impl.ConnectionTuneDetails">
  4481. <summary>Essential information from an incoming Connection.Tune
  4482. method.</summary>
  4483. </member>
  4484. <member name="F:RabbitMQ.Client.Impl.ConnectionTuneDetails.m_channelMax">
  4485. <summary>The peer's suggested channel-max parameter.</summary>
  4486. </member>
  4487. <member name="F:RabbitMQ.Client.Impl.ConnectionTuneDetails.m_frameMax">
  4488. <summary>The peer's suggested frame-max parameter.</summary>
  4489. </member>
  4490. <member name="F:RabbitMQ.Client.Impl.ConnectionTuneDetails.m_heartbeatInSeconds">
  4491. <summary>The peer's suggested heartbeat parameter.</summary>
  4492. </member>
  4493. <member name="P:RabbitMQ.Client.Impl.ISession.ChannelNumber">
  4494. <summary>
  4495. Gets the channel number.
  4496. </summary>
  4497. </member>
  4498. <member name="P:RabbitMQ.Client.Impl.ISession.CloseReason">
  4499. <summary>
  4500. Gets the close reason.
  4501. </summary>
  4502. </member>
  4503. <member name="P:RabbitMQ.Client.Impl.ISession.CommandReceived">
  4504. <summary>
  4505. Single recipient - no need for multiple handlers to be informed of arriving commands.
  4506. </summary>
  4507. </member>
  4508. <member name="P:RabbitMQ.Client.Impl.ISession.Connection">
  4509. <summary>
  4510. Gets the connection.
  4511. </summary>
  4512. </member>
  4513. <member name="P:RabbitMQ.Client.Impl.ISession.IsOpen">
  4514. <summary>
  4515. Gets a value indicating whether this session is open.
  4516. </summary>
  4517. </member>
  4518. <member name="E:RabbitMQ.Client.Impl.ISession.SessionShutdown">
  4519. <summary>
  4520. Multicast session shutdown event.
  4521. </summary>
  4522. </member>
  4523. <member name="T:RabbitMQ.Client.Impl.MainSession">
  4524. <summary>Small ISession implementation used only for channel 0.</summary>
  4525. </member>
  4526. <member name="M:RabbitMQ.Client.Impl.MainSession.SetSessionClosing(System.Boolean)">
  4527. <summary> Set channel 0 as quiescing </summary>
  4528. <remarks>
  4529. Method should be idempotent. Cannot use base.Close
  4530. method call because that would prevent us from
  4531. sending/receiving Close/CloseOk commands
  4532. </remarks>
  4533. </member>
  4534. <member name="P:RabbitMQ.Client.Impl.MethodBase.ProtocolClassId">
  4535. <summary>
  4536. Retrieves the class ID number of this method, as defined in the AMQP specification XML.
  4537. </summary>
  4538. </member>
  4539. <member name="P:RabbitMQ.Client.Impl.MethodBase.ProtocolMethodId">
  4540. <summary>
  4541. Retrieves the method ID number of this method, as defined in the AMQP specification XML.
  4542. </summary>
  4543. </member>
  4544. <member name="P:RabbitMQ.Client.Impl.MethodBase.ProtocolMethodName">
  4545. <summary>
  4546. Retrieves the name of this method - for debugging use.
  4547. </summary>
  4548. </member>
  4549. <member name="F:RabbitMQ.Client.Impl.ModelBase.m_connectionStartCell">
  4550. <summary>Only used to kick-start a connection open
  4551. sequence. See <see cref="M:RabbitMQ.Client.Framing.Impl.Connection.Open(System.Boolean)"/> </summary>
  4552. </member>
  4553. <member name="M:RabbitMQ.Client.Impl.ModelBase.OnModelShutdown(RabbitMQ.Client.ShutdownEventArgs)">
  4554. <summary>Broadcasts notification of the final shutdown of the model.</summary>
  4555. <remarks>
  4556. <para>
  4557. Do not call anywhere other than at the end of OnSessionShutdown.
  4558. </para>
  4559. <para>
  4560. Must not be called when m_closeReason == null, because
  4561. otherwise there's a window when a new continuation could be
  4562. being enqueued at the same time as we're broadcasting the
  4563. shutdown event. See the definition of Enqueue() above.
  4564. </para>
  4565. </remarks>
  4566. </member>
  4567. <member name="M:RabbitMQ.Client.Impl.ModelBase.HandleConnectionTune(System.UInt16,System.UInt32,System.UInt16)">
  4568. <summary>Handle incoming Connection.Tune
  4569. methods.</summary>
  4570. </member>
  4571. <member name="T:RabbitMQ.Client.Impl.QuiescingSession">
  4572. <summary>Small ISession implementation used during channel quiescing.</summary>
  4573. </member>
  4574. <member name="T:RabbitMQ.Client.Impl.RpcContinuationQueue">
  4575. <summary>Manages a queue of waiting AMQP RPC requests.</summary>
  4576. <remarks>
  4577. <para>
  4578. Currently, pipelining of requests is forbidden by this
  4579. implementation. The AMQP 0-8 and 0-9 specifications themselves
  4580. forbid pipelining, but only by the skin of their teeth and
  4581. under a somewhat generous reading.
  4582. </para>
  4583. </remarks>
  4584. </member>
  4585. <member name="M:RabbitMQ.Client.Impl.RpcContinuationQueue.Enqueue(RabbitMQ.Client.Impl.IRpcContinuation)">
  4586. <summary>Enqueue a continuation, marking a pending RPC.</summary>
  4587. <remarks>
  4588. <para>
  4589. Continuations are retrieved in FIFO order by calling Next().
  4590. </para>
  4591. <para>
  4592. In the current implementation, only one continuation can
  4593. be queued up at once. Calls to Enqueue() when a
  4594. continuation is already enqueued will result in
  4595. NotSupportedException being thrown.
  4596. </para>
  4597. </remarks>
  4598. </member>
  4599. <member name="M:RabbitMQ.Client.Impl.RpcContinuationQueue.HandleModelShutdown(RabbitMQ.Client.ShutdownEventArgs)">
  4600. <summary>Interrupt all waiting continuations.</summary>
  4601. <remarks>
  4602. <para>
  4603. There's just the one potential waiter in the current
  4604. implementation.
  4605. </para>
  4606. </remarks>
  4607. </member>
  4608. <member name="M:RabbitMQ.Client.Impl.RpcContinuationQueue.Next">
  4609. <summary>Retrieve the next waiting continuation.</summary>
  4610. <remarks>
  4611. <para>
  4612. It is an error to call this method when there are no
  4613. waiting continuations. In the current implementation, if
  4614. this happens, null will be returned (which will usually
  4615. result in an immediate NullPointerException in the
  4616. caller). Correct code will always arrange for a
  4617. continuation to have been Enqueue()d before calling this
  4618. method.
  4619. </para>
  4620. </remarks>
  4621. </member>
  4622. <member name="T:RabbitMQ.Client.Impl.Session">
  4623. <summary>Normal ISession implementation used during normal channel operation.</summary>
  4624. </member>
  4625. <member name="M:RabbitMQ.Client.Impl.SessionManager.AutoCloseConnection">
  4626. <summary>Called from CheckAutoClose, in a separate thread,
  4627. when we decide to close the connection.</summary>
  4628. </member>
  4629. <member name="M:RabbitMQ.Client.Impl.SessionManager.CheckAutoClose">
  4630. <summary>If m_autoClose and there are no active sessions
  4631. remaining, Close()s the connection with reason code
  4632. 200.</summary>
  4633. </member>
  4634. <member name="M:RabbitMQ.Client.Impl.SessionManager.Swap(System.Int32,RabbitMQ.Client.Impl.ISession)">
  4635. <summary>Replace an active session slot with a new ISession
  4636. implementation. Used during channel quiescing.</summary>
  4637. <remarks>
  4638. Make sure you pass in a channelNumber that's currently in
  4639. use, as if the slot is unused, you'll get a null pointer
  4640. exception.
  4641. </remarks>
  4642. </member>
  4643. <member name="T:RabbitMQ.Client.Impl.SslHelper">
  4644. <summary>
  4645. Represents an <see cref="T:RabbitMQ.Client.Impl.SslHelper"/> which does the actual heavy lifting to set up an SSL connection,
  4646. using the config options in an <see cref="T:RabbitMQ.Client.SslOption"/> to make things cleaner.
  4647. </summary>
  4648. </member>
  4649. <member name="M:RabbitMQ.Client.Impl.SslHelper.TcpUpgrade(System.IO.Stream,RabbitMQ.Client.SslOption)">
  4650. <summary>
  4651. Upgrade a Tcp stream to an Ssl stream using the TLS options provided.
  4652. </summary>
  4653. </member>
  4654. <member name="T:RabbitMQ.Client.Impl.TcpClientAdapter">
  4655. <summary>
  4656. Simple wrapper around TcpClient.
  4657. </summary>
  4658. </member>
  4659. <member name="M:RabbitMQ.Client.Impl.WireFormatting.ReadTable(System.ReadOnlySpan{System.Byte},System.Int32@)">
  4660. <summary>Reads an AMQP "table" definition from the reader.</summary>
  4661. <remarks>
  4662. Supports the AMQP 0-8/0-9 standard entry types S, I, D, T
  4663. and F, as well as the QPid-0-8 specific b, d, f, l, s, t,
  4664. x and V types and the AMQP 0-9-1 A type.
  4665. </remarks>
  4666. <returns>A <seealso cref="T:System.Collections.Generic.Dictionary`2"/>.</returns>
  4667. </member>
  4668. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpApigenAttribute">
  4669. <summary>Base class for attributes for controlling the API
  4670. autogeneration process.</summary>
  4671. </member>
  4672. <member name="F:RabbitMQ.Client.Apigen.Attributes.AmqpApigenAttribute.m_namespaceName">
  4673. <summary>The specification namespace (i.e. version) that
  4674. this attribute applies to, or null for all specification
  4675. versions.</summary>
  4676. </member>
  4677. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpMethodDoNotImplementAttribute">
  4678. <summary>Causes the API generator to ignore the attributed method.</summary>
  4679. <remarks>Mostly used to declare convenience overloads of
  4680. various AMQP methods in the IModel interface. Also used
  4681. to omit an autogenerated implementation of a method which
  4682. is not required for one protocol version. The API
  4683. autogeneration process should of course not attempt to produce
  4684. an implementation of the convenience methods, as they will be
  4685. implemented by hand with sensible defaults, delegating to the
  4686. autogenerated variant of the method concerned.</remarks>
  4687. </member>
  4688. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpAsynchronousHandlerAttribute">
  4689. <summary>Causes the API generator to generate asynchronous
  4690. receive code for the attributed method.</summary>
  4691. </member>
  4692. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpUnsupportedAttribute">
  4693. <summary>Causes the API generator to generate
  4694. exception-throwing code for, instead of simply ignoring, the
  4695. attributed method.</summary>
  4696. <see cref="T:RabbitMQ.Client.Apigen.Attributes.AmqpMethodDoNotImplementAttribute"/>
  4697. </member>
  4698. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpFieldMappingAttribute">
  4699. <summary>Informs the API generator which AMQP method field to
  4700. use for either a parameter in a request, or for a simple result
  4701. in a reply.</summary>
  4702. </member>
  4703. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpMethodMappingAttribute">
  4704. <summary>Informs the API generator which AMQP method to use for
  4705. either a request (if applied to an IModel method) or a reply
  4706. (if applied to an IModel method result).</summary>
  4707. </member>
  4708. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpNowaitArgumentAttribute">
  4709. <summary>This attribute, if placed on a parameter in an IModel
  4710. method, causes it to be interpreted as a "nowait" parameter for
  4711. the purposes of autogenerated RPC reply continuation management
  4712. and control.</summary>
  4713. </member>
  4714. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpContentHeaderFactoryAttribute">
  4715. <summary>This attribute, if placed on a method in IModel,
  4716. causes the method to be interpreted as a factory method
  4717. producing a protocol-specific implementation of a common
  4718. content header interface.</summary>
  4719. </member>
  4720. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpContentHeaderMappingAttribute">
  4721. <summary>This attribute, if placed on a parameter in a
  4722. content-carrying IModel method, causes it to be sent as part of
  4723. the content header frame.</summary>
  4724. </member>
  4725. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpContentBodyMappingAttribute">
  4726. <summary>This attribute, if placed on a parameter in a
  4727. content-carrying IModel method, causes it to be sent as part of
  4728. the content body frame.</summary>
  4729. </member>
  4730. <member name="T:RabbitMQ.Client.Apigen.Attributes.AmqpForceOneWayAttribute">
  4731. <summary>This attribute, placed on an IModel method, causes
  4732. what would normally be an RPC, sent with ModelRpc, to be sent
  4733. as if it were oneway, with ModelSend. The assumption that this
  4734. is for a custom continuation (e.g. for BasicConsume/BasicCancel
  4735. etc.)</summary>
  4736. </member>
  4737. <member name="F:RabbitMQ.Client.Constants.FrameMethod">
  4738. <summary>(= 1)</summary>
  4739. </member>
  4740. <member name="F:RabbitMQ.Client.Constants.FrameHeader">
  4741. <summary>(= 2)</summary>
  4742. </member>
  4743. <member name="F:RabbitMQ.Client.Constants.FrameBody">
  4744. <summary>(= 3)</summary>
  4745. </member>
  4746. <member name="F:RabbitMQ.Client.Constants.FrameHeartbeat">
  4747. <summary>(= 8)</summary>
  4748. </member>
  4749. <member name="F:RabbitMQ.Client.Constants.FrameMinSize">
  4750. <summary>(= 4096)</summary>
  4751. </member>
  4752. <member name="F:RabbitMQ.Client.Constants.FrameEnd">
  4753. <summary>(= 206)</summary>
  4754. </member>
  4755. <member name="F:RabbitMQ.Client.Constants.ReplySuccess">
  4756. <summary>(= 200)</summary>
  4757. </member>
  4758. <member name="F:RabbitMQ.Client.Constants.ContentTooLarge">
  4759. <summary>(= 311)</summary>
  4760. </member>
  4761. <member name="F:RabbitMQ.Client.Constants.NoConsumers">
  4762. <summary>(= 313)</summary>
  4763. </member>
  4764. <member name="F:RabbitMQ.Client.Constants.ConnectionForced">
  4765. <summary>(= 320)</summary>
  4766. </member>
  4767. <member name="F:RabbitMQ.Client.Constants.InvalidPath">
  4768. <summary>(= 402)</summary>
  4769. </member>
  4770. <member name="F:RabbitMQ.Client.Constants.AccessRefused">
  4771. <summary>(= 403)</summary>
  4772. </member>
  4773. <member name="F:RabbitMQ.Client.Constants.NotFound">
  4774. <summary>(= 404)</summary>
  4775. </member>
  4776. <member name="F:RabbitMQ.Client.Constants.ResourceLocked">
  4777. <summary>(= 405)</summary>
  4778. </member>
  4779. <member name="F:RabbitMQ.Client.Constants.PreconditionFailed">
  4780. <summary>(= 406)</summary>
  4781. </member>
  4782. <member name="F:RabbitMQ.Client.Constants.FrameError">
  4783. <summary>(= 501)</summary>
  4784. </member>
  4785. <member name="F:RabbitMQ.Client.Constants.SyntaxError">
  4786. <summary>(= 502)</summary>
  4787. </member>
  4788. <member name="F:RabbitMQ.Client.Constants.CommandInvalid">
  4789. <summary>(= 503)</summary>
  4790. </member>
  4791. <member name="F:RabbitMQ.Client.Constants.ChannelError">
  4792. <summary>(= 504)</summary>
  4793. </member>
  4794. <member name="F:RabbitMQ.Client.Constants.UnexpectedFrame">
  4795. <summary>(= 505)</summary>
  4796. </member>
  4797. <member name="F:RabbitMQ.Client.Constants.ResourceError">
  4798. <summary>(= 506)</summary>
  4799. </member>
  4800. <member name="F:RabbitMQ.Client.Constants.NotAllowed">
  4801. <summary>(= 530)</summary>
  4802. </member>
  4803. <member name="F:RabbitMQ.Client.Constants.NotImplemented">
  4804. <summary>(= 540)</summary>
  4805. </member>
  4806. <member name="F:RabbitMQ.Client.Constants.InternalError">
  4807. <summary>(= 541)</summary>
  4808. </member>
  4809. <member name="T:RabbitMQ.Util.BlockingCell`1">
  4810. <summary>A thread-safe single-assignment reference cell.</summary>
  4811. <remarks>
  4812. A fresh BlockingCell holds no value (is empty). Any thread
  4813. reading the Value property when the cell is empty will block
  4814. until a value is made available by some other thread. The Value
  4815. property can only be set once - on the first call, the
  4816. BlockingCell is considered full, and made immutable. Further
  4817. attempts to set Value result in a thrown
  4818. InvalidOperationException.
  4819. </remarks>
  4820. </member>
  4821. <member name="M:RabbitMQ.Util.BlockingCell`1.WaitForValue(System.TimeSpan)">
  4822. <summary>Retrieve the cell's value, waiting for the given
  4823. timeout if no value is immediately available.</summary>
  4824. <remarks>
  4825. <para>
  4826. If a value is present in the cell at the time the call is
  4827. made, the call will return immediately. Otherwise, the
  4828. calling thread blocks until either a value appears, or
  4829. operation times out.
  4830. </para>
  4831. <para>
  4832. If no value was available before the timeout, an exception
  4833. is thrown.
  4834. </para>
  4835. </remarks>
  4836. <exception cref="T:System.TimeoutException" />
  4837. </member>
  4838. <member name="M:RabbitMQ.Util.BlockingCell`1.WaitForValue">
  4839. <summary>Retrieve the cell's value, blocking if none exists
  4840. at present, or supply a value to an empty cell, thereby
  4841. filling it.</summary>
  4842. <exception cref="T:System.TimeoutException" />
  4843. </member>
  4844. <member name="T:RabbitMQ.Util.DebugUtil">
  4845. <summary>Miscellaneous debugging and development utilities.</summary>
  4846. <remarks>
  4847. Not part of the public API.
  4848. </remarks>
  4849. </member>
  4850. <member name="M:RabbitMQ.Util.DebugUtil.Dump(System.Byte[])">
  4851. <summary>Print a hex dump of the supplied bytes to stdout.</summary>
  4852. </member>
  4853. <member name="M:RabbitMQ.Util.DebugUtil.Dump(System.Byte[],System.IO.TextWriter)">
  4854. <summary>Print a hex dump of the supplied bytes to the supplied TextWriter.</summary>
  4855. </member>
  4856. <member name="M:RabbitMQ.Util.DebugUtil.DumpKeyValue(System.String,System.Object,System.IO.TextWriter,System.Int32)">
  4857. <summary>Prints an indented key/value pair; used by DumpProperties()</summary>
  4858. <remarks>Recurses into the value using DumpProperties().</remarks>
  4859. </member>
  4860. <member name="M:RabbitMQ.Util.DebugUtil.DumpProperties(System.Object,System.IO.TextWriter,System.Int32)">
  4861. <summary>Dump properties of objects to the supplied writer.</summary>
  4862. </member>
  4863. <member name="T:RabbitMQ.Util.EitherAlternative">
  4864. <summary>Used internally by class Either.</summary>
  4865. </member>
  4866. <member name="T:RabbitMQ.Util.Either`2">
  4867. <summary>Models the disjoint union of two alternatives, a
  4868. "left" alternative and a "right" alternative.</summary>
  4869. <remarks>Borrowed from ML, Haskell etc.</remarks>
  4870. </member>
  4871. <member name="M:RabbitMQ.Util.Either`2.#ctor(RabbitMQ.Util.EitherAlternative,`0,`1)">
  4872. <summary>Private constructor. Use the static methods Left, Right instead.</summary>
  4873. </member>
  4874. <member name="P:RabbitMQ.Util.Either`2.Alternative">
  4875. <summary>Retrieve the alternative represented by this instance.</summary>
  4876. </member>
  4877. <member name="P:RabbitMQ.Util.Either`2.LeftValue">
  4878. <summary>Retrieve the value carried by this instance.</summary>
  4879. </member>
  4880. <member name="M:RabbitMQ.Util.Either`2.Left(`0)">
  4881. <summary>Constructs an Either instance representing a Left alternative.</summary>
  4882. </member>
  4883. <member name="M:RabbitMQ.Util.Either`2.Right(`1)">
  4884. <summary>Constructs an Either instance representing a Right alternative.</summary>
  4885. </member>
  4886. <member name="T:RabbitMQ.Util.IntAllocator">
  4887. A class for allocating integer IDs in a given range.
  4888. </member>
  4889. <member name="M:RabbitMQ.Util.IntAllocator.#ctor(System.Int32,System.Int32)">
  4890. A class representing a list of inclusive intervals
  4891. Creates an IntAllocator allocating integer IDs within the inclusive range [start, end]
  4892. </member>
  4893. <member name="M:RabbitMQ.Util.IntAllocator.Allocate">
  4894. Allocate a fresh integer from the range, or return -1 if no more integers
  4895. are available. This operation is guaranteed to run in O(1)
  4896. </member>
  4897. <member name="M:RabbitMQ.Util.IntAllocator.Free(System.Int32)">
  4898. Make the provided integer available for allocation again. This operation
  4899. runs in amortized O(sqrt(range size)) time: About every sqrt(range size)
  4900. operations will take O(range_size + number of intervals) to complete and
  4901. the rest run in constant time.
  4902. No error checking is performed, so if you double Free or Free an integer
  4903. that was not originally Allocated the results are undefined. Sorry.
  4904. </member>
  4905. <member name="T:RabbitMQ.Util.SharedQueue">
  4906. <summary>A thread-safe shared queue implementation.</summary>
  4907. </member>
  4908. <member name="T:RabbitMQ.Util.SharedQueue`1">
  4909. <summary>A thread-safe shared queue implementation.</summary>
  4910. </member>
  4911. <member name="F:RabbitMQ.Util.SharedQueue`1.m_isOpen">
  4912. <summary>Flag holding our current status.</summary>
  4913. </member>
  4914. <member name="F:RabbitMQ.Util.SharedQueue`1.m_queue">
  4915. <summary>The shared queue.</summary>
  4916. <remarks>
  4917. Subclasses must ensure appropriate locking discipline when
  4918. accessing this field. See the implementation of Enqueue,
  4919. Dequeue.
  4920. </remarks>
  4921. </member>
  4922. <member name="M:RabbitMQ.Util.SharedQueue`1.Close">
  4923. <summary>Close the queue. Causes all further Enqueue()
  4924. operations to throw EndOfStreamException, and all pending
  4925. or subsequent Dequeue() operations to throw an
  4926. EndOfStreamException once the queue is empty.</summary>
  4927. </member>
  4928. <member name="M:RabbitMQ.Util.SharedQueue`1.Dequeue">
  4929. <summary>Retrieve the first item from the queue, or block if none available</summary>
  4930. <remarks>
  4931. Callers of Dequeue() will block if no items are available
  4932. until some other thread calls Enqueue() or the queue is
  4933. closed. In the latter case this method will throw
  4934. EndOfStreamException.
  4935. </remarks>
  4936. </member>
  4937. <member name="M:RabbitMQ.Util.SharedQueue`1.Dequeue(System.TimeSpan,`0@)">
  4938. <summary>Retrieve the first item from the queue, or return
  4939. nothing if no items are available after the given
  4940. timeout</summary>
  4941. <remarks>
  4942. <para>
  4943. If one or more items are present on the queue at the time
  4944. the call is made, the call will return
  4945. immediately. Otherwise, the calling thread blocks until
  4946. either an item appears on the queue, or
  4947. millisecondsTimeout milliseconds have elapsed.
  4948. </para>
  4949. <para>
  4950. Returns true in the case that an item was available before
  4951. the timeout, in which case the out parameter "result" is
  4952. set to the item itself.
  4953. </para>
  4954. <para>
  4955. If no items were available before the timeout, returns
  4956. false, and sets "result" to null.
  4957. </para>
  4958. <para>
  4959. A timeout of -1 (i.e. System.Threading.Timeout.InfiniteTimeSpan)
  4960. will be interpreted as a command to wait for an
  4961. indefinitely long period of time for an item to become
  4962. available. Usage of such a timeout is equivalent to
  4963. calling Dequeue() with no arguments. See also the MSDN
  4964. documentation for
  4965. System.Threading.Monitor.Wait(object,int).
  4966. </para>
  4967. <para>
  4968. If no items are present and the queue is in a closed
  4969. state, or if at any time while waiting the queue
  4970. transitions to a closed state (by a call to Close()), this
  4971. method will throw EndOfStreamException.
  4972. </para>
  4973. </remarks>
  4974. </member>
  4975. <member name="M:RabbitMQ.Util.SharedQueue`1.DequeueNoWait(`0)">
  4976. <summary>Retrieve the first item from the queue, or return
  4977. defaultValue immediately if no items are
  4978. available</summary>
  4979. <remarks>
  4980. <para>
  4981. If one or more objects are present in the queue at the
  4982. time of the call, the first item is removed from the queue
  4983. and returned. Otherwise, the defaultValue that was passed
  4984. in is returned immediately. This defaultValue may be null,
  4985. or in cases where null is part of the range of the queue,
  4986. may be some other sentinel object. The difference between
  4987. DequeueNoWait() and Dequeue() is that DequeueNoWait() will
  4988. not block when no items are available in the queue,
  4989. whereas Dequeue() will.
  4990. </para>
  4991. <para>
  4992. If at the time of call the queue is empty and in a
  4993. closed state (following a call to Close()), then this
  4994. method will throw EndOfStreamException.
  4995. </para>
  4996. </remarks>
  4997. </member>
  4998. <member name="M:RabbitMQ.Util.SharedQueue`1.Enqueue(`0)">
  4999. <summary>Place an item at the end of the queue.</summary>
  5000. <remarks>
  5001. If there is a thread waiting for an item to arrive, the
  5002. waiting thread will be woken, and the newly Enqueued item
  5003. will be passed to it. If the queue is closed on entry to
  5004. this method, EndOfStreamException will be thrown.
  5005. </remarks>
  5006. </member>
  5007. <member name="M:RabbitMQ.Util.SharedQueue`1.System#Collections#IEnumerable#GetEnumerator">
  5008. <summary>Implementation of the IEnumerable interface, for
  5009. permitting SharedQueue to be used in foreach
  5010. loops.</summary>
  5011. </member>
  5012. <member name="M:RabbitMQ.Util.SharedQueue`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
  5013. <summary>Implementation of the IEnumerable interface, for
  5014. permitting SharedQueue to be used in foreach
  5015. loops.</summary>
  5016. </member>
  5017. <member name="M:RabbitMQ.Util.SharedQueue`1.EnsureIsOpen">
  5018. <summary>Call only when the lock on m_queue is held.</summary>
  5019. <exception cref="T:System.IO.EndOfStreamException" />
  5020. </member>
  5021. <member name="T:RabbitMQ.Util.SharedQueueEnumerator`1">
  5022. <summary>Implementation of the IEnumerator interface, for
  5023. permitting SharedQueue to be used in foreach loops.</summary>
  5024. </member>
  5025. <member name="M:RabbitMQ.Util.SharedQueueEnumerator`1.#ctor(RabbitMQ.Util.SharedQueue{`0})">
  5026. <summary>Construct an enumerator for the given
  5027. SharedQueue.</summary>
  5028. </member>
  5029. <member name="M:RabbitMQ.Util.SharedQueueEnumerator`1.System#Collections#IEnumerator#Reset">
  5030. <summary>Reset()ting a SharedQueue doesn't make sense, so
  5031. this method always throws
  5032. InvalidOperationException.</summary>
  5033. </member>
  5034. </members>
  5035. </doc>