DotNetty.Common.xml 122 KB

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