DotNetty.Common.xml 141 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DotNetty.Common</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DotNetty.Common.Concurrency.AbstractEventExecutor">
  8. <summary>
  9. Abstract base class for <see cref="T:DotNetty.Common.Concurrency.IEventExecutor" /> implementations
  10. </summary>
  11. </member>
  12. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.#ctor">
  13. <summary>Creates an instance of <see cref="T:DotNetty.Common.Concurrency.AbstractEventExecutor"/>.</summary>
  14. </member>
  15. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.#ctor(DotNetty.Common.Concurrency.IEventExecutorGroup)">
  16. <summary>Creates an instance of <see cref="T:DotNetty.Common.Concurrency.AbstractEventExecutor"/>.</summary>
  17. </member>
  18. <member name="P:DotNetty.Common.Concurrency.AbstractEventExecutor.IsShuttingDown">
  19. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/>
  20. </member>
  21. <member name="P:DotNetty.Common.Concurrency.AbstractEventExecutor.TerminationCompletion">
  22. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/>
  23. </member>
  24. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.GetNext">
  25. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/>
  26. </member>
  27. <member name="P:DotNetty.Common.Concurrency.AbstractEventExecutor.Parent">
  28. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  29. </member>
  30. <member name="P:DotNetty.Common.Concurrency.AbstractEventExecutor.InEventLoop">
  31. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  32. </member>
  33. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.IsInEventLoop(DotNetty.Common.Concurrency.XThread)">
  34. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  35. </member>
  36. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.Schedule(DotNetty.Common.Concurrency.IRunnable,System.TimeSpan)">
  37. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  38. </member>
  39. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.Schedule(System.Action,System.TimeSpan)">
  40. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  41. </member>
  42. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.Schedule(System.Action{System.Object},System.Object,System.TimeSpan)">
  43. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  44. </member>
  45. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.Schedule(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan)">
  46. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  47. </member>
  48. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action,System.TimeSpan)">
  49. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  50. </member>
  51. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action{System.Object},System.Object,System.TimeSpan,System.Threading.CancellationToken)">
  52. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  53. </member>
  54. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action{System.Object},System.Object,System.TimeSpan)">
  55. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  56. </member>
  57. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action,System.TimeSpan,System.Threading.CancellationToken)">
  58. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  59. </member>
  60. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan)">
  61. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  62. </member>
  63. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ScheduleAsync(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan,System.Threading.CancellationToken)">
  64. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  65. </member>
  66. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ShutdownGracefullyAsync">
  67. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  68. </member>
  69. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.ShutdownGracefullyAsync(System.TimeSpan,System.TimeSpan)">
  70. <inheritdoc cref="T:DotNetty.Common.Concurrency.IScheduledExecutorService"/>
  71. </member>
  72. <member name="M:DotNetty.Common.Concurrency.AbstractEventExecutor.SetCurrentExecutor(DotNetty.Common.Concurrency.IEventExecutor)">
  73. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  74. </member>
  75. <member name="P:DotNetty.Common.Concurrency.AbstractExecutorService.IsShutdown">
  76. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  77. </member>
  78. <member name="P:DotNetty.Common.Concurrency.AbstractExecutorService.IsTerminated">
  79. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  80. </member>
  81. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{``0})">
  82. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  83. </member>
  84. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{``0},System.Threading.CancellationToken)">
  85. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  86. </member>
  87. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{System.Object,``0},System.Object)">
  88. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  89. </member>
  90. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{System.Object,``0},System.Object,System.Threading.CancellationToken)">
  91. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  92. </member>
  93. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{System.Object,System.Object,``0},System.Object,System.Object)">
  94. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  95. </member>
  96. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.SubmitAsync``1(System.Func{System.Object,System.Object,``0},System.Object,System.Object,System.Threading.CancellationToken)">
  97. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutorService"/>
  98. </member>
  99. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.Execute(DotNetty.Common.Concurrency.IRunnable)">
  100. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutor"/>
  101. </member>
  102. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.Execute(System.Action{System.Object},System.Object)">
  103. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutor"/>
  104. </member>
  105. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.Execute(System.Action{System.Object,System.Object},System.Object,System.Object)">
  106. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutor"/>
  107. </member>
  108. <member name="M:DotNetty.Common.Concurrency.AbstractExecutorService.Execute(System.Action)">
  109. <inheritdoc cref="T:DotNetty.Common.Concurrency.IExecutor"/>
  110. </member>
  111. <member name="T:DotNetty.Common.Concurrency.AbstractScheduledEventExecutor">
  112. <summary>
  113. Abstract base class for <see cref="T:DotNetty.Common.Concurrency.IEventExecutor" />s that need to support scheduling.
  114. </summary>
  115. </member>
  116. <member name="M:DotNetty.Common.Concurrency.AbstractScheduledEventExecutor.CancelScheduledTasks">
  117. <summary>
  118. Cancel all scheduled tasks
  119. This method MUST be called only when <see cref="P:DotNetty.Common.Concurrency.IEventExecutor.InEventLoop" /> is <c>true</c>.
  120. </summary>
  121. </member>
  122. <member name="P:DotNetty.Common.Concurrency.IEventExecutor.Parent">
  123. <summary>
  124. Parent <see cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/>.
  125. </summary>
  126. </member>
  127. <member name="P:DotNetty.Common.Concurrency.IEventExecutor.InEventLoop">
  128. <summary>
  129. Returns <c>true</c> if the current <see cref="T:DotNetty.Common.Concurrency.XThread" /> belongs to this event loop,
  130. <c>false</c> otherwise.
  131. </summary>
  132. <remarks>
  133. It is a convenient way to determine whether code can be executed directly or if it
  134. should be posted for execution to this executor instance explicitly to ensure execution in the loop.
  135. </remarks>
  136. </member>
  137. <member name="M:DotNetty.Common.Concurrency.IEventExecutor.IsInEventLoop(DotNetty.Common.Concurrency.XThread)">
  138. <summary>
  139. Returns <c>true</c> if the given <see cref="T:DotNetty.Common.Concurrency.XThread" /> belongs to this event loop,
  140. <c>false></c> otherwise.
  141. </summary>
  142. </member>
  143. <member name="T:DotNetty.Common.Concurrency.IEventExecutorGroup">
  144. <summary>
  145. Provides an access to a set of <see cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>s it manages.
  146. </summary>
  147. </member>
  148. <member name="P:DotNetty.Common.Concurrency.IEventExecutorGroup.IsShuttingDown">
  149. <summary>
  150. Returns <c>true</c> if and only if this executor is being shut down via <see cref="M:DotNetty.Common.Concurrency.IEventExecutorGroup.ShutdownGracefullyAsync" />.
  151. </summary>
  152. </member>
  153. <member name="M:DotNetty.Common.Concurrency.IEventExecutorGroup.ShutdownGracefullyAsync">
  154. <summary>
  155. Terminates this <see cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/> and all its <see cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>s.
  156. </summary>
  157. <returns><see cref="T:System.Threading.Tasks.Task"/> for completion of termination.</returns>
  158. </member>
  159. <member name="M:DotNetty.Common.Concurrency.IEventExecutorGroup.ShutdownGracefullyAsync(System.TimeSpan,System.TimeSpan)">
  160. <summary>
  161. Terminates this <see cref="T:DotNetty.Common.Concurrency.IEventExecutorGroup"/> and all its <see cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>s.
  162. </summary>
  163. <returns><see cref="T:System.Threading.Tasks.Task"/> for completion of termination.</returns>
  164. </member>
  165. <member name="P:DotNetty.Common.Concurrency.IEventExecutorGroup.TerminationCompletion">
  166. <summary>
  167. A <see cref="T:System.Threading.Tasks.Task"/> for completion of termination. <see cref="M:DotNetty.Common.Concurrency.IEventExecutorGroup.ShutdownGracefullyAsync"/>.
  168. </summary>
  169. </member>
  170. <member name="M:DotNetty.Common.Concurrency.IEventExecutorGroup.GetNext">
  171. <summary>
  172. Returns <see cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>.
  173. </summary>
  174. </member>
  175. <member name="M:DotNetty.Common.Concurrency.IExecutor.Execute(DotNetty.Common.Concurrency.IRunnable)">
  176. <summary>
  177. Executes the given task.
  178. </summary>
  179. <remarks>Threading specifics are determined by <c>IEventExecutor</c> implementation.</remarks>
  180. </member>
  181. <member name="M:DotNetty.Common.Concurrency.IExecutor.Execute(System.Action{System.Object},System.Object)">
  182. <summary>
  183. Executes the given action.
  184. </summary>
  185. <remarks>
  186. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  187. different objects is needed.
  188. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  189. </remarks>
  190. </member>
  191. <member name="M:DotNetty.Common.Concurrency.IExecutor.Execute(System.Action)">
  192. <summary>
  193. Executes the given <paramref name="action" />.
  194. </summary>
  195. <remarks>Threading specifics are determined by <c>IEventExecutor</c> implementation.</remarks>
  196. </member>
  197. <member name="M:DotNetty.Common.Concurrency.IExecutor.Execute(System.Action{System.Object,System.Object},System.Object,System.Object)">
  198. <summary>
  199. Executes the given action.
  200. </summary>
  201. <remarks>
  202. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  203. an action against different objects in different context is needed.
  204. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  205. </remarks>
  206. </member>
  207. <member name="P:DotNetty.Common.Concurrency.IExecutorService.IsShutdown">
  208. <summary>
  209. Returns <c>true</c> if this executor has been shut down, <c>false</c> otherwise.
  210. </summary>
  211. </member>
  212. <member name="P:DotNetty.Common.Concurrency.IExecutorService.IsTerminated">
  213. <summary>
  214. Returns <c>true</c> if all tasks have completed following shut down.
  215. </summary>
  216. <remarks>
  217. Note that <see cref="P:DotNetty.Common.Concurrency.IExecutorService.IsTerminated" /> is never <c>true</c> unless <see cref="!:ShutdownGracefullyAsync()" /> was called first.
  218. </remarks>
  219. </member>
  220. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{``0})">
  221. <summary>
  222. Executes the given function and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of
  223. execution.
  224. </summary>
  225. <remarks>
  226. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  227. </remarks>
  228. </member>
  229. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{``0},System.Threading.CancellationToken)">
  230. <summary>
  231. Executes the given action and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of execution.
  232. </summary>
  233. <remarks>
  234. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  235. </remarks>
  236. </member>
  237. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{System.Object,``0},System.Object)">
  238. <summary>
  239. Executes the given action and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of execution.
  240. </summary>
  241. <remarks>
  242. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  243. different objects is needed.
  244. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  245. </remarks>
  246. </member>
  247. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{System.Object,``0},System.Object,System.Threading.CancellationToken)">
  248. <summary>
  249. Executes the given action and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of execution.
  250. </summary>
  251. <remarks>
  252. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  253. different objects is needed.
  254. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  255. </remarks>
  256. </member>
  257. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{System.Object,System.Object,``0},System.Object,System.Object)">
  258. <summary>
  259. Executes the given action and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of execution.
  260. </summary>
  261. <remarks>
  262. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  263. an action against different objects in different context is needed.
  264. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  265. </remarks>
  266. </member>
  267. <member name="M:DotNetty.Common.Concurrency.IExecutorService.SubmitAsync``1(System.Func{System.Object,System.Object,``0},System.Object,System.Object,System.Threading.CancellationToken)">
  268. <summary>
  269. Executes the given action and returns <see cref="T:System.Threading.Tasks.Task`1" /> indicating completion status and result of execution.
  270. </summary>
  271. <remarks>
  272. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  273. an action against different objects in different context is needed.
  274. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  275. </remarks>
  276. </member>
  277. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.Schedule(DotNetty.Common.Concurrency.IRunnable,System.TimeSpan)">
  278. <summary>
  279. Creates and executes a one-shot action that becomes enabled after the given delay.
  280. </summary>
  281. <param name="action">the task to execute</param>
  282. <param name="delay">the time from now to delay execution</param>
  283. <returns>an <see cref="T:DotNetty.Common.Concurrency.IScheduledTask" /> representing pending completion of the task.</returns>
  284. </member>
  285. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.Schedule(System.Action,System.TimeSpan)">
  286. <summary>
  287. Schedules the given action for execution after the specified delay would pass.
  288. </summary>
  289. <remarks>
  290. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  291. </remarks>
  292. </member>
  293. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.Schedule(System.Action{System.Object},System.Object,System.TimeSpan)">
  294. <summary>
  295. Schedules the given action for execution after the specified delay would pass.
  296. </summary>
  297. <remarks>
  298. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  299. different objects is needed.
  300. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  301. </remarks>
  302. </member>
  303. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.Schedule(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan)">
  304. <summary>
  305. Schedules the given action for execution after the specified delay would pass.
  306. </summary>
  307. <remarks>
  308. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  309. an action against different objects in different context is needed.
  310. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  311. </remarks>
  312. </member>
  313. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action{System.Object},System.Object,System.TimeSpan,System.Threading.CancellationToken)">
  314. <summary>
  315. Schedules the given action for execution after the specified delay would pass.
  316. </summary>
  317. <remarks>
  318. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  319. different objects is needed.
  320. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  321. </remarks>
  322. </member>
  323. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action{System.Object},System.Object,System.TimeSpan)">
  324. <summary>
  325. Schedules the given action for execution after the specified delay would pass.
  326. </summary>
  327. <remarks>
  328. <paramref name="state" /> parameter is useful to when repeated execution of an action against
  329. different objects is needed.
  330. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  331. </remarks>
  332. </member>
  333. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action,System.TimeSpan,System.Threading.CancellationToken)">
  334. <summary>
  335. Schedules the given action for execution after the specified delay would pass.
  336. </summary>
  337. <remarks>
  338. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  339. </remarks>
  340. </member>
  341. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action,System.TimeSpan)">
  342. <summary>
  343. Schedules the given action for execution after the specified delay would pass.
  344. </summary>
  345. <remarks>
  346. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  347. </remarks>
  348. </member>
  349. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan)">
  350. <summary>
  351. Schedules the given action for execution after the specified delay would pass.
  352. </summary>
  353. <remarks>
  354. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  355. an action against different objects in different context is needed.
  356. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  357. </remarks>
  358. </member>
  359. <member name="M:DotNetty.Common.Concurrency.IScheduledExecutorService.ScheduleAsync(System.Action{System.Object,System.Object},System.Object,System.Object,System.TimeSpan,System.Threading.CancellationToken)">
  360. <summary>
  361. Schedules the given action for execution after the specified delay would pass.
  362. </summary>
  363. <remarks>
  364. <paramref name="context" /> and <paramref name="state" /> parameters are useful when repeated execution of
  365. an action against different objects in different context is needed.
  366. <para>Threading specifics are determined by <c>IEventExecutor</c> implementation.</para>
  367. </remarks>
  368. </member>
  369. <member name="T:DotNetty.Common.Concurrency.SingleThreadEventExecutor">
  370. <summary>
  371. <see cref="T:DotNetty.Common.Concurrency.IEventExecutor"/> backed by a single thread.
  372. </summary>
  373. </member>
  374. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.#ctor(System.String,System.TimeSpan)">
  375. <summary>Creates a new instance of <see cref="T:DotNetty.Common.Concurrency.SingleThreadEventExecutor"/>.</summary>
  376. </member>
  377. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.#ctor(DotNetty.Common.Concurrency.IEventExecutorGroup,System.String,System.TimeSpan)">
  378. <summary>Creates a new instance of <see cref="T:DotNetty.Common.Concurrency.SingleThreadEventExecutor"/>.</summary>
  379. </member>
  380. <member name="P:DotNetty.Common.Concurrency.SingleThreadEventExecutor.Scheduler">
  381. <summary>
  382. Task Scheduler that will post work to this executor's queue.
  383. </summary>
  384. </member>
  385. <member name="P:DotNetty.Common.Concurrency.SingleThreadEventExecutor.IsShuttingDown">
  386. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  387. </member>
  388. <member name="P:DotNetty.Common.Concurrency.SingleThreadEventExecutor.TerminationCompletion">
  389. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  390. </member>
  391. <member name="P:DotNetty.Common.Concurrency.SingleThreadEventExecutor.IsShutdown">
  392. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  393. </member>
  394. <member name="P:DotNetty.Common.Concurrency.SingleThreadEventExecutor.IsTerminated">
  395. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  396. </member>
  397. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.IsInEventLoop(DotNetty.Common.Concurrency.XThread)">
  398. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  399. </member>
  400. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.Execute(DotNetty.Common.Concurrency.IRunnable)">
  401. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  402. </member>
  403. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.AddShutdownHook(System.Action)">
  404. <summary>
  405. Adds an <see cref="T:System.Action"/> which will be executed on shutdown of this instance.
  406. </summary>
  407. <param name="action">The <see cref="T:System.Action"/> to run on shutdown.</param>
  408. </member>
  409. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.RemoveShutdownHook(System.Action)">
  410. <summary>
  411. Removes a previously added <see cref="T:System.Action"/> from the collection of <see cref="T:System.Action"/>s which will be
  412. executed on shutdown of this instance.
  413. </summary>
  414. <param name="action">The <see cref="T:System.Action"/> to remove.</param>
  415. </member>
  416. <member name="M:DotNetty.Common.Concurrency.SingleThreadEventExecutor.ShutdownGracefullyAsync(System.TimeSpan,System.TimeSpan)">
  417. <inheritdoc cref="T:DotNetty.Common.Concurrency.IEventExecutor"/>
  418. </member>
  419. <member name="M:DotNetty.Common.FastThreadLocal.RemoveAll">
  420. <summary>
  421. Removes all <see cref="T:DotNetty.Common.FastThreadLocal"/> variables bound to the current thread. This operation is useful when you
  422. are in a container environment, and you don't want to leave the thread local variables in the threads you do not
  423. manage.
  424. </summary>
  425. </member>
  426. <member name="M:DotNetty.Common.FastThreadLocal.Destroy">
  427. <summary>
  428. Destroys the data structure that keeps all <see cref="T:DotNetty.Common.FastThreadLocal"/> variables accessed from
  429. non-<see cref="T:DotNetty.Common.FastThreadLocal"/>s. This operation is useful when you are in a container environment, and
  430. you do not want to leave the thread local variables in the threads you do not manage. Call this method when
  431. your application is being unloaded from the container.
  432. </summary>
  433. </member>
  434. <member name="M:DotNetty.Common.FastThreadLocal.Remove(DotNetty.Common.InternalThreadLocalMap)">
  435. <summary>
  436. Sets the value to uninitialized; a proceeding call to get() will trigger a call to GetInitialValue().
  437. </summary>
  438. <param name="threadLocalMap"></param>
  439. </member>
  440. <member name="P:DotNetty.Common.FastThreadLocal`1.Count">
  441. <summary>
  442. Returns the number of thread local variables bound to the current thread.
  443. </summary>
  444. </member>
  445. <member name="P:DotNetty.Common.FastThreadLocal`1.Value">
  446. <summary>
  447. Gets or sets current value for the current thread.
  448. </summary>
  449. </member>
  450. <member name="M:DotNetty.Common.FastThreadLocal`1.Get(DotNetty.Common.InternalThreadLocalMap)">
  451. <summary>
  452. Returns the current value for the specified thread local map.
  453. The specified thread local map must be for the current thread.
  454. </summary>
  455. </member>
  456. <member name="M:DotNetty.Common.FastThreadLocal`1.Set(DotNetty.Common.InternalThreadLocalMap,`0)">
  457. <summary>
  458. Set the value for the specified thread local map. The specified thread local map must be for the current thread.
  459. </summary>
  460. </member>
  461. <member name="M:DotNetty.Common.FastThreadLocal`1.IsSet">
  462. <summary>
  463. Returns <c>true</c> if and only if this thread-local variable is set.
  464. </summary>
  465. </member>
  466. <member name="M:DotNetty.Common.FastThreadLocal`1.IsSet(DotNetty.Common.InternalThreadLocalMap)">
  467. <summary>
  468. Returns <c>true</c> if and only if this thread-local variable is set.
  469. The specified thread local map must be for the current thread.
  470. </summary>
  471. </member>
  472. <member name="M:DotNetty.Common.FastThreadLocal`1.GetInitialValue">
  473. <summary>
  474. Returns the initial value for this thread-local variable.
  475. </summary>
  476. </member>
  477. <member name="M:DotNetty.Common.FastThreadLocal`1.Remove(DotNetty.Common.InternalThreadLocalMap)">
  478. <summary>
  479. Sets the value to uninitialized for the specified thread local map;
  480. a proceeding call to <see cref="M:DotNetty.Common.FastThreadLocal`1.Get(DotNetty.Common.InternalThreadLocalMap)"/> will trigger a call to <see cref="M:DotNetty.Common.FastThreadLocal`1.GetInitialValue"/>.
  481. The specified thread local map must be for the current thread.
  482. </summary>
  483. <param name="threadLocalMap">
  484. The <see cref="T:DotNetty.Common.InternalThreadLocalMap"/> from which this <see cref="T:DotNetty.Common.FastThreadLocal"/> should be removed.
  485. </param>
  486. </member>
  487. <member name="M:DotNetty.Common.FastThreadLocal`1.OnRemoval(`0)">
  488. <summary>
  489. Invoked when this thread local variable is removed by <see cref="M:DotNetty.Common.FastThreadLocal`1.Remove"/>.
  490. </summary>
  491. </member>
  492. <member name="T:DotNetty.Common.InternalThreadLocalMap">
  493. <summary>
  494. The internal data structure that stores the thread-local variables for DotNetty and all
  495. <see cref="T:DotNetty.Common.FastThreadLocal"/>s. Note that this class is for internal use only and is subject to change at any
  496. time. Use <see cref="T:DotNetty.Common.FastThreadLocal"/> unless you know what you are doing.
  497. </summary>
  498. </member>
  499. <member name="F:DotNetty.Common.InternalThreadLocalMap.indexedVariables">
  500. <summary>
  501. Used by <see cref="T:DotNetty.Common.FastThreadLocal"/>.
  502. </summary>
  503. </member>
  504. <member name="M:DotNetty.Common.InternalThreadLocalMap.SetIndexedVariable(System.Int32,System.Object)">
  505. <summary>
  506. Sets a value at the given index in this <see cref="T:DotNetty.Common.InternalThreadLocalMap"/>.
  507. </summary>
  508. <param name="index">The desired index at which a value should be set.</param>
  509. <param name="value">The value to set at the given index.</param>
  510. <returns><c>true</c> if and only if a new thread-local variable has been created.</returns>
  511. </member>
  512. <member name="M:DotNetty.Common.Internal.AppendableCharSequence.Reset">
  513. <summary>
  514. Resets the <see cref="T:DotNetty.Common.Internal.AppendableCharSequence"/>. Be aware this will only reset the current internal
  515. position and not shrink the internal char array.
  516. </summary>
  517. </member>
  518. <member name="M:DotNetty.Common.Internal.AppendableCharSequence.SubStringUnsafe(System.Int32,System.Int32)">
  519. <summary>
  520. Create a new ascii string, this method assumes all chars has been sanitized to ascii chars when appending
  521. to the array.
  522. </summary>
  523. </member>
  524. <member name="T:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1">
  525. Forked from
  526. <a href="https://github.com/JCTools/JCTools">JCTools</a>
  527. .
  528. A concurrent access enabling class used by circular array based queues this class exposes an offset computation
  529. method along with differently memory fenced load/store methods into the underlying array. The class is pre-padded and
  530. the array is padded on either side to help with False sharing prvention. It is expected theat subclasses handle post
  531. padding.
  532. <p />
  533. Offset calculation is separate from access to enable the reuse of a give compute offset.
  534. <p />
  535. Load/Store methods using a
  536. <i>buffer</i>
  537. parameter are provided to allow the prevention of field reload after a
  538. LoadLoad barrier.
  539. <p />
  540. </member>
  541. <member name="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)">
  542. <summary>
  543. Calculates an element offset based on a given array index.
  544. </summary>
  545. <param name="index">The desirable element index.</param>
  546. <returns>The offset in bytes within the array for a given index.</returns>
  547. </member>
  548. <member name="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.SpElement(System.Int64,`0)">
  549. <summary>
  550. A plain store (no ordering/fences) of an element to a given offset.
  551. </summary>
  552. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/>.</param>
  553. <param name="e">A kitty.</param>
  554. </member>
  555. <member name="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.SoElement(System.Int64,`0)">
  556. <summary>
  557. An ordered store(store + StoreStore barrier) of an element to a given offset.
  558. </summary>
  559. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/>.</param>
  560. <param name="e">An orderly kitty.</param>
  561. </member>
  562. <member name="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.LpElement(System.Int64)">
  563. <summary>
  564. A plain load (no ordering/fences) of an element from a given offset.
  565. </summary>
  566. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/>.</param>
  567. <returns>The element at the offset.</returns>
  568. </member>
  569. <member name="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.LvElement(System.Int64)">
  570. <summary>
  571. A volatile load (load + LoadLoad barrier) of an element from a given offset.
  572. </summary>
  573. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/>.</param>
  574. <returns>The element at the offset.</returns>
  575. </member>
  576. <member name="T:DotNetty.Common.Internal.Logging.AbstractInternalLogger">
  577. <summary>
  578. A skeletal implementation of <see cref="T:DotNetty.Common.Internal.Logging.IInternalLogger"/>. This class implements
  579. all methods that have a <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel"/> parameter by default to call
  580. specific logger methods such as <see cref="M:DotNetty.Common.Internal.Logging.AbstractInternalLogger.Info(System.String)"/> or <see cref="P:DotNetty.Common.Internal.Logging.AbstractInternalLogger.InfoEnabled"/>.
  581. </summary>
  582. </member>
  583. <member name="M:DotNetty.Common.Internal.Logging.AbstractInternalLogger.#ctor(System.String)">
  584. <summary>
  585. Creates a new instance.
  586. </summary>
  587. <param name="name">A friendly name for the new logger instance.</param>
  588. </member>
  589. <member name="T:DotNetty.Common.Internal.Logging.FormattingTuple">
  590. <summary>
  591. Holds the results of formatting done by <see cref="T:DotNetty.Common.Internal.Logging.MessageFormatter"/>.
  592. </summary>
  593. </member>
  594. <member name="T:DotNetty.Common.Internal.Logging.IInternalLogger">
  595. <summary>
  596. <em>Internal-use-only</em> logger used by DotNetty. <strong>DO NOT</strong>
  597. access this class outside of DotNetty.
  598. </summary>
  599. </member>
  600. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.Name">
  601. <summary>
  602. Return the name of this <see cref="T:DotNetty.Common.Internal.Logging.IInternalLogger" /> instance.
  603. </summary>
  604. <value>name of this logger instance</value>
  605. </member>
  606. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.TraceEnabled">
  607. <summary>
  608. Is this logger instance enabled for the TRACE level?
  609. </summary>
  610. <value>true if this Logger is enabled for level TRACE, false otherwise.</value>
  611. </member>
  612. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String)">
  613. <summary>
  614. Log a message object at level TRACE.
  615. </summary>
  616. <param name="msg">the message object to be logged</param>
  617. </member>
  618. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Object)">
  619. <summary>
  620. Log a message at level TRACE according to the specified format and
  621. argument.
  622. <para>
  623. This form avoids superfluous object creation when the logger is disabled
  624. for level TRACE.
  625. </para>
  626. </summary>
  627. <param name="format">the format string</param>
  628. <param name="arg">the argument</param>
  629. </member>
  630. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Object,System.Object)">
  631. <summary>
  632. Log a message at level TRACE according to the specified format and
  633. arguments.
  634. <para>
  635. This form avoids superfluous object creation when the logger is disabled
  636. for level TRACE.
  637. </para>
  638. </summary>
  639. <param name="format">the format string</param>
  640. <param name="argA">the first argument</param>
  641. <param name="argB">the second argument</param>
  642. </member>
  643. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Object[])">
  644. <summary>
  645. Log a message at level TRACE according to the specified format and
  646. arguments.
  647. <para>
  648. This form avoids superfluous object creation when the logger is disabled
  649. for level TRACE. However, this variant incurs the hidden
  650. (and relatively small) cost of creating an <c>object[]</c>
  651. before invoking the method,
  652. even if this logger is disabled for TRACE. The variants
  653. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Object)" /> and <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Object,System.Object)" />
  654. arguments exist solely to avoid this hidden cost.
  655. </para>
  656. </summary>
  657. <param name="format">the format string</param>
  658. <param name="arguments">an array of arguments</param>
  659. </member>
  660. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.String,System.Exception)">
  661. <summary>
  662. Log an exception at level TRACE with an accompanying message.
  663. </summary>
  664. <param name="msg">the message accompanying the exception</param>
  665. <param name="t">the exception to log</param>
  666. </member>
  667. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Trace(System.Exception)">
  668. <summary>
  669. Log an exception at level TRACE.
  670. </summary>
  671. <param name="t">the exception to log</param>
  672. </member>
  673. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.DebugEnabled">
  674. <summary>
  675. Is this logger instance enabled for the DEBUG level?
  676. </summary>
  677. <value>true if this Logger is enabled for level DEBUG, false otherwise.</value>
  678. </member>
  679. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String)">
  680. <summary>
  681. Log a message object at level DEBUG.
  682. </summary>
  683. <param name="msg">the message object to be logged</param>
  684. </member>
  685. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Object)">
  686. <summary>
  687. Log a message at level DEBUG according to the specified format and
  688. argument.
  689. <para>
  690. This form avoids superfluous object creation when the logger is disabled
  691. for level DEBUG.
  692. </para>
  693. </summary>
  694. <param name="format">the format string</param>
  695. <param name="arg">the argument</param>
  696. </member>
  697. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Object,System.Object)">
  698. <summary>
  699. Log a message at level DEBUG according to the specified format and
  700. arguments.
  701. <para>
  702. This form avoids superfluous object creation when the logger is disabled
  703. for level DEBUG.
  704. </para>
  705. </summary>
  706. <param name="format">the format string</param>
  707. <param name="argA">the first argument</param>
  708. <param name="argB">the second argument</param>
  709. </member>
  710. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Object[])">
  711. <summary>
  712. Log a message at level DEBUG according to the specified format and
  713. arguments.
  714. <para>
  715. This form avoids superfluous object creation when the logger is disabled
  716. for level DEBUG. However, this variant incurs the hidden
  717. (and relatively small) cost of creating an <c>object[]</c>
  718. before invoking the method,
  719. even if this logger is disabled for DEBUG. The variants
  720. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Object)" /> and <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Object,System.Object)" />
  721. arguments exist solely to avoid this hidden cost.
  722. </para>
  723. </summary>
  724. <param name="format">the format string</param>
  725. <param name="arguments">an array of arguments</param>
  726. </member>
  727. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.String,System.Exception)">
  728. <summary>
  729. Log an exception at level DEBUG with an accompanying message.
  730. </summary>
  731. <param name="msg">the message accompanying the exception</param>
  732. <param name="t">the exception to log</param>
  733. </member>
  734. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Debug(System.Exception)">
  735. <summary>
  736. Log an exception at level DEBUG.
  737. </summary>
  738. <param name="t">the exception to log</param>
  739. </member>
  740. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.InfoEnabled">
  741. <summary>
  742. Is this logger instance enabled for the INFO level?
  743. </summary>
  744. <value>true if this Logger is enabled for level INFO, false otherwise.</value>
  745. </member>
  746. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String)">
  747. <summary>
  748. Log a message object at level INFO.
  749. </summary>
  750. <param name="msg">the message object to be logged</param>
  751. </member>
  752. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Object)">
  753. <summary>
  754. Log a message at level INFO according to the specified format and
  755. argument.
  756. <para>
  757. This form avoids superfluous object creation when the logger is disabled
  758. for level INFO.
  759. </para>
  760. </summary>
  761. <param name="format">the format string</param>
  762. <param name="arg">the argument</param>
  763. </member>
  764. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Object,System.Object)">
  765. <summary>
  766. Log a message at level INFO according to the specified format and
  767. arguments.
  768. <para>
  769. This form avoids superfluous object creation when the logger is disabled
  770. for level INFO.
  771. </para>
  772. </summary>
  773. <param name="format">the format string</param>
  774. <param name="argA">the first argument</param>
  775. <param name="argB">the second argument</param>
  776. </member>
  777. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Object[])">
  778. <summary>
  779. Log a message at level INFO according to the specified format and
  780. arguments.
  781. <para>
  782. This form avoids superfluous object creation when the logger is disabled
  783. for level INFO. However, this variant incurs the hidden
  784. (and relatively small) cost of creating an <c>object[]</c>
  785. before invoking the method,
  786. even if this logger is disabled for INFO. The variants
  787. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Object)" /> and <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Object,System.Object)" />
  788. arguments exist solely to avoid this hidden cost.
  789. </para>
  790. </summary>
  791. <param name="format">the format string</param>
  792. <param name="arguments">an array of arguments</param>
  793. </member>
  794. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.String,System.Exception)">
  795. <summary>
  796. Log an exception at level INFO with an accompanying message.
  797. </summary>
  798. <param name="msg">the message accompanying the exception</param>
  799. <param name="t">the exception to log</param>
  800. </member>
  801. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Info(System.Exception)">
  802. <summary>
  803. Log an exception at level INFO.
  804. </summary>
  805. <param name="t">the exception to log</param>
  806. </member>
  807. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.WarnEnabled">
  808. <summary>
  809. Is this logger instance enabled for the WARN level?
  810. </summary>
  811. <value>true if this Logger is enabled for level WARN, false otherwise.</value>
  812. </member>
  813. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String)">
  814. <summary>
  815. Log a message object at level WARN.
  816. </summary>
  817. <param name="msg">the message object to be logged</param>
  818. </member>
  819. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Object)">
  820. <summary>
  821. Log a message at level WARN according to the specified format and
  822. argument.
  823. <para>
  824. This form avoids superfluous object creation when the logger is disabled
  825. for level WARN.
  826. </para>
  827. </summary>
  828. <param name="format">the format string</param>
  829. <param name="arg">the argument</param>
  830. </member>
  831. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Object[])">
  832. <summary>
  833. Log a message at level WARN according to the specified format and
  834. arguments.
  835. <para>
  836. This form avoids superfluous object creation when the logger is disabled
  837. for level WARN. However, this variant incurs the hidden
  838. (and relatively small) cost of creating an <c>object[]</c>
  839. before invoking the method,
  840. even if this logger is disabled for WARN. The variants
  841. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Object)" /> and <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Object,System.Object)" />
  842. arguments exist solely to avoid this hidden cost.
  843. </para>
  844. </summary>
  845. <param name="format">the format string</param>
  846. <param name="arguments">an array of arguments</param>
  847. </member>
  848. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Object,System.Object)">
  849. <summary>
  850. Log a message at level WARN according to the specified format and
  851. arguments.
  852. <para>
  853. This form avoids superfluous object creation when the logger is disabled
  854. for level WARN.
  855. </para>
  856. </summary>
  857. <param name="format">the format string</param>
  858. <param name="argA">the first argument</param>
  859. <param name="argB">the second argument</param>
  860. </member>
  861. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.String,System.Exception)">
  862. <summary>
  863. Log an exception at level WARN with an accompanying message.
  864. </summary>
  865. <param name="msg">the message accompanying the exception</param>
  866. <param name="t">the exception to log</param>
  867. </member>
  868. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Warn(System.Exception)">
  869. <summary>
  870. Log an exception at level WARN.
  871. </summary>
  872. <param name="t">the exception to log</param>
  873. </member>
  874. <member name="P:DotNetty.Common.Internal.Logging.IInternalLogger.ErrorEnabled">
  875. <summary>
  876. Is this logger instance enabled for the ERROR level?
  877. </summary>
  878. <value>true if this Logger is enabled for level ERROR, false otherwise.</value>
  879. </member>
  880. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String)">
  881. <summary>
  882. Log a message object at level ERROR.
  883. </summary>
  884. <param name="msg">the message object to be logged</param>
  885. </member>
  886. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Object)">
  887. <summary>
  888. Log a message at level ERROR according to the specified format and
  889. argument.
  890. <para>
  891. This form avoids superfluous object creation when the logger is disabled
  892. for level ERROR.
  893. </para>
  894. </summary>
  895. <param name="format">the format string</param>
  896. <param name="arg">the argument</param>
  897. </member>
  898. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Object,System.Object)">
  899. <summary>
  900. Log a message at level ERROR according to the specified format and
  901. arguments.
  902. <para>
  903. This form avoids superfluous object creation when the logger is disabled
  904. for level ERROR.
  905. </para>
  906. </summary>
  907. <param name="format">the format string</param>
  908. <param name="argA">the first argument</param>
  909. <param name="argB">the second argument</param>
  910. </member>
  911. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Object[])">
  912. <summary>
  913. Log a message at level ERROR according to the specified format and
  914. arguments.
  915. <para>
  916. This form avoids superfluous object creation when the logger is disabled
  917. for level ERROR. However, this variant incurs the hidden
  918. (and relatively small) cost of creating an <c>object[]</c>
  919. before invoking the method,
  920. even if this logger is disabled for ERROR. The variants
  921. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Object)" /> and <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Object,System.Object)" />
  922. arguments exist solely to avoid this hidden cost.
  923. </para>
  924. </summary>
  925. <param name="format">the format string</param>
  926. <param name="arguments">an array of arguments</param>
  927. </member>
  928. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.String,System.Exception)">
  929. <summary>
  930. Log an exception at level ERROR with an accompanying message.
  931. </summary>
  932. <param name="msg">the message accompanying the exception</param>
  933. <param name="t">the exception to log</param>
  934. </member>
  935. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Error(System.Exception)">
  936. <summary>
  937. Log an exception at level ERROR.
  938. </summary>
  939. <param name="t">the exception to log</param>
  940. </member>
  941. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.IsEnabled(DotNetty.Common.Internal.Logging.InternalLogLevel)">
  942. <summary>
  943. Is the logger instance enabled for the specified <paramref name="level"/>?
  944. </summary>
  945. <param name="level">log level</param>
  946. <returns>true if this Logger is enabled for the specified <paramref name="level"/>, false otherwise.</returns>
  947. </member>
  948. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String)">
  949. <summary>
  950. Log a message object at a specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" />.
  951. </summary>
  952. <param name="level">log level</param>
  953. <param name="msg">the message object to be logged</param>
  954. </member>
  955. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Object)">
  956. <summary>
  957. Log a message at a specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" /> according to the specified format and
  958. argument.
  959. <para>
  960. This form avoids superfluous object creation when the logger is disabled
  961. for the specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" />.
  962. </para>
  963. </summary>
  964. <param name="level">log level</param>
  965. <param name="format">the format string</param>
  966. <param name="arg">the argument</param>
  967. </member>
  968. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Object,System.Object)">
  969. <summary>
  970. Log a message at a specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" /> according to the specified format and
  971. arguments.
  972. <para>
  973. This form avoids superfluous object creation when the logger is disabled
  974. for the specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" />.
  975. </para>
  976. </summary>
  977. <param name="level">log level</param>
  978. <param name="format">the format string</param>
  979. <param name="argA">the first argument</param>
  980. <param name="argB">the second argument</param>
  981. </member>
  982. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Object[])">
  983. <summary>
  984. Log a message at the specified <paramref name="level"/> according to the specified format
  985. and arguments.
  986. <para>
  987. This form avoids superfluous string concatenation when the logger
  988. is disabled for the specified <paramref name="level"/>. However, this variant incurs the hidden
  989. (and relatively small) cost of creating an <c>object[]</c> before invoking the method,
  990. even if this logger is disabled for the specified <paramref name="level"/>. The variants
  991. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Object)" /> and
  992. <see cref="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Object,System.Object)" /> arguments exist solely
  993. in order to avoid this hidden cost.
  994. </para>
  995. </summary>
  996. <param name="level">log level</param>
  997. <param name="format">the format string</param>
  998. <param name="arguments">an array of arguments</param>
  999. </member>
  1000. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.String,System.Exception)">
  1001. <summary>
  1002. Log an exception at the specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" /> with an
  1003. accompanying message.
  1004. </summary>
  1005. <param name="level">log level</param>
  1006. <param name="msg">the message accompanying the exception</param>
  1007. <param name="t">the exception to log</param>
  1008. </member>
  1009. <member name="M:DotNetty.Common.Internal.Logging.IInternalLogger.Log(DotNetty.Common.Internal.Logging.InternalLogLevel,System.Exception)">
  1010. <summary>
  1011. Log an exception at the specified <see cref="T:DotNetty.Common.Internal.Logging.InternalLogLevel" />.
  1012. </summary>
  1013. <param name="level">log level</param>
  1014. <param name="t">the exception to log</param>
  1015. </member>
  1016. <member name="T:DotNetty.Common.Internal.Logging.InternalLoggerFactory">
  1017. <summary>
  1018. Creates an <see cref="T:DotNetty.Common.Internal.Logging.IInternalLogger" /> or changes the default factory
  1019. implementation. This factory allows you to choose what logging framework
  1020. DotNetty should use. The default factory is own <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> with <see cref="T:DotNetty.Common.Internal.Logging.EventSourceLoggerProvider" /> registered.
  1021. You can change it to your preferred logging framework before other DotNetty classes are loaded:
  1022. <pre>
  1023. <code>InternalLoggerFactory.DefaultFactory = new LoggerFactory();</code>
  1024. </pre>
  1025. Please note that the new default factory is effective only for the classes
  1026. which were loaded after the default factory is changed. Therefore, <see cref="P:DotNetty.Common.Internal.Logging.InternalLoggerFactory.DefaultFactory"/> should be set as early
  1027. as possible and should not be called more than once.
  1028. </summary>
  1029. </member>
  1030. <member name="P:DotNetty.Common.Internal.Logging.InternalLoggerFactory.DefaultFactory">
  1031. <summary>
  1032. Gets or sets the default factory.
  1033. </summary>
  1034. </member>
  1035. <member name="M:DotNetty.Common.Internal.Logging.InternalLoggerFactory.GetInstance``1">
  1036. <summary>
  1037. Creates a new logger instance with the name of the specified type.
  1038. </summary>
  1039. <typeparam name="T">type where logger is used</typeparam>
  1040. <returns>logger instance</returns>
  1041. </member>
  1042. <member name="M:DotNetty.Common.Internal.Logging.InternalLoggerFactory.GetInstance(System.Type)">
  1043. <summary>
  1044. Creates a new logger instance with the name of the specified type.
  1045. </summary>
  1046. <param name="type">type where logger is used</param>
  1047. <returns>logger instance</returns>
  1048. </member>
  1049. <member name="M:DotNetty.Common.Internal.Logging.InternalLoggerFactory.GetInstance(System.String)">
  1050. <summary>
  1051. Creates a new logger instance with the specified name.
  1052. </summary>
  1053. <param name="name">logger name</param>
  1054. <returns>logger instance</returns>
  1055. </member>
  1056. <member name="T:DotNetty.Common.Internal.Logging.InternalLogLevel">
  1057. <summary>
  1058. The log level that <see cref="T:DotNetty.Common.Internal.Logging.IInternalLogger"/> can log at.
  1059. </summary>
  1060. </member>
  1061. <member name="F:DotNetty.Common.Internal.Logging.InternalLogLevel.TRACE">
  1062. <summary>
  1063. 'TRACE' log level.
  1064. </summary>
  1065. </member>
  1066. <member name="F:DotNetty.Common.Internal.Logging.InternalLogLevel.DEBUG">
  1067. <summary>
  1068. 'DEBUG' log level.
  1069. </summary>
  1070. </member>
  1071. <member name="F:DotNetty.Common.Internal.Logging.InternalLogLevel.INFO">
  1072. <summary>
  1073. 'INFO' log level.
  1074. </summary>
  1075. </member>
  1076. <member name="F:DotNetty.Common.Internal.Logging.InternalLogLevel.WARN">
  1077. <summary>
  1078. 'WARN' log level.
  1079. </summary>
  1080. </member>
  1081. <member name="F:DotNetty.Common.Internal.Logging.InternalLogLevel.ERROR">
  1082. <summary>
  1083. 'ERROR' log level.
  1084. </summary>
  1085. </member>
  1086. <member name="T:DotNetty.Common.Internal.Logging.MessageFormatter">
  1087. <summary>
  1088. Formats messages according to very simple substitution rules. Substitutions can be made 1, 2 or more arguments.
  1089. <para>For example,</para>
  1090. <code>
  1091. MessageFormatter.Format(&quot;Hi {}.&quot;, &quot;there&quot;)
  1092. </code>
  1093. <para>
  1094. will return the string "Hi there.".
  1095. </para>
  1096. <para>
  1097. The {} pair is called the <em>formatting anchor</em>. It serves to designate the location where arguments need
  1098. to be substituted within the message pattern.
  1099. </para>
  1100. <para>
  1101. In case your message contains the '{' or the '}' character, you do not have to do anything special unless the
  1102. '}' character immediately follows '{'. For example,
  1103. </para>
  1104. <code>
  1105. MessageFormatter.Format(&quot;Set {1,2,3} is not equal to {}.&quot;, &quot;1,2&quot;);
  1106. </code>
  1107. <para>
  1108. will return the string "Set {1,2,3} is not equal to 1,2.".
  1109. </para>
  1110. <para>
  1111. If for whatever reason you need to place the string "{}" in the message without its <em>formatting anchor</em>
  1112. meaning, then you need to escape the '{' character with '\', that is the backslash character. Only the '{'
  1113. character should be escaped. There is no need to escape the '}' character. For example,
  1114. </para>
  1115. <code>
  1116. MessageFormatter.Format(&quot;Set \\{} is not equal to {}.&quot;, &quot;1,2&quot;);
  1117. </code>
  1118. <para>
  1119. will return the string "Set {} is not equal to 1,2.".
  1120. </para>
  1121. <para>
  1122. The escaping behavior just described can be overridden by escaping the escape character '\'. Calling
  1123. </para>
  1124. <code>
  1125. MessageFormatter.Format(&quot;File name is C:\\\\{}.&quot;, &quot;file.zip&quot;);
  1126. </code>
  1127. <para>
  1128. will return the string "File name is C:\file.zip".
  1129. </para>
  1130. <seealso cref="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object)" />
  1131. <seealso cref="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object,System.Object)" />
  1132. <seealso cref="M:DotNetty.Common.Internal.Logging.MessageFormatter.ArrayFormat(System.String,System.Object[])" />
  1133. </summary>
  1134. </member>
  1135. <member name="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object)">
  1136. <summary>
  1137. Performs single argument substitution for the given <paramref name="messagePattern"/>.
  1138. <para>
  1139. For example,
  1140. </para>
  1141. <code>
  1142. MessageFormatter.Format(&quot;Hi {}.&quot;, &quot;there&quot;);
  1143. </code>
  1144. <para>
  1145. will return the string "Hi there.".
  1146. </para>
  1147. </summary>
  1148. <param name="messagePattern">The message pattern which will be parsed and formatted</param>
  1149. <param name="arg">The argument to be substituted in place of the formatting anchor</param>
  1150. <returns>The formatted message</returns>
  1151. </member>
  1152. <member name="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object,System.Object)">
  1153. <summary>
  1154. Performs a two argument substitution for the given <paramref name="messagePattern"/>.
  1155. <para>
  1156. For example,
  1157. </para>
  1158. <code>
  1159. MessageFormatter.Format(&quot;Hi {}. My name is {}.&quot;, &quot;Alice&quot;, &quot;Bob&quot;);
  1160. </code>
  1161. <para>
  1162. will return the string "Hi Alice. My name is Bob.".
  1163. </para>
  1164. </summary>
  1165. <param name="messagePattern">The message pattern which will be parsed and formatted</param>
  1166. <param name="argA">The argument to be substituted in place of the first formatting anchor</param>
  1167. <param name="argB">The argument to be substituted in place of the second formatting anchor</param>
  1168. <returns>The formatted message</returns>
  1169. </member>
  1170. <member name="M:DotNetty.Common.Internal.Logging.MessageFormatter.ArrayFormat(System.String,System.Object[])">
  1171. <summary>
  1172. Same principle as the <see cref="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object)"/> and <see cref="M:DotNetty.Common.Internal.Logging.MessageFormatter.Format(System.String,System.Object,System.Object)"/>
  1173. methods, except that any number of arguments can be passed in an array.
  1174. </summary>
  1175. <param name="messagePattern">The message pattern which will be parsed and formatted</param>
  1176. <param name="argArray">An array of arguments to be substituted in place of formatting anchors</param>
  1177. <returns>The formatted message</returns>
  1178. </member>
  1179. <member name="F:DotNetty.Common.Internal.MacAddressUtil.MacAddressLength">
  1180. Length of a valid MAC address.
  1181. </member>
  1182. <member name="M:DotNetty.Common.Internal.MacAddressUtil.GetBestAvailableMac">
  1183. Obtains the best MAC address found on local network interfaces.
  1184. Generally speaking, an active network interface used on public
  1185. networks is better than a local network interface.
  1186. <returns>byte array containing a MAC. null if no MAC can be found.</returns>
  1187. </member>
  1188. <member name="M:DotNetty.Common.Internal.MacAddressUtil.FormatAddress(System.Byte[])">
  1189. <param name="addr">byte array of a MAC address.</param>
  1190. <returns>hex formatted MAC address.</returns>
  1191. </member>
  1192. <member name="M:DotNetty.Common.Internal.MacAddressUtil.CompareAddresses(System.Byte[],System.Byte[])">
  1193. <returns>positive - current is better, 0 - cannot tell from MAC addr, negative - candidate is better.</returns>
  1194. </member>
  1195. <member name="M:DotNetty.Common.Internal.MacAddressUtil.CompareAddresses(System.Net.IPAddress,System.Net.IPAddress)">
  1196. <returns>positive - current is better, 0 - cannot tell, negative - candidate is better</returns>
  1197. </member>
  1198. <member name="T:DotNetty.Common.Internal.MpscArrayQueue`1">
  1199. <summary>
  1200. Forked from <a href="https://github.com/JCTools/JCTools">JCTools</a>.
  1201. A Multi-Producer-Single-Consumer queue based on a <see cref="T:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1"/>. This implies
  1202. that any thread may call the Enqueue methods, but only a single thread may call poll/peek for correctness to
  1203. maintained.
  1204. <para>
  1205. This implementation follows patterns documented on the package level for False Sharing protection.
  1206. </para>
  1207. <para>
  1208. This implementation is using the <a href="http://sourceforge.net/projects/mc-fastflow/">Fast Flow</a>
  1209. method for polling from the queue (with minor change to correctly publish the index) and an extension of
  1210. the Leslie Lamport concurrent queue algorithm (originated by Martin Thompson) on the producer side.
  1211. </para>
  1212. </summary>
  1213. <typeparam name="T">The type of each item in the queue.</typeparam>
  1214. </member>
  1215. <member name="M:DotNetty.Common.Internal.MpscArrayQueue`1.TryEnqueue(`0)">
  1216. <summary>
  1217. Lock free Enqueue operation, using a single compare-and-swap. As the class name suggests, access is
  1218. permitted to many threads concurrently.
  1219. </summary>
  1220. <param name="e">The item to enqueue.</param>
  1221. <returns><c>true</c> if the item was added successfully, otherwise <c>false</c>.</returns>
  1222. <seealso cref="M:DotNetty.Common.Internal.IQueue`1.TryEnqueue(`0)"/>
  1223. </member>
  1224. <member name="M:DotNetty.Common.Internal.MpscArrayQueue`1.WeakEnqueue(`0)">
  1225. <summary>
  1226. A wait-free alternative to <see cref="M:DotNetty.Common.Internal.MpscArrayQueue`1.TryEnqueue(`0)"/>, which fails on compare-and-swap failure.
  1227. </summary>
  1228. <param name="e">The item to enqueue.</param>
  1229. <returns><c>1</c> if next element cannot be filled, <c>-1</c> if CAS failed, and <c>0</c> if successful.</returns>
  1230. </member>
  1231. <member name="M:DotNetty.Common.Internal.MpscArrayQueue`1.TryDequeue(`0@)">
  1232. <summary>
  1233. Lock free poll using ordered loads/stores. As class name suggests, access is limited to a single thread.
  1234. </summary>
  1235. <param name="item">The dequeued item.</param>
  1236. <returns><c>true</c> if an item was retrieved, otherwise <c>false</c>.</returns>
  1237. <seealso cref="M:DotNetty.Common.Internal.IQueue`1.TryDequeue(`0@)"/>
  1238. </member>
  1239. <member name="M:DotNetty.Common.Internal.MpscArrayQueue`1.TryPeek(`0@)">
  1240. <summary>
  1241. Lock free peek using ordered loads. As class name suggests access is limited to a single thread.
  1242. </summary>
  1243. <param name="item">The peeked item.</param>
  1244. <returns><c>true</c> if an item was retrieved, otherwise <c>false</c>.</returns>
  1245. <seealso cref="M:DotNetty.Common.Internal.IQueue`1.TryPeek(`0@)"/>
  1246. </member>
  1247. <member name="P:DotNetty.Common.Internal.MpscArrayQueue`1.Count">
  1248. <summary>
  1249. Returns the number of items in this <see cref="T:DotNetty.Common.Internal.MpscArrayQueue`1"/>.
  1250. </summary>
  1251. </member>
  1252. <member name="M:DotNetty.Common.Internal.RefArrayAccessUtil.SpElement``1(``0[],System.Int64,``0)">
  1253. <summary>
  1254. A plain store (no ordering/fences) of an element to a given offset.
  1255. </summary>
  1256. <typeparam name="T">The element type.</typeparam>
  1257. <param name="buffer">The source buffer.</param>
  1258. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/></param>
  1259. <param name="e">An orderly kitty.</param>
  1260. </member>
  1261. <member name="M:DotNetty.Common.Internal.RefArrayAccessUtil.SoElement``1(``0[],System.Int64,``0)">
  1262. <summary>
  1263. An ordered store(store + StoreStore barrier) of an element to a given offset.
  1264. </summary>
  1265. <typeparam name="T">The element type.</typeparam>
  1266. <param name="buffer">The source buffer.</param>
  1267. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/></param>
  1268. <param name="e"></param>
  1269. </member>
  1270. <member name="M:DotNetty.Common.Internal.RefArrayAccessUtil.LpElement``1(``0[],System.Int64)">
  1271. <summary>
  1272. A plain load (no ordering/fences) of an element from a given offset.
  1273. </summary>
  1274. <typeparam name="T">The element type.</typeparam>
  1275. <param name="buffer">The source buffer.</param>
  1276. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/></param>
  1277. <returns>The element at the given <paramref name="offset"/> in the given <paramref name="buffer"/>.</returns>
  1278. </member>
  1279. <member name="M:DotNetty.Common.Internal.RefArrayAccessUtil.LvElement``1(``0[],System.Int64)">
  1280. <summary>
  1281. A volatile load (load + LoadLoad barrier) of an element from a given offset.
  1282. </summary>
  1283. <typeparam name="T">The element type.</typeparam>
  1284. <param name="buffer">The source buffer.</param>
  1285. <param name="offset">Computed via <see cref="M:DotNetty.Common.Internal.ConcurrentCircularArrayQueue`1.CalcElementOffset(System.Int64)"/></param>
  1286. <returns>The element at the given <paramref name="offset"/> in the given <paramref name="buffer"/>.</returns>
  1287. </member>
  1288. <member name="M:DotNetty.Common.Internal.RefArrayAccessUtil.CalcElementOffset(System.Int64,System.Int64)">
  1289. <summary>
  1290. Gets the offset in bytes within the array for a given index.
  1291. </summary>
  1292. <param name="index">The desired element index.</param>
  1293. <param name="mask">Mask for the index.</param>
  1294. <returns>The offset (in bytes) within the array for a given index.</returns>
  1295. </member>
  1296. <member name="M:DotNetty.Common.Internal.BaseLinkedQueuePad0`1.Offer(`0)">
  1297. <summary>
  1298. Called from a producer thread subject to the restrictions appropriate to the implementation and
  1299. according to the <see cref="M:DotNetty.Common.Internal.ILinkedQueue`1.Offer(`0)"/> interface.
  1300. </summary>
  1301. <param name="e">The element to enqueue.</param>
  1302. <returns><c>true</c> if the element was inserted, <c>false</c> iff the queue is full.</returns>
  1303. </member>
  1304. <member name="M:DotNetty.Common.Internal.BaseLinkedQueuePad0`1.Poll">
  1305. <summary>
  1306. Called from the consumer thread subject to the restrictions appropriate to the implementation and
  1307. according to the <see cref="M:DotNetty.Common.Internal.ILinkedQueue`1.Poll"/> interface.
  1308. </summary>
  1309. <returns>A message from the queue if one is available, <c>null</c> iff the queue is empty.</returns>
  1310. </member>
  1311. <member name="M:DotNetty.Common.Internal.BaseLinkedQueuePad0`1.Peek">
  1312. <summary>
  1313. Called from the consumer thread subject to the restrictions appropriate to the implementation and
  1314. according to the <see cref="M:DotNetty.Common.Internal.ILinkedQueue`1.Peek"/> interface.
  1315. </summary>
  1316. <returns>A message from the queue if one is available, <c>null</c> iff the queue is empty.</returns>
  1317. </member>
  1318. <member name="T:DotNetty.Common.Internal.SystemPropertyUtil">
  1319. <summary>
  1320. A collection of utility methods to retrieve and parse the values of the system properties (Environment variables).
  1321. </summary>
  1322. </member>
  1323. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.Contains(System.String)">
  1324. <summary>
  1325. Returns <c>true</c> if and only if the system property with the specified <c>key</c>
  1326. exists.
  1327. </summary>
  1328. </member>
  1329. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.Get(System.String)">
  1330. <summary>
  1331. Returns the value of the system property with the specified
  1332. <c>key</c>, while falling back to <c>null</c> if the property access fails.
  1333. </summary>
  1334. <returns>the property value or <c>null</c></returns>
  1335. </member>
  1336. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.Get(System.String,System.String)">
  1337. <summary>
  1338. Returns the value of the system property with the specified
  1339. <c>key</c>, while falling back to the specified default value if
  1340. the property access fails.
  1341. </summary>
  1342. <returns>
  1343. the property value.
  1344. <c>def</c> if there's no such property or if an access to the
  1345. specified property is not allowed.
  1346. </returns>
  1347. </member>
  1348. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.GetBoolean(System.String,System.Boolean)">
  1349. <summary>
  1350. Returns the value of the system property with the specified
  1351. <c>key</c>, while falling back to the specified default value if
  1352. the property access fails.
  1353. </summary>
  1354. <returns>
  1355. the property value or <c>def</c> if there's no such property or
  1356. if an access to the specified property is not allowed.
  1357. </returns>
  1358. </member>
  1359. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.GetInt(System.String,System.Int32)">
  1360. <summary>
  1361. Returns the value of the system property with the specified
  1362. <c>key</c>, while falling back to the specified default value if
  1363. the property access fails.
  1364. </summary>
  1365. <returns>
  1366. the property value.
  1367. <c>def</c> if there's no such property or if an access to the
  1368. specified property is not allowed.
  1369. </returns>
  1370. </member>
  1371. <member name="M:DotNetty.Common.Internal.SystemPropertyUtil.GetLong(System.String,System.Int64)">
  1372. <summary>
  1373. Returns the value of the system property with the specified
  1374. <c>key</c>, while falling back to the specified default value if
  1375. the property access fails.
  1376. </summary>
  1377. <returns>
  1378. the property value.
  1379. <c>def</c> if there's no such property or if an access to the
  1380. specified property is not allowed.
  1381. </returns>
  1382. </member>
  1383. <member name="T:DotNetty.Common.IReferenceCounted">
  1384. <summary>
  1385. Reference counting interface for reusable objects
  1386. </summary>
  1387. </member>
  1388. <member name="P:DotNetty.Common.IReferenceCounted.ReferenceCount">
  1389. <summary>
  1390. Returns the reference count of this object
  1391. </summary>
  1392. </member>
  1393. <member name="M:DotNetty.Common.IReferenceCounted.Retain">
  1394. <summary>
  1395. Increases the reference count by 1
  1396. </summary>
  1397. </member>
  1398. <member name="M:DotNetty.Common.IReferenceCounted.Retain(System.Int32)">
  1399. <summary>
  1400. Increases the reference count by <paramref name="increment" />
  1401. </summary>
  1402. </member>
  1403. <member name="M:DotNetty.Common.IReferenceCounted.Touch">
  1404. <summary>
  1405. Records the current access location of this object for debugging purposes.
  1406. If this object is determined to be leaked, the information recorded by this operation will be provided to you
  1407. via <see cref="T:DotNetty.Common.ResourceLeakDetector" />. This method is a shortcut to <see cref="M:DotNetty.Common.IReferenceCounted.Touch(System.Object)" /> with null as
  1408. an argument.
  1409. </summary>
  1410. <returns></returns>
  1411. </member>
  1412. <member name="M:DotNetty.Common.IReferenceCounted.Touch(System.Object)">
  1413. <summary>
  1414. Records the current access location of this object with an additonal arbitrary information for debugging
  1415. purposes. If this object is determined to be leaked, the information recorded by this operation will be
  1416. provided to you via <see cref="T:DotNetty.Common.ResourceLeakDetector" />.
  1417. </summary>
  1418. </member>
  1419. <member name="M:DotNetty.Common.IReferenceCounted.Release">
  1420. <summary>
  1421. Decreases the reference count by 1 and deallocates this object if the reference count reaches 0.
  1422. </summary>
  1423. <returns>true if and only if the reference count is 0 and this object has been deallocated</returns>
  1424. </member>
  1425. <member name="M:DotNetty.Common.IReferenceCounted.Release(System.Int32)">
  1426. <summary>
  1427. Decreases the reference count by <paramref name="decrement" /> and deallocates this object if the reference count
  1428. reaches 0.
  1429. </summary>
  1430. <returns>true if and only if the reference count is 0 and this object has been deallocated</returns>
  1431. </member>
  1432. <member name="T:DotNetty.Common.IResourceLeakHint">
  1433. <summary>
  1434. A hint object that provides human-readable message for easier resource leak tracking.
  1435. </summary>
  1436. </member>
  1437. <member name="M:DotNetty.Common.IResourceLeakHint.ToHintString">
  1438. <summary>
  1439. Returns a human-readable message that potentially enables easier resource leak tracking.
  1440. </summary>
  1441. <returns></returns>
  1442. </member>
  1443. <member name="M:DotNetty.Common.IResourceLeakTracker.Record">
  1444. <summary>
  1445. Records the caller's current stack trace so that the <see cref="T:DotNetty.Common.ResourceLeakDetector" /> can tell where the
  1446. leaked
  1447. resource was accessed lastly. This method is a shortcut to <see cref="M:DotNetty.Common.IResourceLeakTracker.Record(System.Object)" /> with <c>null</c> as an
  1448. argument.
  1449. </summary>
  1450. </member>
  1451. <member name="M:DotNetty.Common.IResourceLeakTracker.Record(System.Object)">
  1452. <summary>
  1453. Records the caller's current stack trace and the specified additional arbitrary information
  1454. so that the <see cref="T:DotNetty.Common.ResourceLeakDetector" /> can tell where the leaked resource was accessed lastly.
  1455. </summary>
  1456. <param name="hint"></param>
  1457. </member>
  1458. <member name="M:DotNetty.Common.IResourceLeakTracker.Close(System.Object)">
  1459. <summary>
  1460. Close the leak so that <see cref="T:DotNetty.Common.ResourceLeakDetector" /> does not warn about leaked resources.
  1461. </summary>
  1462. <returns><c>true</c> if called first time, <c>false</c> if called already</returns>
  1463. </member>
  1464. <member name="T:DotNetty.Common.ResourceLeakDetector.DetectionLevel">
  1465. <summary>
  1466. Represents the level of resource leak detection.
  1467. </summary>
  1468. </member>
  1469. <member name="F:DotNetty.Common.ResourceLeakDetector.DetectionLevel.Disabled">
  1470. <summary>
  1471. Disables resource leak detection.
  1472. </summary>
  1473. </member>
  1474. <member name="F:DotNetty.Common.ResourceLeakDetector.DetectionLevel.Simple">
  1475. <summary>
  1476. Enables simplistic sampling resource leak detection which reports there is a leak or not,
  1477. at the cost of small overhead (default).
  1478. </summary>
  1479. </member>
  1480. <member name="F:DotNetty.Common.ResourceLeakDetector.DetectionLevel.Advanced">
  1481. <summary>
  1482. Enables advanced sampling resource leak detection which reports where the leaked object was accessed
  1483. recently at the cost of high overhead.
  1484. </summary>
  1485. </member>
  1486. <member name="F:DotNetty.Common.ResourceLeakDetector.DetectionLevel.Paranoid">
  1487. <summary>
  1488. Enables paranoid resource leak detection which reports where the leaked object was accessed recently,
  1489. at the cost of the highest possible overhead (for testing purposes only).
  1490. </summary>
  1491. </member>
  1492. <member name="P:DotNetty.Common.ResourceLeakDetector.Enabled">
  1493. Returns <c>true</c> if resource leak detection is enabled.
  1494. </member>
  1495. <member name="P:DotNetty.Common.ResourceLeakDetector.Level">
  1496. <summary>
  1497. Gets or sets resource leak detection level
  1498. </summary>
  1499. </member>
  1500. <member name="M:DotNetty.Common.ResourceLeakDetector.Track(System.Object)">
  1501. <summary>
  1502. Creates a new <see cref="T:DotNetty.Common.IResourceLeakTracker" /> which is expected to be closed
  1503. when the
  1504. related resource is deallocated.
  1505. </summary>
  1506. <returns>the <see cref="T:DotNetty.Common.IResourceLeakTracker" /> or <c>null</c></returns>
  1507. </member>
  1508. <member name="M:DotNetty.Common.ThreadDeathWatcher.Watch(DotNetty.Common.Concurrency.XThread,System.Action)">
  1509. <summary>
  1510. Schedules the specified <see cref="T:System.Action"/> to run when the specified <see cref="T:DotNetty.Common.Concurrency.XThread"/> dies.
  1511. </summary>
  1512. </member>
  1513. <member name="M:DotNetty.Common.ThreadDeathWatcher.Unwatch(DotNetty.Common.Concurrency.XThread,System.Action)">
  1514. <summary>
  1515. Cancels the task scheduled via <see cref="M:DotNetty.Common.ThreadDeathWatcher.Watch(DotNetty.Common.Concurrency.XThread,System.Action)"/>.
  1516. </summary>
  1517. </member>
  1518. <member name="M:DotNetty.Common.ThreadDeathWatcher.AwaitInactivity(System.TimeSpan)">
  1519. <summary>
  1520. Waits until the thread of this watcher has no threads to watch and terminates itself.
  1521. Because a new watcher thread will be started again on <see cref="M:DotNetty.Common.ThreadDeathWatcher.Watch(DotNetty.Common.Concurrency.XThread,System.Action)"/>,
  1522. this operation is only useful when you want to ensure that the watcher thread is terminated
  1523. <strong>after</strong> your application is shut down and there's no chance of calling <see cref="M:DotNetty.Common.ThreadDeathWatcher.Watch(DotNetty.Common.Concurrency.XThread,System.Action)"/>
  1524. afterwards.
  1525. </summary>
  1526. <param name="timeout"></param>
  1527. <returns><c>true</c> if and only if the watcher thread has been terminated.</returns>
  1528. </member>
  1529. <member name="T:DotNetty.Common.Utilities.AbstractConstant`1">
  1530. <summary>Base implementation of <see cref="T:DotNetty.Common.Utilities.IConstant" />.</summary>
  1531. </member>
  1532. <member name="M:DotNetty.Common.Utilities.AbstractConstant`1.#ctor(System.Int32,System.String)">
  1533. <summary>Creates a new instance.</summary>
  1534. </member>
  1535. <member name="T:DotNetty.Common.Utilities.ArrayExtensions">
  1536. <summary>
  1537. Extension methods used for slicing byte arrays
  1538. </summary>
  1539. </member>
  1540. <member name="M:DotNetty.Common.Utilities.ArrayExtensions.CombineBytes(System.Byte[][])">
  1541. <summary>
  1542. Merge the byte arrays into one byte array.
  1543. </summary>
  1544. </member>
  1545. <member name="M:DotNetty.Common.Utilities.AsciiString.ArrayChanged">
  1546. <summary>
  1547. During normal use cases the AsciiString should be immutable, but if the
  1548. underlying array is shared, and changes then this needs to be called.
  1549. </summary>
  1550. </member>
  1551. <member name="T:DotNetty.Common.Utilities.AtomicReference`1">
  1552. <summary>
  1553. Implementation of the java.concurrent.util AtomicReference type.
  1554. </summary>
  1555. </member>
  1556. <member name="M:DotNetty.Common.Utilities.AtomicReference`1.#ctor(`0)">
  1557. <summary>
  1558. Sets the initial value of this <see cref="T:DotNetty.Common.Utilities.AtomicReference`1" /> to <see cref="!:originalValue" />.
  1559. </summary>
  1560. </member>
  1561. <member name="M:DotNetty.Common.Utilities.AtomicReference`1.#ctor">
  1562. <summary>
  1563. Default constructor
  1564. </summary>
  1565. </member>
  1566. <member name="P:DotNetty.Common.Utilities.AtomicReference`1.Value">
  1567. <summary>
  1568. The current value of this <see cref="T:DotNetty.Common.Utilities.AtomicReference`1" />
  1569. </summary>
  1570. </member>
  1571. <member name="M:DotNetty.Common.Utilities.AtomicReference`1.CompareAndSet(`0,`0)">
  1572. <summary>
  1573. If <see cref="P:DotNetty.Common.Utilities.AtomicReference`1.Value" /> equals <paramref name="expected"/>, then set the Value to
  1574. <paramref name="newValue"/>
  1575. Returns true if <paramref name="newValue"/> was set, false otherwise.
  1576. </summary>
  1577. </member>
  1578. <member name="M:DotNetty.Common.Utilities.AtomicReference`1.op_Implicit(DotNetty.Common.Utilities.AtomicReference{`0})~`0">
  1579. <summary>
  1580. Implicit conversion operator = automatically casts the <see cref="T:DotNetty.Common.Utilities.AtomicReference`1" /> to an instance of
  1581. <typeparam name="T"></typeparam>
  1582. </summary>
  1583. </member>
  1584. <member name="M:DotNetty.Common.Utilities.AtomicReference`1.op_Implicit(`0)~DotNetty.Common.Utilities.AtomicReference{`0}">
  1585. <summary>
  1586. Implicit conversion operator = allows us to cast any type directly into a <see cref="T:DotNetty.Common.Utilities.AtomicReference`1" />
  1587. instance.
  1588. </summary>
  1589. <param name="newValue"></param>
  1590. <returns></returns>
  1591. </member>
  1592. <member name="T:DotNetty.Common.Utilities.AttributeKey`1">
  1593. <summary>
  1594. Key which can be used to access <seealso cref="T:System.Attribute" /> out of the <see cref="T:DotNetty.Common.Utilities.IAttributeMap" />. Be aware that
  1595. it is not be possible to have multiple keys with the same name.
  1596. </summary>
  1597. <typeparam name="T">
  1598. the type of the <see cref="T:System.Attribute" /> which can be accessed via this <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" />.
  1599. </typeparam>
  1600. </member>
  1601. <member name="M:DotNetty.Common.Utilities.AttributeKey`1.ValueOf(System.String)">
  1602. <summary>Returns the singleton instance of the {@link AttributeKey} which has the specified <c>name</c>.</summary>
  1603. </member>
  1604. <member name="M:DotNetty.Common.Utilities.AttributeKey`1.Exists(System.String)">
  1605. <summary>Returns <c>true</c> if a <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" /> exists for the given <c>name</c>.</summary>
  1606. </member>
  1607. <member name="M:DotNetty.Common.Utilities.AttributeKey`1.NewInstance(System.String)">
  1608. <summary>
  1609. Creates a new <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" /> for the given <c>name</c> or fail with an
  1610. <see cref="T:System.ArgumentException" /> if a <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" /> for the given <c>name</c> exists.
  1611. </summary>
  1612. </member>
  1613. <member name="T:DotNetty.Common.Utilities.IByteProcessor">
  1614. <summary>
  1615. Provides a mechanism to iterate over a collection of bytes.
  1616. </summary>
  1617. </member>
  1618. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNul">
  1619. <summary>
  1620. Aborts on a <c>NUL (0x00)</c>.
  1621. </summary>
  1622. </member>
  1623. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNonNul">
  1624. <summary>
  1625. Aborts on a non-<c>NUL (0x00)</c>.
  1626. </summary>
  1627. </member>
  1628. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindCR">
  1629. <summary>
  1630. Aborts on a <c>CR ('\r')</c>.
  1631. </summary>
  1632. </member>
  1633. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNonCR">
  1634. <summary>
  1635. Aborts on a non-<c>CR ('\r')</c>.
  1636. </summary>
  1637. </member>
  1638. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindLF">
  1639. <summary>
  1640. Aborts on a <c>LF ('\n')</c>.
  1641. </summary>
  1642. </member>
  1643. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNonLF">
  1644. <summary>
  1645. Aborts on a non-<c>LF ('\n')</c>.
  1646. </summary>
  1647. </member>
  1648. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindSemicolon">
  1649. <summary>
  1650. Aborts on a <c>CR (';')</c>.
  1651. </summary>
  1652. </member>
  1653. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindComma">
  1654. <summary>
  1655. Aborts on a comma <c>(',')</c>.
  1656. </summary>
  1657. </member>
  1658. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindAsciiSpace">
  1659. <summary>
  1660. Aborts on a ascii space character (<c>' '</c>).
  1661. </summary>
  1662. </member>
  1663. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindCrlf">
  1664. <summary>
  1665. Aborts on a <c>CR ('\r')</c> or a <c>LF ('\n')</c>.
  1666. </summary>
  1667. </member>
  1668. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNonCrlf">
  1669. <summary>
  1670. Aborts on a byte which is neither a <c>CR ('\r')</c> nor a <c>LF ('\n')</c>.
  1671. </summary>
  1672. </member>
  1673. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindLinearWhitespace">
  1674. <summary>
  1675. Aborts on a linear whitespace (a <c>' '</c> or a <c>'\t'</c>).
  1676. </summary>
  1677. </member>
  1678. <member name="F:DotNetty.Common.Utilities.ByteProcessor.FindNonLinearWhitespace">
  1679. <summary>
  1680. Aborts on a byte which is not a linear whitespace (neither <c>' '</c> nor <c>'\t'</c>).
  1681. </summary>
  1682. </member>
  1683. <member name="T:DotNetty.Common.Utilities.ConstantPool">
  1684. <summary>
  1685. A pool of <see cref="T:DotNetty.Common.Utilities.IConstant" />s.
  1686. </summary>
  1687. </member>
  1688. <member name="M:DotNetty.Common.Utilities.ConstantPool.ValueOf``1(System.Type,System.String)">
  1689. <summary>Shortcut of <c>this.ValueOf(firstNameComponent.Name + "#" + secondNameComponent)</c>.</summary>
  1690. </member>
  1691. <member name="M:DotNetty.Common.Utilities.ConstantPool.ValueOf``1(System.String)">
  1692. <summary>
  1693. Returns the <see cref="T:DotNetty.Common.Utilities.IConstant" /> which is assigned to the specified <c>name</c>.
  1694. If there's no such <see cref="T:DotNetty.Common.Utilities.IConstant" />, a new one will be created and returned.
  1695. Once created, the subsequent calls with the same <c>name</c> will always return the previously created one
  1696. (i.e. singleton.)
  1697. </summary>
  1698. <param name="name">the name of the <see cref="T:DotNetty.Common.Utilities.IConstant" /></param>
  1699. </member>
  1700. <member name="M:DotNetty.Common.Utilities.ConstantPool.Exists(System.String)">
  1701. <summary>Returns <c>true</c> if a <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" /> exists for the given <c>name</c>.</summary>
  1702. </member>
  1703. <member name="M:DotNetty.Common.Utilities.ConstantPool.NewInstance``1(System.String)">
  1704. <summary>
  1705. Creates a new <see cref="T:DotNetty.Common.Utilities.IConstant" /> for the given <c>name</c> or fail with an
  1706. <see cref="T:System.ArgumentException" /> if a <see cref="T:DotNetty.Common.Utilities.IConstant" /> for the given <c>name</c> exists.
  1707. </summary>
  1708. </member>
  1709. <member name="T:DotNetty.Common.Utilities.DefaultAttributeMap">
  1710. <summary>
  1711. Default <see cref="T:DotNetty.Common.Utilities.IAttributeMap" /> implementation which use simple synchronization per bucket to keep the memory
  1712. overhead
  1713. as low as possible.
  1714. </summary>
  1715. </member>
  1716. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.#ctor(System.TimeSpan,System.Int32,System.Int64)">
  1717. <summary>
  1718. Creates a new timer.
  1719. </summary>
  1720. <param name="tickInterval">the interval between two consecutive ticks</param>
  1721. <param name="ticksPerWheel">the size of the wheel</param>
  1722. <param name="maxPendingTimeouts">The maximum number of pending timeouts after which call to
  1723. <c>newTimeout</c> will result in <see cref="T:DotNetty.Common.Concurrency.RejectedExecutionException"/> being thrown.
  1724. No maximum pending timeouts limit is assumed if this value is 0 or negative.</param>
  1725. <exception cref="T:System.ArgumentException">if either of <c>tickInterval</c> and <c>ticksPerWheel</c> is &lt;= 0</exception>
  1726. </member>
  1727. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.Start">
  1728. <summary>
  1729. Starts the background thread explicitly. The background thread will
  1730. start automatically on demand even if you did not call this method.
  1731. </summary>
  1732. <exception cref="T:System.InvalidOperationException">if this timer has been
  1733. stopped already.</exception>
  1734. </member>
  1735. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.Worker.WaitForNextTick">
  1736. <summary>
  1737. calculate timer firing time from startTime and current tick number,
  1738. then wait until that goal has been reached.
  1739. </summary>
  1740. <returns>long.MinValue if received a shutdown request,
  1741. current time otherwise (with long.MinValue changed by +1)
  1742. </returns>
  1743. </member>
  1744. <member name="T:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelBucket">
  1745. <summary>
  1746. Bucket that stores HashedWheelTimeouts. These are stored in a linked-list like datastructure to allow easy
  1747. removal of HashedWheelTimeouts in the middle. Also the HashedWheelTimeout act as nodes themself and so no
  1748. extra object creation is needed.
  1749. </summary>
  1750. </member>
  1751. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelBucket.AddTimeout(DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelTimeout)">
  1752. <summary>
  1753. Add a <see cref="T:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelTimeout"/> to this bucket.
  1754. </summary>
  1755. </member>
  1756. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelBucket.ExpireTimeouts(System.TimeSpan)">
  1757. <summary>
  1758. Expire all <see cref="T:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelTimeout"/>s for the given <c>deadline</c>.
  1759. </summary>
  1760. </member>
  1761. <member name="M:DotNetty.Common.Utilities.HashedWheelTimer.HashedWheelBucket.ClearTimeouts(System.Collections.Generic.ISet{DotNetty.Common.Utilities.ITimeout})">
  1762. <summary>
  1763. Clear this bucket and return all not expired / cancelled <see cref="T:DotNetty.Common.Utilities.ITimeout"/>s.
  1764. </summary>
  1765. </member>
  1766. <member name="T:DotNetty.Common.Utilities.IAttribute`1">
  1767. <summary>An attribute which allows to store a value reference. It may be updated atomically and so is thread-safe.</summary>
  1768. <typeparam name="T">the type of the value it holds.</typeparam>
  1769. </member>
  1770. <member name="P:DotNetty.Common.Utilities.IAttribute`1.Key">
  1771. <summary>
  1772. Returns the key of this attribute.
  1773. </summary>
  1774. </member>
  1775. <member name="M:DotNetty.Common.Utilities.IAttribute`1.Get">
  1776. <summary>
  1777. Returns the current value, which may be <c>null</c>
  1778. </summary>
  1779. </member>
  1780. <member name="M:DotNetty.Common.Utilities.IAttribute`1.Set(`0)">
  1781. <summary>
  1782. Sets the value
  1783. </summary>
  1784. </member>
  1785. <member name="M:DotNetty.Common.Utilities.IAttribute`1.GetAndSet(`0)">
  1786. <summary>
  1787. Atomically sets to the given value and returns the old value which may be <c>null</c> if non was set before.
  1788. </summary>
  1789. </member>
  1790. <member name="M:DotNetty.Common.Utilities.IAttribute`1.SetIfAbsent(`0)">
  1791. <summary>
  1792. Atomically sets to the given value if this <see cref="T:DotNetty.Common.Utilities.IAttribute`1" />'s value is <c>null</c>.
  1793. If it was not possible to set the value as it contains a value it will just return the current value.
  1794. </summary>
  1795. </member>
  1796. <member name="M:DotNetty.Common.Utilities.IAttribute`1.GetAndRemove">
  1797. <summary>
  1798. Removes this attribute from the <see cref="T:DotNetty.Common.Utilities.IAttributeMap" /> and returns the old value. Subsequent
  1799. <see cref="M:DotNetty.Common.Utilities.IAttribute`1.Get" />
  1800. calls will return <c>null</c>.
  1801. If you only want to return the old value and clear the <see cref="T:DotNetty.Common.Utilities.IAttribute`1" /> while still keep it in
  1802. <see cref="T:DotNetty.Common.Utilities.IAttributeMap" /> use <see cref="M:DotNetty.Common.Utilities.IAttribute`1.GetAndSet(`0)" /> with a value of <c>null</c>.
  1803. </summary>
  1804. </member>
  1805. <member name="M:DotNetty.Common.Utilities.IAttribute`1.CompareAndSet(`0,`0)">
  1806. <summary>
  1807. Atomically sets the value to the given updated value if the current value == the expected value.
  1808. If it the set was successful it returns <c>true</c> otherwise <c>false</c>.
  1809. </summary>
  1810. </member>
  1811. <member name="M:DotNetty.Common.Utilities.IAttribute`1.Remove">
  1812. <summary>
  1813. Removes this attribute from the <see cref="T:DotNetty.Common.Utilities.IAttributeMap" />. Subsequent <see cref="M:DotNetty.Common.Utilities.IAttribute`1.Get" /> calls will return
  1814. <c>null</c>.
  1815. If you only want to remove the value and clear the <see cref="T:DotNetty.Common.Utilities.IAttribute`1" /> while still keep it in
  1816. <see cref="T:DotNetty.Common.Utilities.IAttributeMap" /> use <see cref="M:DotNetty.Common.Utilities.IAttribute`1.Set(`0)" /> with a value of <c>null</c>.
  1817. </summary>
  1818. </member>
  1819. <member name="T:DotNetty.Common.Utilities.IAttributeMap">
  1820. <summary>Holds <see cref="T:DotNetty.Common.Utilities.IAttribute`1" />s which can be accessed via <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" />.</summary>
  1821. <remarks>Implementations must be Thread-safe.</remarks>
  1822. </member>
  1823. <member name="M:DotNetty.Common.Utilities.IAttributeMap.GetAttribute``1(DotNetty.Common.Utilities.AttributeKey{``0})">
  1824. <summary>
  1825. Get the <see cref="T:DotNetty.Common.Utilities.IAttribute`1" /> for the given <see cref="T:DotNetty.Common.Utilities.AttributeKey`1" />. This method will never return
  1826. null, but may return an <see cref="T:DotNetty.Common.Utilities.IAttribute`1" /> which does not have a value set yet.
  1827. </summary>
  1828. </member>
  1829. <member name="M:DotNetty.Common.Utilities.IAttributeMap.HasAttribute``1(DotNetty.Common.Utilities.AttributeKey{``0})">
  1830. <summary>
  1831. Returns <c>true</c> if and only if the given <see cref="T:DotNetty.Common.Utilities.IAttribute`1" /> exists in this
  1832. <see cref="T:DotNetty.Common.Utilities.IAttributeMap" />.
  1833. </summary>
  1834. </member>
  1835. <member name="M:DotNetty.Common.Utilities.ICharSequence.SubSequence(System.Int32,System.Int32)">
  1836. Start is the inclusive start index to begin the subsequence.
  1837. End is the exclusive end index to end the subsequence.
  1838. </member>
  1839. <member name="T:DotNetty.Common.Utilities.IConstant">
  1840. <summary>
  1841. A singleton which is safe to compare via the <c>==</c> operator. Created and managed by
  1842. <see cref="T:DotNetty.Common.Utilities.ConstantPool" />.
  1843. </summary>
  1844. </member>
  1845. <member name="P:DotNetty.Common.Utilities.IConstant.Id">
  1846. <summary>Returns the unique number assigned to this <see cref="T:DotNetty.Common.Utilities.IConstant" />.</summary>
  1847. </member>
  1848. <member name="P:DotNetty.Common.Utilities.IConstant.Name">
  1849. <summary>Returns the name of this <see cref="T:DotNetty.Common.Utilities.IConstant" />.</summary>
  1850. </member>
  1851. <member name="T:DotNetty.Common.Utilities.IllegalReferenceCountException">
  1852. <inheritdoc />
  1853. <summary>
  1854. Exception thrown during instances where a reference count is used incorrectly
  1855. </summary>
  1856. </member>
  1857. <member name="T:DotNetty.Common.Utilities.ITimeout">
  1858. <summary>
  1859. A handle associated with a <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> that is returned by a
  1860. <see cref="T:DotNetty.Common.Utilities.ITimer"/>.
  1861. </summary>
  1862. </member>
  1863. <member name="P:DotNetty.Common.Utilities.ITimeout.Timer">
  1864. <summary>
  1865. Returns the <see cref="T:DotNetty.Common.Utilities.ITimer"/> that created this handle.
  1866. </summary>
  1867. </member>
  1868. <member name="P:DotNetty.Common.Utilities.ITimeout.Task">
  1869. <summary>
  1870. Returns the <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> which is associated with this handle.
  1871. </summary>
  1872. </member>
  1873. <member name="P:DotNetty.Common.Utilities.ITimeout.Expired">
  1874. <summary>
  1875. Returns <c>true</c> if and only if the <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> associated
  1876. with this handle has been expired.
  1877. </summary>
  1878. </member>
  1879. <member name="P:DotNetty.Common.Utilities.ITimeout.Canceled">
  1880. <summary>
  1881. Returns <c>true</c> if and only if the <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> associated
  1882. with this handle has been canceled.
  1883. </summary>
  1884. </member>
  1885. <member name="M:DotNetty.Common.Utilities.ITimeout.Cancel">
  1886. <summary>
  1887. Attempts to cancel the <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> associated with this handle.
  1888. If the task has been executed or canceled already, it will return with
  1889. no side effect.
  1890. </summary>
  1891. <returns><c>true</c> if the cancellation completed successfully, otherwise <c>false</c>.</returns>
  1892. </member>
  1893. <member name="T:DotNetty.Common.Utilities.ITimer">
  1894. <summary>
  1895. Schedules <see cref="T:DotNetty.Common.Utilities.ITimerTask"/>s for one-time future execution in a background
  1896. thread.
  1897. </summary>
  1898. </member>
  1899. <member name="M:DotNetty.Common.Utilities.ITimer.NewTimeout(DotNetty.Common.Utilities.ITimerTask,System.TimeSpan)">
  1900. <summary>
  1901. Schedules the specified <see cref="T:DotNetty.Common.Utilities.ITimerTask"/> for one-time execution after the specified delay.
  1902. </summary>
  1903. <returns>a handle which is associated with the specified task</returns>
  1904. <exception cref="T:System.InvalidOperationException">if this timer has been stopped already</exception>
  1905. <exception cref="T:DotNetty.Common.Concurrency.RejectedExecutionException">if the pending timeouts are too many and creating new timeout
  1906. can cause instability in the system.</exception>
  1907. </member>
  1908. <member name="M:DotNetty.Common.Utilities.ITimer.StopAsync">
  1909. <summary>
  1910. Releases all resources acquired by this <see cref="T:DotNetty.Common.Utilities.ITimer"/> and cancels all
  1911. tasks which were scheduled but not executed yet.
  1912. </summary>
  1913. <returns>the handles associated with the tasks which were canceled by
  1914. this method</returns>
  1915. </member>
  1916. <member name="T:DotNetty.Common.Utilities.ITimerTask">
  1917. <summary>
  1918. A task which is executed after the delay specified with
  1919. <see cref="M:DotNetty.Common.Utilities.ITimer.NewTimeout(DotNetty.Common.Utilities.ITimerTask,System.TimeSpan)"/>.
  1920. </summary>
  1921. </member>
  1922. <member name="M:DotNetty.Common.Utilities.ITimerTask.Run(DotNetty.Common.Utilities.ITimeout)">
  1923. <summary>
  1924. Executed after the delay specified with
  1925. <see cref="M:DotNetty.Common.Utilities.ITimer.NewTimeout(DotNetty.Common.Utilities.ITimerTask,System.TimeSpan)"/>.
  1926. </summary>
  1927. <param name="timeout">a handle which is associated with this task</param>
  1928. </member>
  1929. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Retain``1(``0)">
  1930. <summary>
  1931. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Retain"/> if the specified message implements
  1932. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1933. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing.
  1934. </summary>
  1935. </member>
  1936. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Retain``1(``0,System.Int32)">
  1937. <summary>
  1938. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Retain(System.Int32)"/> if the specified message implements
  1939. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1940. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing.
  1941. </summary>
  1942. </member>
  1943. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Touch``1(``0)">
  1944. <summary>
  1945. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Touch" /> if the specified message implements
  1946. <see cref="T:DotNetty.Common.IReferenceCounted" />.
  1947. If the specified message doesn't implement <see cref="T:DotNetty.Common.IReferenceCounted" />, this method does nothing.
  1948. </summary>
  1949. </member>
  1950. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Touch``1(``0,System.Object)">
  1951. <summary>
  1952. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Touch(System.Object)" /> if the specified message implements
  1953. <see cref="T:DotNetty.Common.IReferenceCounted" />. If the specified message doesn't implement
  1954. <see cref="T:DotNetty.Common.IReferenceCounted" />, this method does nothing.
  1955. </summary>
  1956. </member>
  1957. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object)">
  1958. <summary>
  1959. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Release" /> if the specified message implements
  1960. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1961. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing.
  1962. </summary>
  1963. </member>
  1964. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object,System.Int32)">
  1965. <summary>
  1966. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Release(System.Int32)" /> if the specified message implements
  1967. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1968. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing.
  1969. </summary>
  1970. </member>
  1971. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.SafeRelease(System.Object)">
  1972. <summary>
  1973. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Release" /> if the specified message implements
  1974. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1975. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing. Unlike <see cref="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object)"/>, this
  1976. method catches an exception raised by <see cref="M:DotNetty.Common.IReferenceCounted.Release" /> and logs it, rather than
  1977. rethrowing it to the caller. It is usually recommended to use <see cref="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object)"/> instead, unless
  1978. you absolutely need to swallow an exception.
  1979. </summary>
  1980. </member>
  1981. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.SafeRelease(System.Object,System.Int32)">
  1982. <summary>
  1983. Tries to call <see cref="M:DotNetty.Common.IReferenceCounted.Release(System.Int32)" /> if the specified message implements
  1984. <see cref="T:DotNetty.Common.IReferenceCounted"/>. If the specified message doesn't implement
  1985. <see cref="T:DotNetty.Common.IReferenceCounted"/>, this method does nothing. Unlike <see cref="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object)"/>, this
  1986. method catches an exception raised by <see cref="M:DotNetty.Common.IReferenceCounted.Release(System.Int32)" /> and logs it, rather
  1987. than rethrowing it to the caller. It is usually recommended to use <see cref="M:DotNetty.Common.Utilities.ReferenceCountUtil.Release(System.Object,System.Int32)"/>
  1988. instead, unless you absolutely need to swallow an exception.
  1989. </summary>
  1990. </member>
  1991. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.ReleaseLater``1(``0)">
  1992. <summary>
  1993. Schedules the specified object to be released when the caller thread terminates. Note that this operation
  1994. is intended to simplify reference counting of ephemeral objects during unit tests. Do not use it beyond the
  1995. intended use case.
  1996. </summary>
  1997. </member>
  1998. <member name="M:DotNetty.Common.Utilities.ReferenceCountUtil.ReleaseLater``1(``0,System.Int32)">
  1999. <summary>
  2000. Schedules the specified object to be released when the caller thread terminates. Note that this operation
  2001. is intended to simplify reference counting of ephemeral objects during unit tests. Do not use it beyond the
  2002. intended use case.
  2003. </summary>
  2004. </member>
  2005. <member name="T:DotNetty.Common.Utilities.StringUtil">
  2006. <summary>
  2007. String utility class.
  2008. </summary>
  2009. </member>
  2010. <member name="F:DotNetty.Common.Utilities.StringUtil.CsvNumberEscapeCharacters">
  2011. 2 - Quote character at beginning and end.
  2012. 5 - Extra allowance for anticipated escape characters that may be added.
  2013. </member>
  2014. <member name="M:DotNetty.Common.Utilities.StringUtil.ByteToHexStringPadded(System.Int32)">
  2015. <summary>
  2016. Converts the specified byte value into a 2-digit hexadecimal integer.
  2017. </summary>
  2018. </member>
  2019. <member name="M:DotNetty.Common.Utilities.StringUtil.ToHexStringPadded(System.Byte[])">
  2020. <summary>
  2021. Converts the specified byte array into a hexadecimal value.
  2022. </summary>
  2023. </member>
  2024. <member name="M:DotNetty.Common.Utilities.StringUtil.ToHexStringPadded(System.Byte[],System.Int32,System.Int32)">
  2025. <summary>
  2026. Converts the specified byte array into a hexadecimal value.
  2027. </summary>
  2028. </member>
  2029. <member name="M:DotNetty.Common.Utilities.StringUtil.ByteToHexString(System.Byte)">
  2030. <summary>
  2031. Converts the specified byte value into a hexadecimal integer.
  2032. </summary>
  2033. </member>
  2034. <member name="M:DotNetty.Common.Utilities.StringUtil.SimpleClassName(System.Object)">
  2035. <summary>
  2036. The shortcut to <see cref="M:DotNetty.Common.Utilities.StringUtil.SimpleClassName(System.Type)">SimpleClassName(o.GetType())</see>.
  2037. </summary>
  2038. </member>
  2039. <member name="M:DotNetty.Common.Utilities.StringUtil.SimpleClassName``1">
  2040. <summary>
  2041. The shortcut to <see cref="M:DotNetty.Common.Utilities.StringUtil.SimpleClassName(System.Type)">SimpleClassName(o.GetType())</see>.
  2042. </summary>
  2043. </member>
  2044. <member name="M:DotNetty.Common.Utilities.StringUtil.SimpleClassName(System.Type)">
  2045. <summary>
  2046. Generates a simplified name from a <see cref="T:System.Type" />. Similar to {@link Class#getSimpleName()}, but it works
  2047. fine
  2048. with anonymous classes.
  2049. </summary>
  2050. </member>
  2051. <member name="M:DotNetty.Common.Utilities.StringUtil.EscapeCsv(DotNetty.Common.Utilities.ICharSequence,System.Boolean)">
  2052. <summary>
  2053. Escapes the specified value, if necessary according to
  2054. <a href="https://tools.ietf.org/html/rfc4180#section-2">RFC-4180</a>.
  2055. </summary>
  2056. <param name="value">
  2057. The value which will be escaped according to
  2058. <a href="https://tools.ietf.org/html/rfc4180#section-2">RFC-4180</a>
  2059. </param>
  2060. <param name="trimWhiteSpace">
  2061. The value will first be trimmed of its optional white-space characters, according to
  2062. <a href= "https://tools.ietf.org/html/rfc7230#section-7" >RFC-7230</a>
  2063. </param>
  2064. <returns>the escaped value if necessary, or the value unchanged</returns>
  2065. </member>
  2066. <member name="T:DotNetty.Common.Utilities.TimeUtil">
  2067. <summary>
  2068. Time utility class.
  2069. </summary>
  2070. </member>
  2071. <member name="M:DotNetty.Common.Utilities.TimeUtil.Max(System.TimeSpan,System.TimeSpan)">
  2072. <summary>
  2073. Compare two timespan objects
  2074. </summary>
  2075. <param name="t1">first timespan object</param>
  2076. <param name="t2">two timespan object</param>
  2077. </member>
  2078. <member name="M:DotNetty.Common.Utilities.TimeUtil.GetSystemTime">
  2079. <summary>
  2080. Gets the system time.
  2081. </summary>
  2082. <returns>The system time.</returns>
  2083. </member>
  2084. <member name="T:Nito.Deque`1">
  2085. <summary>
  2086. A double-ended queue (deque), which provides O(1) indexed access, O(1) removals from the front and back, amortized
  2087. O(1) insertions to the front and back, and O(N) insertions and removals anywhere else (with the operations getting
  2088. slower as the index approaches the middle).
  2089. </summary>
  2090. <typeparam name="T">The type of elements contained in the deque.</typeparam>
  2091. </member>
  2092. <member name="F:Nito.Deque`1.DefaultCapacity">
  2093. <summary>
  2094. The default capacity.
  2095. </summary>
  2096. </member>
  2097. <member name="F:Nito.Deque`1.buffer">
  2098. <summary>
  2099. The circular buffer that holds the view.
  2100. </summary>
  2101. </member>
  2102. <member name="F:Nito.Deque`1.offset">
  2103. <summary>
  2104. The offset into <see cref="F:Nito.Deque`1.buffer" /> where the view begins.
  2105. </summary>
  2106. </member>
  2107. <member name="M:Nito.Deque`1.#ctor(System.Int32)">
  2108. <summary>
  2109. Initializes a new instance of the <see cref="T:Nito.Deque`1" /> class with the specified capacity.
  2110. </summary>
  2111. <param name="capacity">The initial capacity. Must be greater than <c>0</c>.</param>
  2112. </member>
  2113. <member name="M:Nito.Deque`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
  2114. <summary>
  2115. Initializes a new instance of the <see cref="T:Nito.Deque`1" /> class with the elements from the specified
  2116. collection.
  2117. </summary>
  2118. <param name="collection">The collection.</param>
  2119. </member>
  2120. <member name="M:Nito.Deque`1.#ctor">
  2121. <summary>
  2122. Initializes a new instance of the <see cref="T:Nito.Deque`1" /> class.
  2123. </summary>
  2124. </member>
  2125. <member name="P:Nito.Deque`1.System#Collections#Generic#ICollection{T}#IsReadOnly">
  2126. <summary>
  2127. Gets a value indicating whether this list is read-only. This implementation always returns <c>false</c>.
  2128. </summary>
  2129. <returns>true if this list is read-only; otherwise, false.</returns>
  2130. </member>
  2131. <member name="P:Nito.Deque`1.Item(System.Int32)">
  2132. <summary>
  2133. Gets or sets the item at the specified index.
  2134. </summary>
  2135. <param name="index">The index of the item to get or set.</param>
  2136. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index" /> is not a valid index in this list.</exception>
  2137. <exception cref="T:System.NotSupportedException">This property is set and the list is read-only.</exception>
  2138. </member>
  2139. <member name="M:Nito.Deque`1.Insert(System.Int32,`0)">
  2140. <summary>
  2141. Inserts an item to this list at the specified index.
  2142. </summary>
  2143. <param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
  2144. <param name="item">The object to insert into this list.</param>
  2145. <exception cref="T:System.ArgumentOutOfRangeException">
  2146. <paramref name="index" /> is not a valid index in this list.
  2147. </exception>
  2148. <exception cref="T:System.NotSupportedException">
  2149. This list is read-only.
  2150. </exception>
  2151. </member>
  2152. <member name="M:Nito.Deque`1.RemoveAt(System.Int32)">
  2153. <summary>
  2154. Removes the item at the specified index.
  2155. </summary>
  2156. <param name="index">The zero-based index of the item to remove.</param>
  2157. <exception cref="T:System.ArgumentOutOfRangeException">
  2158. <paramref name="index" /> is not a valid index in this list.
  2159. </exception>
  2160. <exception cref="T:System.NotSupportedException">
  2161. This list is read-only.
  2162. </exception>
  2163. </member>
  2164. <member name="M:Nito.Deque`1.IndexOf(`0)">
  2165. <summary>
  2166. Determines the index of a specific item in this list.
  2167. </summary>
  2168. <param name="item">The object to locate in this list.</param>
  2169. <returns>The index of <paramref name="item" /> if found in this list; otherwise, -1.</returns>
  2170. </member>
  2171. <member name="M:Nito.Deque`1.System#Collections#Generic#ICollection{T}#Add(`0)">
  2172. <summary>
  2173. Adds an item to the end of this list.
  2174. </summary>
  2175. <param name="item">The object to add to this list.</param>
  2176. <exception cref="T:System.NotSupportedException">
  2177. This list is read-only.
  2178. </exception>
  2179. </member>
  2180. <member name="M:Nito.Deque`1.System#Collections#Generic#ICollection{T}#Contains(`0)">
  2181. <summary>
  2182. Determines whether this list contains a specific value.
  2183. </summary>
  2184. <param name="item">The object to locate in this list.</param>
  2185. <returns>
  2186. true if <paramref name="item" /> is found in this list; otherwise, false.
  2187. </returns>
  2188. </member>
  2189. <member name="M:Nito.Deque`1.System#Collections#Generic#ICollection{T}#CopyTo(`0[],System.Int32)">
  2190. <summary>
  2191. Copies the elements of this list to an <see cref="T:System.Array" />, starting at a particular
  2192. <see cref="T:System.Array" /> index.
  2193. </summary>
  2194. <param name="array">
  2195. The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied
  2196. from this slice. The <see cref="T:System.Array" /> must have zero-based indexing.
  2197. </param>
  2198. <param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
  2199. <exception cref="T:System.ArgumentNullException">
  2200. <paramref name="array" /> is null.
  2201. </exception>
  2202. <exception cref="T:System.ArgumentOutOfRangeException">
  2203. <paramref name="arrayIndex" /> is less than 0.
  2204. </exception>
  2205. <exception cref="T:System.ArgumentException">
  2206. <paramref name="arrayIndex" /> is equal to or greater than the length of <paramref name="array" />.
  2207. -or-
  2208. The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1" /> is greater than the
  2209. available space from <paramref name="arrayIndex" /> to the end of the destination <paramref name="array" />.
  2210. </exception>
  2211. </member>
  2212. <member name="M:Nito.Deque`1.Remove(`0)">
  2213. <summary>
  2214. Removes the first occurrence of a specific object from this list.
  2215. </summary>
  2216. <param name="item">The object to remove from this list.</param>
  2217. <returns>
  2218. true if <paramref name="item" /> was successfully removed from this list; otherwise, false. This method also
  2219. returns false if <paramref name="item" /> is not found in this list.
  2220. </returns>
  2221. <exception cref="T:System.NotSupportedException">
  2222. This list is read-only.
  2223. </exception>
  2224. </member>
  2225. <member name="M:Nito.Deque`1.GetEnumerator">
  2226. <summary>
  2227. Returns an enumerator that iterates through the collection.
  2228. </summary>
  2229. <returns>
  2230. A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
  2231. </returns>
  2232. </member>
  2233. <member name="M:Nito.Deque`1.System#Collections#IEnumerable#GetEnumerator">
  2234. <summary>
  2235. Returns an enumerator that iterates through a collection.
  2236. </summary>
  2237. <returns>
  2238. An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.
  2239. </returns>
  2240. </member>
  2241. <member name="M:Nito.Deque`1.ObjectIsT(System.Object)">
  2242. <summary>
  2243. Returns whether or not the type of a given item indicates it is appropriate for storing in this container.
  2244. </summary>
  2245. <param name="item">The item to test.</param>
  2246. <returns><c>true</c> if the item is appropriate to store in this container; otherwise, <c>false</c>.</returns>
  2247. </member>
  2248. <member name="M:Nito.Deque`1.CheckNewIndexArgument(System.Int32,System.Int32)">
  2249. <summary>
  2250. Checks the <paramref name="index" /> argument to see if it refers to a valid insertion point in a source of a given
  2251. length.
  2252. </summary>
  2253. <param name="sourceLength">The length of the source. This parameter is not checked for validity.</param>
  2254. <param name="index">The index into the source.</param>
  2255. <exception cref="T:System.ArgumentOutOfRangeException">
  2256. <paramref name="index" /> is not a valid index to an insertion point for
  2257. the source.
  2258. </exception>
  2259. </member>
  2260. <member name="M:Nito.Deque`1.CheckExistingIndexArgument(System.Int32,System.Int32)">
  2261. <summary>
  2262. Checks the <paramref name="index" /> argument to see if it refers to an existing element in a source of a given
  2263. length.
  2264. </summary>
  2265. <param name="sourceLength">The length of the source. This parameter is not checked for validity.</param>
  2266. <param name="index">The index into the source.</param>
  2267. <exception cref="T:System.ArgumentOutOfRangeException">
  2268. <paramref name="index" /> is not a valid index to an existing element for
  2269. the source.
  2270. </exception>
  2271. </member>
  2272. <member name="M:Nito.Deque`1.CheckRangeArguments(System.Int32,System.Int32,System.Int32)">
  2273. <summary>
  2274. Checks the <paramref name="offset" /> and <paramref name="count" /> arguments for validity when applied to a source
  2275. of a given length. Allows 0-element ranges, including a 0-element range at the end of the source.
  2276. </summary>
  2277. <param name="sourceLength">The length of the source. This parameter is not checked for validity.</param>
  2278. <param name="offset">The index into source at which the range begins.</param>
  2279. <param name="count">The number of elements in the range.</param>
  2280. <exception cref="T:System.ArgumentOutOfRangeException">
  2281. Either <paramref name="offset" /> or <paramref name="count" /> is less
  2282. than 0.
  2283. </exception>
  2284. <exception cref="T:System.ArgumentException">The range [offset, offset + count) is not within the range [0, sourceLength).</exception>
  2285. </member>
  2286. <member name="P:Nito.Deque`1.IsEmpty">
  2287. <summary>
  2288. Gets a value indicating whether this instance is empty.
  2289. </summary>
  2290. </member>
  2291. <member name="P:Nito.Deque`1.IsFull">
  2292. <summary>
  2293. Gets a value indicating whether this instance is at full capacity.
  2294. </summary>
  2295. </member>
  2296. <member name="P:Nito.Deque`1.IsSplit">
  2297. <summary>
  2298. Gets a value indicating whether the buffer is "split" (meaning the beginning of the view is at a later index in
  2299. <see cref="F:Nito.Deque`1.buffer" /> than the end).
  2300. </summary>
  2301. </member>
  2302. <member name="P:Nito.Deque`1.Capacity">
  2303. <summary>
  2304. Gets or sets the capacity for this deque. This value must always be greater than zero, and this property cannot be
  2305. set to a value less than <see cref="P:Nito.Deque`1.Count" />.
  2306. </summary>
  2307. <exception cref="T:System.InvalidOperationException"><c>Capacity</c> cannot be set to a value less than <see cref="P:Nito.Deque`1.Count" />.</exception>
  2308. </member>
  2309. <member name="P:Nito.Deque`1.Count">
  2310. <summary>
  2311. Gets the number of elements contained in this deque.
  2312. </summary>
  2313. <returns>The number of elements contained in this deque.</returns>
  2314. </member>
  2315. <member name="M:Nito.Deque`1.DequeIndexToBufferIndex(System.Int32)">
  2316. <summary>
  2317. Applies the offset to <paramref name="index" />, resulting in a buffer index.
  2318. </summary>
  2319. <param name="index">The deque index.</param>
  2320. <returns>The buffer index.</returns>
  2321. </member>
  2322. <member name="M:Nito.Deque`1.DoGetItem(System.Int32)">
  2323. <summary>
  2324. Gets an element at the specified view index.
  2325. </summary>
  2326. <param name="index">The zero-based view index of the element to get. This index is guaranteed to be valid.</param>
  2327. <returns>The element at the specified index.</returns>
  2328. </member>
  2329. <member name="M:Nito.Deque`1.DoSetItem(System.Int32,`0)">
  2330. <summary>
  2331. Sets an element at the specified view index.
  2332. </summary>
  2333. <param name="index">The zero-based view index of the element to get. This index is guaranteed to be valid.</param>
  2334. <param name="item">The element to store in the list.</param>
  2335. </member>
  2336. <member name="M:Nito.Deque`1.DoInsert(System.Int32,`0)">
  2337. <summary>
  2338. Inserts an element at the specified view index.
  2339. </summary>
  2340. <param name="index">
  2341. The zero-based view index at which the element should be inserted. This index is guaranteed to be
  2342. valid.
  2343. </param>
  2344. <param name="item">The element to store in the list.</param>
  2345. </member>
  2346. <member name="M:Nito.Deque`1.DoRemoveAt(System.Int32)">
  2347. <summary>
  2348. Removes an element at the specified view index.
  2349. </summary>
  2350. <param name="index">The zero-based view index of the element to remove. This index is guaranteed to be valid.</param>
  2351. </member>
  2352. <member name="M:Nito.Deque`1.PostIncrement(System.Int32)">
  2353. <summary>
  2354. Increments <see cref="F:Nito.Deque`1.offset" /> by <paramref name="value" /> using modulo-<see cref="P:Nito.Deque`1.Capacity" /> arithmetic.
  2355. </summary>
  2356. <param name="value">The value by which to increase <see cref="F:Nito.Deque`1.offset" />. May not be negative.</param>
  2357. <returns>The value of <see cref="F:Nito.Deque`1.offset" /> after it was incremented.</returns>
  2358. </member>
  2359. <member name="M:Nito.Deque`1.PreDecrement(System.Int32)">
  2360. <summary>
  2361. Decrements <see cref="F:Nito.Deque`1.offset" /> by <paramref name="value" /> using modulo-<see cref="P:Nito.Deque`1.Capacity" /> arithmetic.
  2362. </summary>
  2363. <param name="value">
  2364. The value by which to reduce <see cref="F:Nito.Deque`1.offset" />. May not be negative or greater than
  2365. <see cref="P:Nito.Deque`1.Capacity" />.
  2366. </param>
  2367. <returns>The value of <see cref="F:Nito.Deque`1.offset" /> before it was decremented.</returns>
  2368. </member>
  2369. <member name="M:Nito.Deque`1.DoAddToBack(`0)">
  2370. <summary>
  2371. Inserts a single element to the back of the view. <see cref="P:Nito.Deque`1.IsFull" /> must be false when this method is called.
  2372. </summary>
  2373. <param name="value">The element to insert.</param>
  2374. </member>
  2375. <member name="M:Nito.Deque`1.DoAddToFront(`0)">
  2376. <summary>
  2377. Inserts a single element to the front of the view. <see cref="P:Nito.Deque`1.IsFull" /> must be false when this method is called.
  2378. </summary>
  2379. <param name="value">The element to insert.</param>
  2380. </member>
  2381. <member name="M:Nito.Deque`1.DoRemoveFromBack">
  2382. <summary>
  2383. Removes and returns the last element in the view. <see cref="P:Nito.Deque`1.IsEmpty" /> must be false when this method is called.
  2384. </summary>
  2385. <returns>The former last element.</returns>
  2386. </member>
  2387. <member name="M:Nito.Deque`1.DoRemoveFromFront">
  2388. <summary>
  2389. Removes and returns the first element in the view. <see cref="P:Nito.Deque`1.IsEmpty" /> must be false when this method is called.
  2390. </summary>
  2391. <returns>The former first element.</returns>
  2392. </member>
  2393. <member name="M:Nito.Deque`1.DoInsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Int32)">
  2394. <summary>
  2395. Inserts a range of elements into the view.
  2396. </summary>
  2397. <param name="index">The index into the view at which the elements are to be inserted.</param>
  2398. <param name="collection">The elements to insert.</param>
  2399. <param name="collectionCount">
  2400. The number of elements in <paramref name="collection" />. Must be greater than zero, and
  2401. the sum of <paramref name="collectionCount" /> and <see cref="P:Nito.Deque`1.Count" /> must be less than or equal to
  2402. <see cref="P:Nito.Deque`1.Capacity" />.
  2403. </param>
  2404. </member>
  2405. <member name="M:Nito.Deque`1.DoRemoveRange(System.Int32,System.Int32)">
  2406. <summary>
  2407. Removes a range of elements from the view.
  2408. </summary>
  2409. <param name="index">The index into the view at which the range begins.</param>
  2410. <param name="collectionCount">
  2411. The number of elements in the range. This must be greater than 0 and less than or equal
  2412. to <see cref="P:Nito.Deque`1.Count" />.
  2413. </param>
  2414. </member>
  2415. <member name="M:Nito.Deque`1.EnsureCapacityForOneElement">
  2416. <summary>
  2417. Doubles the capacity if necessary to make room for one more element. When this method returns,
  2418. <see cref="P:Nito.Deque`1.IsFull" /> is false.
  2419. </summary>
  2420. </member>
  2421. <member name="M:Nito.Deque`1.AddToBack(`0)">
  2422. <summary>
  2423. Inserts a single element at the back of this deque.
  2424. </summary>
  2425. <param name="value">The element to insert.</param>
  2426. </member>
  2427. <member name="M:Nito.Deque`1.AddToFront(`0)">
  2428. <summary>
  2429. Inserts a single element at the front of this deque.
  2430. </summary>
  2431. <param name="value">The element to insert.</param>
  2432. </member>
  2433. <member name="M:Nito.Deque`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
  2434. <summary>
  2435. Inserts a collection of elements into this deque.
  2436. </summary>
  2437. <param name="index">The index at which the collection is inserted.</param>
  2438. <param name="collection">The collection of elements to insert.</param>
  2439. <exception cref="T:System.ArgumentOutOfRangeException">
  2440. <paramref name="index" /> is not a valid index to an insertion point for
  2441. the source.
  2442. </exception>
  2443. </member>
  2444. <member name="M:Nito.Deque`1.RemoveRange(System.Int32,System.Int32)">
  2445. <summary>
  2446. Removes a range of elements from this deque.
  2447. </summary>
  2448. <param name="offset">The index into the deque at which the range begins.</param>
  2449. <param name="count">The number of elements to remove.</param>
  2450. <exception cref="T:System.ArgumentOutOfRangeException">
  2451. Either <paramref name="offset" /> or <paramref name="count" /> is less
  2452. than 0.
  2453. </exception>
  2454. <exception cref="T:System.ArgumentException">
  2455. The range [<paramref name="offset" />, <paramref name="offset" /> +
  2456. <paramref name="count" />) is not within the range [0, <see cref="P:Nito.Deque`1.Count" />).
  2457. </exception>
  2458. </member>
  2459. <member name="M:Nito.Deque`1.RemoveFromBack">
  2460. <summary>
  2461. Removes and returns the last element of this deque.
  2462. </summary>
  2463. <returns>The former last element.</returns>
  2464. <exception cref="T:System.InvalidOperationException">The deque is empty.</exception>
  2465. </member>
  2466. <member name="M:Nito.Deque`1.RemoveFromFront">
  2467. <summary>
  2468. Removes and returns the first element of this deque.
  2469. </summary>
  2470. <returns>The former first element.</returns>
  2471. <exception cref="T:System.InvalidOperationException">The deque is empty.</exception>
  2472. </member>
  2473. <member name="M:Nito.Deque`1.Clear">
  2474. <summary>
  2475. Removes all items from this deque.
  2476. </summary>
  2477. </member>
  2478. </members>
  2479. </doc>