DotNetty.Buffers.xml 126 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DotNetty.Buffers</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DotNetty.Buffers.AbstractByteBuffer">
  8. <inheritdoc />
  9. <summary>
  10. Abstract base class implementation of a <see cref="T:DotNetty.Buffers.IByteBuffer" />
  11. </summary>
  12. </member>
  13. <member name="T:DotNetty.Buffers.AbstractByteBufferAllocator">
  14. <inheritdoc />
  15. <summary>
  16. Abstract base class for <see cref="T:DotNetty.Buffers.IByteBufferAllocator" /> instances
  17. </summary>
  18. </member>
  19. <member name="T:DotNetty.Buffers.AbstractDerivedByteBuffer">
  20. <inheritdoc />
  21. <summary>
  22. Abstract base class for <see cref="T:DotNetty.Buffers.IByteBuffer" /> implementations that wrap another
  23. <see cref="T:DotNetty.Buffers.IByteBuffer" />.
  24. </summary>
  25. </member>
  26. <member name="M:DotNetty.Buffers.ByteBufferUtil.HexDump(DotNetty.Buffers.IByteBuffer)">
  27. <summary>
  28. Returns a <a href="http://en.wikipedia.org/wiki/Hex_dump">hex dump</a>
  29. of the specified buffer's sub-region.
  30. </summary>
  31. </member>
  32. <member name="M:DotNetty.Buffers.ByteBufferUtil.HexDump(DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  33. <summary>
  34. Returns a <a href="http://en.wikipedia.org/wiki/Hex_dump">hex dump</a>
  35. of the specified buffer's sub-region.
  36. </summary>
  37. </member>
  38. <member name="M:DotNetty.Buffers.ByteBufferUtil.HexDump(System.Byte[])">
  39. <summary>
  40. Returns a <a href="http://en.wikipedia.org/wiki/Hex_dump">hex dump</a>
  41. of the specified buffer's sub-region.
  42. </summary>
  43. </member>
  44. <member name="M:DotNetty.Buffers.ByteBufferUtil.HexDump(System.Byte[],System.Int32,System.Int32)">
  45. <summary>
  46. Returns a <a href="http://en.wikipedia.org/wiki/Hex_dump">hex dump</a>
  47. of the specified buffer's sub-region.
  48. </summary>
  49. </member>
  50. <member name="M:DotNetty.Buffers.ByteBufferUtil.HashCode(DotNetty.Buffers.IByteBuffer)">
  51. <summary>
  52. Calculates the hash code of the specified buffer. This method is
  53. useful when implementing a new buffer type.
  54. </summary>
  55. </member>
  56. <member name="M:DotNetty.Buffers.ByteBufferUtil.IndexOf(DotNetty.Buffers.IByteBuffer,DotNetty.Buffers.IByteBuffer)">
  57. <summary>
  58. Returns the reader index of needle in haystack, or -1 if needle is not in haystack.
  59. </summary>
  60. </member>
  61. <member name="M:DotNetty.Buffers.ByteBufferUtil.Equals(DotNetty.Buffers.IByteBuffer,System.Int32,DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  62. <summary>
  63. Returns {@code true} if and only if the two specified buffers are
  64. identical to each other for {@code length} bytes starting at {@code aStartIndex}
  65. index for the {@code a} buffer and {@code bStartIndex} index for the {@code b} buffer.
  66. A more compact way to express this is:
  67. <p />
  68. {@code a[aStartIndex : aStartIndex + length] == b[bStartIndex : bStartIndex + length]}
  69. </summary>
  70. </member>
  71. <member name="M:DotNetty.Buffers.ByteBufferUtil.Equals(DotNetty.Buffers.IByteBuffer,DotNetty.Buffers.IByteBuffer)">
  72. <summary>
  73. Returns {@code true} if and only if the two specified buffers are
  74. identical to each other as described in {@link ByteBuf#equals(Object)}.
  75. This method is useful when implementing a new buffer type.
  76. </summary>
  77. </member>
  78. <member name="M:DotNetty.Buffers.ByteBufferUtil.Compare(DotNetty.Buffers.IByteBuffer,DotNetty.Buffers.IByteBuffer)">
  79. <summary>
  80. Compares the two specified buffers as described in {@link ByteBuf#compareTo(ByteBuf)}.
  81. This method is useful when implementing a new buffer type.
  82. </summary>
  83. </member>
  84. <member name="M:DotNetty.Buffers.ByteBufferUtil.IndexOf(DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32,System.Byte)">
  85. <summary>
  86. The default implementation of <see cref="M:DotNetty.Buffers.IByteBuffer.IndexOf(System.Int32,System.Int32,System.Byte)"/>.
  87. This method is useful when implementing a new buffer type.
  88. </summary>
  89. </member>
  90. <member name="M:DotNetty.Buffers.ByteBufferUtil.ReadBytes(DotNetty.Buffers.IByteBufferAllocator,DotNetty.Buffers.IByteBuffer,System.Int32)">
  91. <summary>
  92. Read the given amount of bytes into a new {@link ByteBuf} that is allocated from the {@link ByteBufAllocator}.
  93. </summary>
  94. </member>
  95. <member name="M:DotNetty.Buffers.ByteBufferUtil.ReserveAndWriteUtf8(DotNetty.Buffers.IByteBuffer,System.String,System.Int32)">
  96. <summary>
  97. Encode a string in http://en.wikipedia.org/wiki/UTF-8 and write it into reserveBytes of
  98. a byte buffer. The reserveBytes must be computed (ie eagerly using {@link #utf8MaxBytes(string)}
  99. or exactly with #utf8Bytes(string)}) to ensure this method not to not: for performance reasons
  100. the index checks will be performed using just reserveBytes.
  101. </summary>
  102. <returns> This method returns the actual number of bytes written.</returns>
  103. </member>
  104. <member name="M:DotNetty.Buffers.ByteBufferUtil.EncodeString(DotNetty.Buffers.IByteBufferAllocator,System.String,System.Text.Encoding)">
  105. <summary>
  106. Encode the given <see cref="T:System.String" /> using the given <see cref="T:System.Text.Encoding" /> into a new
  107. <see cref="T:DotNetty.Buffers.IByteBuffer" /> which
  108. is allocated via the <see cref="T:DotNetty.Buffers.IByteBufferAllocator" />.
  109. </summary>
  110. <param name="alloc">The <see cref="T:DotNetty.Buffers.IByteBufferAllocator" /> to allocate {@link IByteBuffer}.</param>
  111. <param name="src">src The <see cref="T:System.String" /> to encode.</param>
  112. <param name="encoding">charset The specified <see cref="T:System.Text.Encoding" /></param>
  113. </member>
  114. <member name="M:DotNetty.Buffers.ByteBufferUtil.EncodeString(DotNetty.Buffers.IByteBufferAllocator,System.String,System.Text.Encoding,System.Int32)">
  115. <summary>
  116. Encode the given <see cref="T:System.String" /> using the given <see cref="T:System.Text.Encoding" /> into a new
  117. <see cref="T:DotNetty.Buffers.IByteBuffer" /> which
  118. is allocated via the <see cref="T:DotNetty.Buffers.IByteBufferAllocator" />.
  119. </summary>
  120. <param name="alloc">The <see cref="T:DotNetty.Buffers.IByteBufferAllocator" /> to allocate {@link IByteBuffer}.</param>
  121. <param name="src">src The <see cref="T:System.String" /> to encode.</param>
  122. <param name="encoding">charset The specified <see cref="T:System.Text.Encoding" /></param>
  123. <param name="extraCapacity">the extra capacity to alloc except the space for decoding.</param>
  124. </member>
  125. <member name="M:DotNetty.Buffers.ByteBufferUtil.PrettyHexDump(DotNetty.Buffers.IByteBuffer)">
  126. <summary>
  127. Returns a multi-line hexadecimal dump of the specified {@link ByteBuf} that is easy to read by humans.
  128. </summary>
  129. </member>
  130. <member name="M:DotNetty.Buffers.ByteBufferUtil.PrettyHexDump(DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  131. <summary>
  132. Returns a multi-line hexadecimal dump of the specified {@link ByteBuf} that is easy to read by humans,
  133. starting at the given {@code offset} using the given {@code length}.
  134. </summary>
  135. </member>
  136. <member name="M:DotNetty.Buffers.ByteBufferUtil.AppendPrettyHexDump(System.Text.StringBuilder,DotNetty.Buffers.IByteBuffer)">
  137. <summary>
  138. Appends the prettified multi-line hexadecimal dump of the specified {@link ByteBuf} to the specified
  139. {@link StringBuilder} that is easy to read by humans.
  140. </summary>
  141. </member>
  142. <member name="M:DotNetty.Buffers.ByteBufferUtil.AppendPrettyHexDump(System.Text.StringBuilder,DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  143. <summary>
  144. Appends the prettified multi-line hexadecimal dump of the specified {@link ByteBuf} to the specified
  145. {@link StringBuilder} that is easy to read by humans, starting at the given {@code offset} using
  146. the given {@code length}.
  147. </summary>
  148. </member>
  149. <member name="M:DotNetty.Buffers.ByteBufferUtil.SwapLong(System.Int64)">
  150. <summary>
  151. Toggles the endianness of the specified 64-bit long integer.
  152. </summary>
  153. </member>
  154. <member name="M:DotNetty.Buffers.ByteBufferUtil.SwapInt(System.Int32)">
  155. <summary>
  156. Toggles the endianness of the specified 32-bit integer.
  157. </summary>
  158. </member>
  159. <member name="M:DotNetty.Buffers.ByteBufferUtil.SwapShort(System.Int16)">
  160. <summary>
  161. Toggles the endianness of the specified 16-bit integer.
  162. </summary>
  163. </member>
  164. <member name="F:DotNetty.Buffers.ByteOrder.LittleEndian">
  165. <summary>
  166. Default on most Windows systems
  167. </summary>
  168. </member>
  169. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponent(DotNetty.Buffers.IByteBuffer)">
  170. <summary>
  171. Add the given {@link IByteBuffer}.
  172. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  173. If you need to have it increased you need to handle it by your own.
  174. @param buffer the {@link IByteBuffer} to add
  175. </summary>
  176. </member>
  177. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponents(DotNetty.Buffers.IByteBuffer[])">
  178. <summary>
  179. Add the given {@link IByteBuffer}s.
  180. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  181. If you need to have it increased you need to handle it by your own.
  182. @param buffers the {@link IByteBuffer}s to add
  183. </summary>
  184. </member>
  185. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponents(System.Collections.Generic.IEnumerable{DotNetty.Buffers.IByteBuffer})">
  186. <summary>
  187. Add the given {@link IByteBuffer}s.
  188. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  189. If you need to have it increased you need to handle it by your own.
  190. @param buffers the {@link IByteBuffer}s to add
  191. </summary>
  192. </member>
  193. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponent(System.Int32,DotNetty.Buffers.IByteBuffer)">
  194. <summary>
  195. Add the given {@link IByteBuffer} on the specific index.
  196. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  197. If you need to have it increased you need to handle it by your own.
  198. @param cIndex the index on which the {@link IByteBuffer} will be added
  199. @param buffer the {@link IByteBuffer} to add
  200. </summary>
  201. </member>
  202. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponents(System.Int32,DotNetty.Buffers.IByteBuffer[])">
  203. <summary>
  204. Add the given {@link IByteBuffer}s on the specific index
  205. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  206. If you need to have it increased you need to handle it by your own.
  207. @param cIndex the index on which the {@link IByteBuffer} will be added.
  208. @param buffers the {@link IByteBuffer}s to add
  209. </summary>
  210. </member>
  211. <member name="M:DotNetty.Buffers.CompositeByteBuffer.AddComponents(System.Int32,System.Collections.Generic.IEnumerable{DotNetty.Buffers.IByteBuffer})">
  212. <summary>
  213. Add the given {@link ByteBuf}s on the specific index
  214. Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuffer}.
  215. If you need to have it increased you need to handle it by your own.
  216. @param cIndex the index on which the {@link IByteBuffer} will be added.
  217. @param buffers the {@link IByteBuffer}s to add
  218. </summary>
  219. </member>
  220. <member name="M:DotNetty.Buffers.CompositeByteBuffer.ConsolidateIfNeeded">
  221. <summary>
  222. This should only be called as last operation from a method as this may adjust the underlying
  223. array of components and so affect the index etc.
  224. </summary>
  225. </member>
  226. <member name="M:DotNetty.Buffers.CompositeByteBuffer.RemoveComponent(System.Int32)">
  227. <summary>
  228. Remove the {@link IByteBuffer} from the given index.
  229. @param cIndex the index on from which the {@link IByteBuffer} will be remove
  230. </summary>
  231. </member>
  232. <member name="M:DotNetty.Buffers.CompositeByteBuffer.RemoveComponents(System.Int32,System.Int32)">
  233. <summary>
  234. Remove the number of {@link IByteBuffer}s starting from the given index.
  235. @param cIndex the index on which the {@link IByteBuffer}s will be started to removed
  236. @param numComponents the number of components to remove
  237. </summary>
  238. </member>
  239. <member name="M:DotNetty.Buffers.CompositeByteBuffer.Decompose(System.Int32,System.Int32)">
  240. <summary>
  241. Same with {@link #slice(int, int)} except that this method returns a list.
  242. </summary>
  243. </member>
  244. <member name="P:DotNetty.Buffers.CompositeByteBuffer.NumComponents">
  245. <summary>
  246. Return the current number of {@link IByteBuffer}'s that are composed in this instance
  247. </summary>
  248. </member>
  249. <member name="P:DotNetty.Buffers.CompositeByteBuffer.MaxNumComponents">
  250. <summary>
  251. Return the max number of {@link IByteBuffer}'s that are composed in this instance
  252. </summary>
  253. </member>
  254. <member name="M:DotNetty.Buffers.CompositeByteBuffer.ToComponentIndex(System.Int32)">
  255. <summary>
  256. Return the index for the given offset
  257. </summary>
  258. </member>
  259. <member name="P:DotNetty.Buffers.CompositeByteBuffer.Item(System.Int32)">
  260. <summary>
  261. Return the {@link IByteBuffer} on the specified index
  262. @param cIndex the index for which the {@link IByteBuffer} should be returned
  263. @return buffer the {@link IByteBuffer} on the specified index
  264. </summary>
  265. </member>
  266. <member name="M:DotNetty.Buffers.CompositeByteBuffer.ComponentAtOffset(System.Int32)">
  267. <summary>
  268. Return the {@link IByteBuffer} on the specified index
  269. @param offset the offset for which the {@link IByteBuffer} should be returned
  270. @return the {@link IByteBuffer} on the specified index
  271. </summary>
  272. </member>
  273. <member name="M:DotNetty.Buffers.CompositeByteBuffer.InternalComponent(System.Int32)">
  274. <summary>
  275. Return the internal {@link IByteBuffer} on the specified index. Note that updating the indexes of the returned
  276. buffer will lead to an undefined behavior of this buffer.
  277. @param cIndex the index for which the {@link IByteBuffer} should be returned
  278. </summary>
  279. </member>
  280. <member name="M:DotNetty.Buffers.CompositeByteBuffer.InternalComponentAtOffset(System.Int32)">
  281. <summary>
  282. Return the internal {@link IByteBuffer} on the specified offset. Note that updating the indexes of the returned
  283. buffer will lead to an undefined behavior of this buffer.
  284. @param offset the offset for which the {@link IByteBuffer} should be returned
  285. </summary>
  286. </member>
  287. <member name="M:DotNetty.Buffers.CompositeByteBuffer.Consolidate">
  288. <summary>
  289. Consolidate the composed {@link IByteBuffer}s
  290. </summary>
  291. </member>
  292. <member name="M:DotNetty.Buffers.CompositeByteBuffer.Consolidate(System.Int32,System.Int32)">
  293. <summary>
  294. Consolidate the composed {@link IByteBuffer}s
  295. @param cIndex the index on which to start to compose
  296. @param numComponents the number of components to compose
  297. </summary>
  298. </member>
  299. <member name="M:DotNetty.Buffers.CompositeByteBuffer.DiscardReadComponents">
  300. <summary>
  301. Discard all {@link IByteBuffer}s which are read.
  302. </summary>
  303. </member>
  304. <member name="T:DotNetty.Buffers.EmptyByteBuffer">
  305. <inheritdoc />
  306. <summary>
  307. Represents an empty byte buffer
  308. </summary>
  309. </member>
  310. <member name="T:DotNetty.Buffers.IByteBuffer">
  311. <summary>
  312. Inspired by the Netty ByteBuffer implementation
  313. (https://github.com/netty/netty/blob/master/buffer/src/main/java/io/netty/buffer/ByteBuf.java)
  314. Provides circular-buffer-esque security around a byte array, allowing reads and writes to occur independently.
  315. In general, the <see cref="T:DotNetty.Buffers.IByteBuffer" /> guarantees:
  316. /// <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> LESS THAN OR EQUAL TO <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> LESS THAN OR EQUAL TO
  317. <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />.
  318. </summary>
  319. </member>
  320. <member name="M:DotNetty.Buffers.IByteBuffer.AdjustCapacity(System.Int32)">
  321. <summary>
  322. Expands the capacity of this buffer so long as it is less than <see cref="P:DotNetty.Buffers.IByteBuffer.MaxCapacity" />.
  323. </summary>
  324. </member>
  325. <member name="P:DotNetty.Buffers.IByteBuffer.Allocator">
  326. <summary>
  327. The allocator who created this buffer
  328. </summary>
  329. </member>
  330. <member name="M:DotNetty.Buffers.IByteBuffer.SetWriterIndex(System.Int32)">
  331. <summary>
  332. Sets the <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer
  333. </summary>
  334. <exception cref="T:System.IndexOutOfRangeException">thrown if <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> exceeds the length of the buffer</exception>
  335. </member>
  336. <member name="M:DotNetty.Buffers.IByteBuffer.SetReaderIndex(System.Int32)">
  337. <summary>
  338. Sets the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> of this buffer
  339. </summary>
  340. <exception cref="T:System.IndexOutOfRangeException">
  341. thrown if <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> is greater than
  342. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> or less than <c>0</c>.
  343. </exception>
  344. </member>
  345. <member name="M:DotNetty.Buffers.IByteBuffer.SetIndex(System.Int32,System.Int32)">
  346. <summary>
  347. Sets both indexes
  348. </summary>
  349. <exception cref="T:System.IndexOutOfRangeException">
  350. thrown if <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> exceeds
  351. the length of the buffer
  352. </exception>
  353. </member>
  354. <member name="M:DotNetty.Buffers.IByteBuffer.IsReadable">
  355. <summary>
  356. Returns true if <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> - <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> is greater than <c>0</c>.
  357. </summary>
  358. </member>
  359. <member name="M:DotNetty.Buffers.IByteBuffer.IsReadable(System.Int32)">
  360. <summary>
  361. Is the buffer readable if and only if the buffer contains equal or more than the specified number of elements
  362. </summary>
  363. <param name="size">The number of elements we would like to read</param>
  364. </member>
  365. <member name="M:DotNetty.Buffers.IByteBuffer.IsWritable">
  366. <summary>
  367. Returns true if and only if <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> - <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> is greater than zero.
  368. </summary>
  369. </member>
  370. <member name="M:DotNetty.Buffers.IByteBuffer.IsWritable(System.Int32)">
  371. <summary>
  372. Returns true if and only if the buffer has enough <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> to accomodate <paramref name="size" />
  373. additional bytes.
  374. </summary>
  375. <param name="size">The number of additional elements we would like to write.</param>
  376. </member>
  377. <member name="M:DotNetty.Buffers.IByteBuffer.Clear">
  378. <summary>
  379. Sets the <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> to <c>0</c>. Does not erase any of the data
  380. written into the buffer already,
  381. but it will overwrite that data.
  382. </summary>
  383. </member>
  384. <member name="M:DotNetty.Buffers.IByteBuffer.MarkReaderIndex">
  385. <summary>
  386. Marks the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in this buffer. You can reposition the current
  387. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  388. to the marked <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by calling <see cref="M:DotNetty.Buffers.IByteBuffer.ResetReaderIndex" />.
  389. The initial value of the marked <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> is <c>0</c>.
  390. </summary>
  391. </member>
  392. <member name="M:DotNetty.Buffers.IByteBuffer.ResetReaderIndex">
  393. <summary>
  394. Repositions the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> to the marked <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in this buffer.
  395. </summary>
  396. <exception cref="T:System.IndexOutOfRangeException">
  397. is thrown if the current <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> is less than the
  398. marked <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  399. </exception>
  400. </member>
  401. <member name="M:DotNetty.Buffers.IByteBuffer.MarkWriterIndex">
  402. <summary>
  403. Marks the current <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> in this buffer. You can reposition the current
  404. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  405. to the marked <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> by calling <see cref="M:DotNetty.Buffers.IByteBuffer.ResetWriterIndex" />.
  406. The initial value of the marked <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> is <c>0</c>.
  407. </summary>
  408. </member>
  409. <member name="M:DotNetty.Buffers.IByteBuffer.ResetWriterIndex">
  410. <summary>
  411. Repositions the current <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> to the marked <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> in this buffer.
  412. </summary>
  413. <exception cref="T:System.IndexOutOfRangeException">
  414. is thrown if the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> is greater than the
  415. marked <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  416. </exception>
  417. </member>
  418. <member name="M:DotNetty.Buffers.IByteBuffer.DiscardReadBytes">
  419. <summary>
  420. Discards the bytes between the 0th index and <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />.
  421. It moves the bytes between <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> to the 0th index,
  422. and sets <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> to <c>0</c> and
  423. <c>oldWriterIndex - oldReaderIndex</c> respectively.
  424. </summary>
  425. </member>
  426. <member name="M:DotNetty.Buffers.IByteBuffer.DiscardSomeReadBytes">
  427. <summary>
  428. Similar to <see cref="M:DotNetty.Buffers.IByteBuffer.DiscardReadBytes" /> except that this method might discard
  429. some, all, or none of read bytes depending on its internal implementation to reduce
  430. overall memory bandwidth consumption at the cost of potentially additional memory
  431. consumption.
  432. </summary>
  433. </member>
  434. <member name="M:DotNetty.Buffers.IByteBuffer.EnsureWritable(System.Int32)">
  435. <summary>
  436. Makes sure the number of <see cref="P:DotNetty.Buffers.IByteBuffer.WritableBytes" /> is equal to or greater than
  437. the specified value (<paramref name="minWritableBytes" />.) If there is enough writable bytes in this buffer,
  438. the method returns with no side effect. Otherwise, it raises an <see cref="T:System.ArgumentOutOfRangeException" />.
  439. </summary>
  440. <param name="minWritableBytes">The expected number of minimum writable bytes</param>
  441. <exception cref="T:System.IndexOutOfRangeException">
  442. if <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> + <paramref name="minWritableBytes" /> >
  443. <see cref="P:DotNetty.Buffers.IByteBuffer.MaxCapacity" />.
  444. </exception>
  445. </member>
  446. <member name="M:DotNetty.Buffers.IByteBuffer.EnsureWritable(System.Int32,System.Boolean)">
  447. <summary>
  448. Tries to make sure the number of <see cref="P:DotNetty.Buffers.IByteBuffer.WritableBytes" />
  449. is equal to or greater than the specified value. Unlike <see cref="M:DotNetty.Buffers.IByteBuffer.EnsureWritable(System.Int32)" />,
  450. this method does not raise an exception but returns a code.
  451. </summary>
  452. <param name="minWritableBytes">the expected minimum number of writable bytes</param>
  453. <param name="force">
  454. When <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> + <c>minWritableBytes</c> > <see cref="P:DotNetty.Buffers.IByteBuffer.MaxCapacity" />:
  455. <ul>
  456. <li><c>true</c> - the capacity of the buffer is expanded to <see cref="P:DotNetty.Buffers.IByteBuffer.MaxCapacity" /></li>
  457. <li><c>false</c> - the capacity of the buffer is unchanged</li>
  458. </ul>
  459. </param>
  460. <returns>
  461. <c>0</c> if the buffer has enough writable bytes, and its capacity is unchanged.
  462. <c>1</c> if the buffer does not have enough bytes, and its capacity is unchanged.
  463. <c>2</c> if the buffer has enough writable bytes, and its capacity has been increased.
  464. <c>3</c> if the buffer does not have enough bytes, but its capacity has been increased to its maximum.
  465. </returns>
  466. </member>
  467. <member name="M:DotNetty.Buffers.IByteBuffer.GetBoolean(System.Int32)">
  468. <summary>
  469. Gets a boolean at the specified absolute <paramref name="index" /> in this buffer.
  470. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  471. of this buffer.
  472. </summary>
  473. <exception cref="T:System.IndexOutOfRangeException">
  474. if the specified <paramref name="index" /> is less than <c>0</c> or
  475. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  476. </exception>
  477. </member>
  478. <member name="M:DotNetty.Buffers.IByteBuffer.GetByte(System.Int32)">
  479. <summary>
  480. Gets a byte at the specified absolute <paramref name="index" /> in this buffer.
  481. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  482. of this buffer.
  483. </summary>
  484. <exception cref="T:System.IndexOutOfRangeException">
  485. if the specified <paramref name="index" /> is less than <c>0</c> or
  486. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  487. </exception>
  488. </member>
  489. <member name="M:DotNetty.Buffers.IByteBuffer.GetShort(System.Int32)">
  490. <summary>
  491. Gets a short at the specified absolute <paramref name="index" /> in this buffer.
  492. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  493. of this buffer.
  494. </summary>
  495. <exception cref="T:System.IndexOutOfRangeException">
  496. if the specified <paramref name="index" /> is less than <c>0</c> or
  497. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  498. </exception>
  499. </member>
  500. <member name="M:DotNetty.Buffers.IByteBuffer.GetShortLE(System.Int32)">
  501. <summary>
  502. Gets a short at the specified absolute <paramref name="index" /> in this buffer
  503. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  504. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  505. </summary>
  506. <exception cref="T:System.IndexOutOfRangeException">
  507. if the specified <paramref name="index" /> is less than <c>0</c> or
  508. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  509. </exception>
  510. </member>
  511. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedShort(System.Int32)">
  512. <summary>
  513. Gets an ushort at the specified absolute <paramref name="index" /> in this buffer.
  514. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  515. of this buffer.
  516. </summary>
  517. <exception cref="T:System.IndexOutOfRangeException">
  518. if the specified <paramref name="index" /> is less than <c>0</c> or
  519. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  520. </exception>
  521. </member>
  522. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedShortLE(System.Int32)">
  523. <summary>
  524. Gets an ushort at the specified absolute <paramref name="index" /> in this buffer
  525. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  526. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  527. </summary>
  528. <exception cref="T:System.IndexOutOfRangeException">
  529. if the specified <paramref name="index" /> is less than <c>0</c> or
  530. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  531. </exception>
  532. </member>
  533. <member name="M:DotNetty.Buffers.IByteBuffer.GetInt(System.Int32)">
  534. <summary>
  535. Gets an integer at the specified absolute <paramref name="index" /> in this buffer.
  536. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  537. of this buffer.
  538. </summary>
  539. <exception cref="T:System.IndexOutOfRangeException">
  540. if the specified <paramref name="index" /> is less than <c>0</c> or
  541. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  542. </exception>
  543. </member>
  544. <member name="M:DotNetty.Buffers.IByteBuffer.GetIntLE(System.Int32)">
  545. <summary>
  546. Gets an integer at the specified absolute <paramref name="index" /> in this buffer
  547. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  548. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  549. </summary>
  550. <exception cref="T:System.IndexOutOfRangeException">
  551. if the specified <paramref name="index" /> is less than <c>0</c> or
  552. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  553. </exception>
  554. </member>
  555. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedInt(System.Int32)">
  556. <summary>
  557. Gets an unsigned integer at the specified absolute <paramref name="index" /> in this buffer.
  558. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  559. of this buffer.
  560. </summary>
  561. <exception cref="T:System.IndexOutOfRangeException">
  562. if the specified <paramref name="index" /> is less than <c>0</c> or
  563. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  564. </exception>
  565. </member>
  566. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedIntLE(System.Int32)">
  567. <summary>
  568. Gets an unsigned integer at the specified absolute <paramref name="index" /> in this buffer
  569. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  570. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  571. </summary>
  572. <exception cref="T:System.IndexOutOfRangeException">
  573. if the specified <paramref name="index" /> is less than <c>0</c> or
  574. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  575. </exception>
  576. </member>
  577. <member name="M:DotNetty.Buffers.IByteBuffer.GetLong(System.Int32)">
  578. <summary>
  579. Gets a long integer at the specified absolute <paramref name="index" /> in this buffer.
  580. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  581. of this buffer.
  582. </summary>
  583. <exception cref="T:System.IndexOutOfRangeException">
  584. if the specified <paramref name="index" /> is less than <c>0</c> or
  585. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  586. </exception>
  587. </member>
  588. <member name="M:DotNetty.Buffers.IByteBuffer.GetLongLE(System.Int32)">
  589. <summary>
  590. Gets a long integer at the specified absolute <paramref name="index" /> in this buffer
  591. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or
  592. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  593. </summary>
  594. <exception cref="T:System.IndexOutOfRangeException">
  595. if the specified <paramref name="index" /> is less than <c>0</c> or
  596. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  597. </exception>
  598. </member>
  599. <member name="M:DotNetty.Buffers.IByteBuffer.GetMedium(System.Int32)">
  600. <summary>
  601. Gets a 24-bit medium integer at the specified absolute index in this buffer.
  602. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  603. of this buffer.
  604. </summary>
  605. <exception cref="T:System.IndexOutOfRangeException">
  606. if the specified <param name="index"/> is less than <c>0</c> or
  607. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  608. </exception>
  609. </member>
  610. <member name="M:DotNetty.Buffers.IByteBuffer.GetMediumLE(System.Int32)">
  611. <summary>
  612. Gets a 24-bit medium integer at the specified absolute index in this buffer
  613. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  614. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  615. </summary>
  616. <exception cref="T:System.IndexOutOfRangeException">
  617. if the specified <param name="index"/> is less than <c>0</c> or
  618. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  619. </exception>
  620. </member>
  621. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedMedium(System.Int32)">
  622. <summary>
  623. Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer.
  624. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  625. of this buffer.
  626. </summary>
  627. <exception cref="T:System.IndexOutOfRangeException">
  628. if the specified <param name="index"/> is less than <c>0</c> or
  629. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  630. </exception>
  631. </member>
  632. <member name="M:DotNetty.Buffers.IByteBuffer.GetUnsignedMediumLE(System.Int32)">
  633. <summary>
  634. Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer
  635. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  636. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  637. </summary>
  638. <exception cref="T:System.IndexOutOfRangeException">
  639. if the specified <param name="index"/> is less than <c>0</c> or
  640. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  641. </exception>
  642. </member>
  643. <member name="M:DotNetty.Buffers.IByteBuffer.GetChar(System.Int32)">
  644. <summary>
  645. Gets a char at the specified absolute <paramref name="index" /> in this buffer.
  646. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  647. of this buffer.
  648. </summary>
  649. <exception cref="T:System.IndexOutOfRangeException">
  650. if the specified <paramref name="index" /> is less than <c>0</c> or
  651. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  652. </exception>
  653. </member>
  654. <member name="M:DotNetty.Buffers.IByteBuffer.GetFloat(System.Int32)">
  655. <summary>
  656. Gets a float at the specified absolute <paramref name="index"/> in this buffer.
  657. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  658. of this buffer.
  659. </summary>
  660. <exception cref="T:System.IndexOutOfRangeException">
  661. if the specified <paramref name="index"/> is less than <c>0</c> or
  662. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  663. </exception>
  664. </member>
  665. <member name="M:DotNetty.Buffers.IByteBuffer.GetFloatLE(System.Int32)">
  666. <summary>
  667. Gets a float at the specified absolute <paramref name="index"/> in this buffer
  668. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  669. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  670. </summary>
  671. <exception cref="T:System.IndexOutOfRangeException">
  672. if the specified <paramref name="index"/> is less than <c>0</c> or
  673. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  674. </exception>
  675. </member>
  676. <member name="M:DotNetty.Buffers.IByteBuffer.GetDouble(System.Int32)">
  677. <summary>
  678. Gets a double at the specified absolute <paramref name="index" /> in this buffer.
  679. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  680. of this buffer.
  681. </summary>
  682. <exception cref="T:System.IndexOutOfRangeException">
  683. if the specified <paramref name="index" /> is less than <c>0</c> or
  684. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  685. </exception>
  686. </member>
  687. <member name="M:DotNetty.Buffers.IByteBuffer.GetDoubleLE(System.Int32)">
  688. <summary>
  689. Gets a double at the specified absolute <paramref name="index" /> in this buffer
  690. in Little Endian Byte Order. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  691. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  692. </summary>
  693. <exception cref="T:System.IndexOutOfRangeException">
  694. if the specified <paramref name="index" /> is less than <c>0</c> or
  695. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  696. </exception>
  697. </member>
  698. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,DotNetty.Buffers.IByteBuffer)">
  699. <summary>
  700. Transfers this buffers data to the specified <paramref name="destination" /> buffer starting at the specified
  701. absolute <paramref name="index" /> until the destination becomes non-writable.
  702. </summary>
  703. <exception cref="T:System.IndexOutOfRangeException">
  704. if the specified <paramref name="index" /> is less than <c>0</c> or
  705. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  706. </exception>
  707. </member>
  708. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,DotNetty.Buffers.IByteBuffer,System.Int32)">
  709. <summary>
  710. Transfers this buffers data to the specified <paramref name="destination" /> buffer starting at the specified
  711. absolute <paramref name="index" /> until the destination becomes non-writable.
  712. </summary>
  713. <exception cref="T:System.IndexOutOfRangeException">
  714. if the specified <paramref name="index" /> is less than <c>0</c> or
  715. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  716. </exception>
  717. </member>
  718. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  719. <summary>
  720. Transfers this buffers data to the specified <paramref name="destination" /> buffer starting at the specified
  721. absolute <paramref name="index" /> until the destination becomes non-writable.
  722. </summary>
  723. <exception cref="T:System.IndexOutOfRangeException">
  724. if the specified <paramref name="index" /> is less than <c>0</c> or
  725. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  726. </exception>
  727. </member>
  728. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,System.Byte[])">
  729. <summary>
  730. Transfers this buffers data to the specified <paramref name="destination" /> buffer starting at the specified
  731. absolute <paramref name="index" /> until the destination becomes non-writable.
  732. </summary>
  733. <exception cref="T:System.IndexOutOfRangeException">
  734. if the specified <paramref name="index" /> is less than <c>0</c> or
  735. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  736. </exception>
  737. </member>
  738. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,System.Byte[],System.Int32,System.Int32)">
  739. <summary>
  740. Transfers this buffers data to the specified <paramref name="destination" /> buffer starting at the specified
  741. absolute <paramref name="index" /> until the destination becomes non-writable.
  742. </summary>
  743. <exception cref="T:System.IndexOutOfRangeException">
  744. if the specified <paramref name="index" /> is less than <c>0</c> or
  745. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  746. </exception>
  747. </member>
  748. <member name="M:DotNetty.Buffers.IByteBuffer.GetBytes(System.Int32,System.IO.Stream,System.Int32)">
  749. <summary>
  750. Transfers this buffer's data to the specified stream starting at the
  751. specified absolute <c>index</c>.
  752. </summary>
  753. <remarks>
  754. This method does not modify <c>readerIndex</c> or <c>writerIndex</c> of
  755. this buffer.
  756. </remarks>
  757. <param name="index">absolute index in this buffer to start getting bytes from</param>
  758. <param name="destination">destination stream</param>
  759. <param name="length">the number of bytes to transfer</param>
  760. <exception cref="T:System.IndexOutOfRangeException">
  761. if the specified <c>index</c> is less than <c>0</c> or
  762. if <c>index + length</c> is greater than
  763. <c>this.capacity</c>
  764. </exception>
  765. </member>
  766. <member name="M:DotNetty.Buffers.IByteBuffer.GetString(System.Int32,System.Int32,System.Text.Encoding)">
  767. <summary>
  768. Gets a string with the given length at the given index.
  769. </summary>
  770. <param name="index"></param>
  771. <param name="length">length the length to read</param>
  772. <param name="encoding">charset that should be use</param>
  773. <returns>the string value.</returns>
  774. <exception cref="T:System.IndexOutOfRangeException">
  775. if length is greater than readable bytes.
  776. </exception>
  777. </member>
  778. <member name="M:DotNetty.Buffers.IByteBuffer.SetBoolean(System.Int32,System.Boolean)">
  779. <summary>
  780. Sets the specified boolean at the specified absolute <paramref name="index" /> in this buffer.
  781. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  782. </summary>
  783. <exception cref="T:System.IndexOutOfRangeException">
  784. if the specified <paramref name="index" /> is less than <c>0</c> or
  785. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  786. </exception>
  787. </member>
  788. <member name="M:DotNetty.Buffers.IByteBuffer.SetByte(System.Int32,System.Int32)">
  789. <summary>
  790. Sets the specified byte at the specified absolute <paramref name="index" /> in this buffer.
  791. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  792. </summary>
  793. <exception cref="T:System.IndexOutOfRangeException">
  794. if the specified <paramref name="index" /> is less than <c>0</c> or
  795. <c>index + 1</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  796. </exception>
  797. </member>
  798. <member name="M:DotNetty.Buffers.IByteBuffer.SetShort(System.Int32,System.Int32)">
  799. <summary>
  800. Sets the specified short at the specified absolute <paramref name="index" /> in this buffer.
  801. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  802. </summary>
  803. <exception cref="T:System.IndexOutOfRangeException">
  804. if the specified <paramref name="index" /> is less than <c>0</c> or
  805. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  806. </exception>
  807. </member>
  808. <member name="M:DotNetty.Buffers.IByteBuffer.SetShortLE(System.Int32,System.Int32)">
  809. <summary>
  810. Sets the specified short at the specified absolute <paramref name="index" /> in this buffer
  811. in the Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  812. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  813. </summary>
  814. <exception cref="T:System.IndexOutOfRangeException">
  815. if the specified <paramref name="index" /> is less than <c>0</c> or
  816. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  817. </exception>
  818. </member>
  819. <member name="M:DotNetty.Buffers.IByteBuffer.SetUnsignedShort(System.Int32,System.UInt16)">
  820. <summary>
  821. Sets the specified unsigned short at the specified absolute <paramref name="index" /> in this buffer.
  822. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  823. </summary>
  824. <exception cref="T:System.IndexOutOfRangeException">
  825. if the specified <paramref name="index" /> is less than <c>0</c> or
  826. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  827. </exception>
  828. </member>
  829. <member name="M:DotNetty.Buffers.IByteBuffer.SetUnsignedShortLE(System.Int32,System.UInt16)">
  830. <summary>
  831. Sets the specified unsigned short at the specified absolute <paramref name="index" /> in this buffer
  832. in the Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  833. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  834. </summary>
  835. <exception cref="T:System.IndexOutOfRangeException">
  836. if the specified <paramref name="index" /> is less than <c>0</c> or
  837. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  838. </exception>
  839. </member>
  840. <member name="M:DotNetty.Buffers.IByteBuffer.SetInt(System.Int32,System.Int32)">
  841. <summary>
  842. Sets the specified integer at the specified absolute <paramref name="index" /> in this buffer.
  843. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  844. </summary>
  845. <exception cref="T:System.IndexOutOfRangeException">
  846. if the specified <paramref name="index" /> is less than <c>0</c> or
  847. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  848. </exception>
  849. </member>
  850. <member name="M:DotNetty.Buffers.IByteBuffer.SetIntLE(System.Int32,System.Int32)">
  851. <summary>
  852. Sets the specified integer at the specified absolute <paramref name="index" /> in this buffer
  853. in the Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  854. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  855. </summary>
  856. <exception cref="T:System.IndexOutOfRangeException">
  857. if the specified <paramref name="index" /> is less than <c>0</c> or
  858. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  859. </exception>
  860. </member>
  861. <member name="M:DotNetty.Buffers.IByteBuffer.SetUnsignedInt(System.Int32,System.UInt32)">
  862. <summary>
  863. Sets the specified unsigned integer at the specified absolute <paramref name="index" /> in this buffer.
  864. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  865. </summary>
  866. <exception cref="T:System.IndexOutOfRangeException">
  867. if the specified <paramref name="index" /> is less than <c>0</c> or
  868. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  869. </exception>
  870. </member>
  871. <member name="M:DotNetty.Buffers.IByteBuffer.SetUnsignedIntLE(System.Int32,System.UInt32)">
  872. <summary>
  873. Sets the specified unsigned integer at the specified absolute <paramref name="index" /> in this buffer
  874. in the Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or
  875. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  876. </summary>
  877. <exception cref="T:System.IndexOutOfRangeException">
  878. if the specified <paramref name="index" /> is less than <c>0</c> or
  879. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  880. </exception>
  881. </member>
  882. <member name="M:DotNetty.Buffers.IByteBuffer.SetMedium(System.Int32,System.Int32)">
  883. <summary>
  884. Sets the specified 24-bit medium integer at the specified absolute <paramref name="index" /> in this buffer.
  885. Note that the most significant byte is ignored in the specified value.
  886. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  887. </summary>
  888. <exception cref="T:System.IndexOutOfRangeException">
  889. if the specified <paramref name="index" /> is less than <c>0</c> or
  890. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  891. </exception>
  892. </member>
  893. <member name="M:DotNetty.Buffers.IByteBuffer.SetMediumLE(System.Int32,System.Int32)">
  894. <summary>
  895. Sets the specified 24-bit medium integer at the specified absolute <paramref name="index" /> in this buffer.
  896. Note that the most significant byte is ignored in the specified value.
  897. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  898. </summary>
  899. <exception cref="T:System.IndexOutOfRangeException">
  900. if the specified <paramref name="index" /> is less than <c>0</c> or
  901. <c>index + 3</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  902. </exception>
  903. </member>
  904. <member name="M:DotNetty.Buffers.IByteBuffer.SetLong(System.Int32,System.Int64)">
  905. <summary>
  906. Sets the specified long integer at the specified absolute <paramref name="index" /> in this buffer.
  907. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  908. </summary>
  909. <exception cref="T:System.IndexOutOfRangeException">
  910. if the specified <paramref name="index" /> is less than <c>0</c> or
  911. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  912. </exception>
  913. </member>
  914. <member name="M:DotNetty.Buffers.IByteBuffer.SetLongLE(System.Int32,System.Int64)">
  915. <summary>
  916. Sets the specified long integer at the specified absolute <paramref name="index" /> in this buffer
  917. in the Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or
  918. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  919. </summary>
  920. <exception cref="T:System.IndexOutOfRangeException">
  921. if the specified <paramref name="index" /> is less than <c>0</c> or
  922. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  923. </exception>
  924. </member>
  925. <member name="M:DotNetty.Buffers.IByteBuffer.SetChar(System.Int32,System.Char)">
  926. <summary>
  927. Sets the specified UTF-16 char at the specified absolute <paramref name="index" /> in this buffer.
  928. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  929. </summary>
  930. <exception cref="T:System.IndexOutOfRangeException">
  931. if the specified <paramref name="index" /> is less than <c>0</c> or
  932. <c>index + 2</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  933. </exception>
  934. </member>
  935. <member name="M:DotNetty.Buffers.IByteBuffer.SetDouble(System.Int32,System.Double)">
  936. <summary>
  937. Sets the specified double at the specified absolute <paramref name="index" /> in this buffer.
  938. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  939. </summary>
  940. <exception cref="T:System.IndexOutOfRangeException">
  941. if the specified <paramref name="index" /> is less than <c>0</c> or
  942. <c>index + 8</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  943. </exception>
  944. </member>
  945. <member name="M:DotNetty.Buffers.IByteBuffer.SetFloat(System.Int32,System.Single)">
  946. <summary>
  947. Sets the specified float at the specified absolute <paramref name="index" /> in this buffer.
  948. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  949. </summary>
  950. <exception cref="T:System.IndexOutOfRangeException">
  951. if the specified <paramref name="index" /> is less than <c>0</c> or
  952. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  953. </exception>
  954. </member>
  955. <member name="M:DotNetty.Buffers.IByteBuffer.SetDoubleLE(System.Int32,System.Double)">
  956. <summary>
  957. Sets the specified float at the specified absolute <paramref name="index" /> in this buffer
  958. in Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  959. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  960. </summary>
  961. <exception cref="T:System.IndexOutOfRangeException">
  962. if the specified <paramref name="index" /> is less than <c>0</c> or
  963. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  964. </exception>
  965. </member>
  966. <member name="M:DotNetty.Buffers.IByteBuffer.SetFloatLE(System.Int32,System.Single)">
  967. <summary>
  968. Sets the specified float at the specified absolute <paramref name="index" /> in this buffer
  969. in Little Endian Byte Order. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  970. or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  971. </summary>
  972. <exception cref="T:System.IndexOutOfRangeException">
  973. if the specified <paramref name="index" /> is less than <c>0</c> or
  974. <c>index + 4</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  975. </exception>
  976. </member>
  977. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytes(System.Int32,DotNetty.Buffers.IByteBuffer)">
  978. <summary>
  979. Transfers the <paramref name="src" /> byte buffer's contents starting at the specified absolute <paramref name="index" />.
  980. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  981. </summary>
  982. <exception cref="T:System.IndexOutOfRangeException">
  983. if the specified <paramref name="index" /> is less than <c>0</c> or
  984. <c><paramref name="index"/> + <paramref name="src"/>.ReadableBytes</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  985. </exception>
  986. </member>
  987. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytes(System.Int32,DotNetty.Buffers.IByteBuffer,System.Int32)">
  988. <summary>
  989. Transfers the <paramref name="src" /> byte buffer's contents starting at the specified absolute <paramref name="index" />.
  990. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  991. </summary>
  992. <exception cref="T:System.IndexOutOfRangeException">
  993. if the specified <paramref name="index"/> is less than <c>0</c> or
  994. <paramref name="length"/> is less than <c>0</c> or
  995. <c><paramref name="index"/> + <paramref name="length"/></c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  996. </exception>
  997. </member>
  998. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytes(System.Int32,DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32)">
  999. <summary>
  1000. Transfers the <paramref name="src" /> byte buffer's contents starting at the specified absolute <paramref name="index" />.
  1001. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  1002. </summary>
  1003. <exception cref="T:System.IndexOutOfRangeException">
  1004. if the specified <paramref name="index"/> is less than <c>0</c> or
  1005. <paramref name="srcIndex"/> is less than <c>0</c> or
  1006. <paramref name="length"/> is less than <c>0</c> or
  1007. <c><paramref name="index"/> + <paramref name="length"/></c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> or
  1008. <c><paramref name="srcIndex"/> + <paramref name="length"/></c> greater than <c><paramref name="src" />.Capacity</c>
  1009. </exception>
  1010. </member>
  1011. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytes(System.Int32,System.Byte[])">
  1012. <summary>
  1013. Transfers the <paramref name="src" /> byte buffer's contents starting at the specified absolute <paramref name="index" />.
  1014. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  1015. </summary>
  1016. <exception cref="T:System.IndexOutOfRangeException">
  1017. if the specified <paramref name="index" /> is less than <c>0</c> or
  1018. <c><paramref name="index"/> + <paramref name="src"/>.Length</c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" />
  1019. </exception>
  1020. </member>
  1021. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytes(System.Int32,System.Byte[],System.Int32,System.Int32)">
  1022. <summary>
  1023. Transfers the <paramref name="src" /> byte buffer's contents starting at the specified absolute <paramref name="index" />.
  1024. This method does not directly modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer.
  1025. </summary>
  1026. <exception cref="T:System.IndexOutOfRangeException">
  1027. if the specified <paramref name="index"/> is less than <c>0</c> or
  1028. <paramref name="srcIndex"/> is less than <c>0</c> or
  1029. <paramref name="length"/> is less than <c>0</c> or
  1030. <c><paramref name="index"/> + <paramref name="length"/></c> greater than <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> or
  1031. <c><paramref name="srcIndex"/> + <paramref name="length"/></c> greater than <c><paramref name="src" />.Length</c>
  1032. </exception>
  1033. </member>
  1034. <member name="M:DotNetty.Buffers.IByteBuffer.SetBytesAsync(System.Int32,System.IO.Stream,System.Int32,System.Threading.CancellationToken)">
  1035. <summary>
  1036. Transfers the content of the specified source stream to this buffer
  1037. starting at the specified absolute <paramref name="index"/>.
  1038. This method does not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex"/> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex"/> of
  1039. this buffer.
  1040. </summary>
  1041. <param name="index">absolute index in this byte buffer to start writing to</param>
  1042. <param name="src"></param>
  1043. <param name="length">number of bytes to transfer</param>
  1044. <param name="cancellationToken">cancellation token</param>
  1045. <returns>the actual number of bytes read in from the specified channel.</returns>
  1046. <exception cref="T:System.IndexOutOfRangeException">
  1047. if the specified <c>index</c> is less than <c>0</c> or
  1048. if <c>index + length</c> is greater than <c>this.capacity</c>
  1049. </exception>
  1050. </member>
  1051. <member name="M:DotNetty.Buffers.IByteBuffer.SetZero(System.Int32,System.Int32)">
  1052. <summary>
  1053. Fills this buffer with NULL (0x00) starting at the specified
  1054. absolute index. This method does not modify reader index
  1055. or writer index of this buffer
  1056. </summary>
  1057. <param name="index">absolute index in this byte buffer to start writing to</param>
  1058. <param name="length">length the number of <tt>NUL</tt>s to write to the buffer</param>
  1059. <exception cref="T:System.IndexOutOfRangeException">
  1060. if the specified index is less than 0 or if index + length
  1061. is greater than capacity.
  1062. </exception>
  1063. </member>
  1064. <member name="M:DotNetty.Buffers.IByteBuffer.SetString(System.Int32,System.String,System.Text.Encoding)">
  1065. <summary>
  1066. Writes the specified string at the current writer index and increases
  1067. the writer index by the written bytes.
  1068. </summary>
  1069. <param name="index">Index on which the string should be written</param>
  1070. <param name="value">The string value.</param>
  1071. <param name="encoding">Encoding that should be used.</param>
  1072. <returns>The written number of bytes.</returns>
  1073. <exception cref="T:System.IndexOutOfRangeException">
  1074. if writable bytes is not large enough to write the whole string.
  1075. </exception>
  1076. </member>
  1077. <member name="M:DotNetty.Buffers.IByteBuffer.ReadBoolean">
  1078. <summary>
  1079. Gets a boolean at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1080. by <c>1</c> in this buffer.
  1081. </summary>
  1082. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>1</c></exception>
  1083. </member>
  1084. <member name="M:DotNetty.Buffers.IByteBuffer.ReadByte">
  1085. <summary>
  1086. Gets a byte at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1087. by <c>1</c> in this buffer.
  1088. </summary>
  1089. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>1</c></exception>
  1090. </member>
  1091. <member name="M:DotNetty.Buffers.IByteBuffer.ReadShort">
  1092. <summary>
  1093. Gets a short at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1094. by <c>2</c> in this buffer.
  1095. </summary>
  1096. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>2</c></exception>
  1097. </member>
  1098. <member name="M:DotNetty.Buffers.IByteBuffer.ReadShortLE">
  1099. <summary>
  1100. Gets a short at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and increases
  1101. the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>2</c> in this buffer.
  1102. </summary>
  1103. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>2</c></exception>
  1104. </member>
  1105. <member name="M:DotNetty.Buffers.IByteBuffer.ReadMedium">
  1106. <summary>
  1107. Gets a 24-bit medium integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1108. by <c>3</c> in this buffer.
  1109. </summary>
  1110. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>3</c></exception>
  1111. </member>
  1112. <member name="M:DotNetty.Buffers.IByteBuffer.ReadMediumLE">
  1113. <summary>
  1114. Gets a 24-bit medium integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and
  1115. increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>3</c> in this buffer.
  1116. </summary>
  1117. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>3</c></exception>
  1118. </member>
  1119. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedMedium">
  1120. <summary>
  1121. Gets an unsigned 24-bit medium integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1122. by <c>3</c> in this buffer.
  1123. </summary>
  1124. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>3</c></exception>
  1125. </member>
  1126. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedMediumLE">
  1127. <summary>
  1128. Gets an unsigned 24-bit medium integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order
  1129. and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>3</c> in this buffer.
  1130. </summary>
  1131. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>3</c></exception>
  1132. </member>
  1133. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedShort">
  1134. <summary>
  1135. Gets an unsigned short at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1136. by <c>2</c> in this buffer.
  1137. </summary>
  1138. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>2</c></exception>
  1139. </member>
  1140. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedShortLE">
  1141. <summary>
  1142. Gets an unsigned short at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and
  1143. increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>2</c> in this buffer.
  1144. </summary>
  1145. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>2</c></exception>
  1146. </member>
  1147. <member name="M:DotNetty.Buffers.IByteBuffer.ReadInt">
  1148. <summary>
  1149. Gets an integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1150. by <c>4</c> in this buffer.
  1151. </summary>
  1152. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1153. </member>
  1154. <member name="M:DotNetty.Buffers.IByteBuffer.ReadIntLE">
  1155. <summary>
  1156. Gets an integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and increases
  1157. the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>4</c> in this buffer.
  1158. </summary>
  1159. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1160. </member>
  1161. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedInt">
  1162. <summary>
  1163. Gets an unsigned integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1164. by <c>4</c> in this buffer.
  1165. </summary>
  1166. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1167. </member>
  1168. <member name="M:DotNetty.Buffers.IByteBuffer.ReadUnsignedIntLE">
  1169. <summary>
  1170. Gets an unsigned integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and
  1171. increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>4</c> in this buffer.
  1172. </summary>
  1173. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1174. </member>
  1175. <member name="M:DotNetty.Buffers.IByteBuffer.ReadLong">
  1176. <summary>
  1177. Gets an long at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1178. by <c>8</c> in this buffer.
  1179. </summary>
  1180. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1181. </member>
  1182. <member name="M:DotNetty.Buffers.IByteBuffer.ReadLongLE">
  1183. <summary>
  1184. Gets an long at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> in the Little Endian Byte Order and
  1185. increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>8</c> in this buffer.
  1186. </summary>
  1187. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1188. </member>
  1189. <member name="M:DotNetty.Buffers.IByteBuffer.ReadChar">
  1190. <summary>
  1191. Gets a 2-byte UTF-16 character at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the
  1192. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1193. by <c>2</c> in this buffer.
  1194. </summary>
  1195. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>2</c></exception>
  1196. </member>
  1197. <member name="M:DotNetty.Buffers.IByteBuffer.ReadDouble">
  1198. <summary>
  1199. Gets an 8-byte Decimaling integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the
  1200. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1201. by <c>8</c> in this buffer.
  1202. </summary>
  1203. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>8</c></exception>
  1204. </member>
  1205. <member name="M:DotNetty.Buffers.IByteBuffer.ReadDoubleLE">
  1206. <summary>
  1207. Gets an 8-byte Decimaling integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the
  1208. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>8</c> in this buffer in Little Endian Byte Order.
  1209. </summary>
  1210. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>8</c></exception>
  1211. </member>
  1212. <member name="M:DotNetty.Buffers.IByteBuffer.ReadFloat">
  1213. <summary>
  1214. Gets an 4-byte Decimaling integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the
  1215. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />
  1216. by <c>4</c> in this buffer.
  1217. </summary>
  1218. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1219. </member>
  1220. <member name="M:DotNetty.Buffers.IByteBuffer.ReadFloatLE">
  1221. <summary>
  1222. Gets an 4-byte Decimaling integer at the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and increases the
  1223. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by <c>4</c> in this buffer in Little Endian Byte Order.
  1224. </summary>
  1225. <exception cref="T:System.IndexOutOfRangeException">if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <c>4</c></exception>
  1226. </member>
  1227. <member name="M:DotNetty.Buffers.IByteBuffer.ReadBytes(System.Int32)">
  1228. <summary>
  1229. Reads <paramref name="length" /> bytes from this buffer into a new destination buffer.
  1230. </summary>
  1231. <exception cref="T:System.IndexOutOfRangeException">
  1232. if <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> is less than <paramref name="length" />
  1233. </exception>
  1234. </member>
  1235. <member name="M:DotNetty.Buffers.IByteBuffer.ReadBytes(DotNetty.Buffers.IByteBuffer)">
  1236. <summary>
  1237. Transfers bytes from this buffer's data into the specified destination buffer
  1238. starting at the curent <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> until the destination becomes
  1239. non-writable and increases the <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by the number of transferred bytes.
  1240. </summary>
  1241. <exception cref="T:System.IndexOutOfRangeException">
  1242. if <c>destination.<see cref="P:DotNetty.Buffers.IByteBuffer.WritableBytes" /></c> is greater than
  1243. <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" />.
  1244. </exception>
  1245. </member>
  1246. <member name="M:DotNetty.Buffers.IByteBuffer.ReadString(System.Int32,System.Text.Encoding)">
  1247. <summary>
  1248. Gets a string with the given length at the current reader index
  1249. and increases the reader index by the given length.
  1250. </summary>
  1251. <param name="length">The length to read</param>
  1252. <param name="encoding">Encoding that should be used</param>
  1253. <returns>The string value</returns>
  1254. </member>
  1255. <member name="M:DotNetty.Buffers.IByteBuffer.SkipBytes(System.Int32)">
  1256. <summary>
  1257. Increases the current <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> by the specified <paramref name="length" /> in this buffer.
  1258. </summary>
  1259. <exception cref="T:System.IndexOutOfRangeException"> if <paramref name="length" /> is greater than <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" />.</exception>
  1260. </member>
  1261. <member name="P:DotNetty.Buffers.IByteBuffer.IoBufferCount">
  1262. <summary>
  1263. Returns the maximum <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" /> that this buffer holds. Note that
  1264. <see cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers" />
  1265. or <see cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers(System.Int32,System.Int32)" /> might return a less number of <see cref="T:System.ArraySegment`1" />s of
  1266. <see cref="T:System.Byte" />.
  1267. </summary>
  1268. <returns>
  1269. <c>-1</c> if this buffer cannot represent its content as <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" />.
  1270. the number of the underlying <see cref="T:DotNetty.Buffers.IByteBuffer"/>s if this buffer has at least one underlying segment.
  1271. Note that this method does not return <c>0</c> to avoid confusion.
  1272. </returns>
  1273. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer" />
  1274. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer(System.Int32,System.Int32)" />
  1275. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers" />
  1276. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers(System.Int32,System.Int32)" />
  1277. </member>
  1278. <member name="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer">
  1279. <summary>
  1280. Exposes this buffer's readable bytes as an <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" />. Returned segment
  1281. shares the content with this buffer. This method is identical
  1282. to <c>buf.GetIoBuffer(buf.ReaderIndex, buf.ReadableBytes)</c>. This method does not
  1283. modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer. Please note that the
  1284. returned segment will not see the changes of this buffer if this buffer is a dynamic
  1285. buffer and it adjusted its capacity.
  1286. </summary>
  1287. <exception cref="T:System.NotSupportedException">
  1288. if this buffer cannot represent its content as <see cref="T:System.ArraySegment`1" />
  1289. of <see cref="T:System.Byte" />
  1290. </exception>
  1291. <seealso cref="P:DotNetty.Buffers.IByteBuffer.IoBufferCount" />
  1292. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers" />
  1293. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers(System.Int32,System.Int32)" />
  1294. </member>
  1295. <member name="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer(System.Int32,System.Int32)">
  1296. <summary>
  1297. Exposes this buffer's sub-region as an <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" />. Returned segment
  1298. shares the content with this buffer. This method does not
  1299. modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer. Please note that the
  1300. returned segment will not see the changes of this buffer if this buffer is a dynamic
  1301. buffer and it adjusted its capacity.
  1302. </summary>
  1303. <exception cref="T:System.NotSupportedException">
  1304. if this buffer cannot represent its content as <see cref="T:System.ArraySegment`1" />
  1305. of <see cref="T:System.Byte" />
  1306. </exception>
  1307. <seealso cref="P:DotNetty.Buffers.IByteBuffer.IoBufferCount" />
  1308. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers" />
  1309. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers(System.Int32,System.Int32)" />
  1310. </member>
  1311. <member name="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers">
  1312. <summary>
  1313. Exposes this buffer's readable bytes as an array of <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" />. Returned
  1314. segments
  1315. share the content with this buffer. This method does not
  1316. modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer. Please note that
  1317. returned segments will not see the changes of this buffer if this buffer is a dynamic
  1318. buffer and it adjusted its capacity.
  1319. </summary>
  1320. <exception cref="T:System.NotSupportedException">
  1321. if this buffer cannot represent its content with <see cref="T:System.ArraySegment`1" />
  1322. of <see cref="T:System.Byte" />
  1323. </exception>
  1324. <seealso cref="P:DotNetty.Buffers.IByteBuffer.IoBufferCount" />
  1325. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer" />
  1326. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer(System.Int32,System.Int32)" />
  1327. </member>
  1328. <member name="M:DotNetty.Buffers.IByteBuffer.GetIoBuffers(System.Int32,System.Int32)">
  1329. <summary>
  1330. Exposes this buffer's bytes as an array of <see cref="T:System.ArraySegment`1" /> of <see cref="T:System.Byte" /> for the specified
  1331. index and length.
  1332. Returned segments share the content with this buffer. This method does
  1333. not modify <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> or <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" /> of this buffer. Please note that
  1334. returned segments will not see the changes of this buffer if this buffer is a dynamic
  1335. buffer and it adjusted its capacity.
  1336. </summary>
  1337. <exception cref="T:System.NotSupportedException">
  1338. if this buffer cannot represent its content with <see cref="T:System.ArraySegment`1" />
  1339. of <see cref="T:System.Byte" />
  1340. </exception>
  1341. <seealso cref="P:DotNetty.Buffers.IByteBuffer.IoBufferCount" />
  1342. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer" />
  1343. <seealso cref="M:DotNetty.Buffers.IByteBuffer.GetIoBuffer(System.Int32,System.Int32)" />
  1344. </member>
  1345. <member name="P:DotNetty.Buffers.IByteBuffer.HasArray">
  1346. <summary>
  1347. Flag that indicates if this <see cref="T:DotNetty.Buffers.IByteBuffer" /> is backed by a byte array or not
  1348. </summary>
  1349. </member>
  1350. <member name="P:DotNetty.Buffers.IByteBuffer.Array">
  1351. <summary>
  1352. Grabs the underlying byte array for this buffer
  1353. </summary>
  1354. </member>
  1355. <member name="P:DotNetty.Buffers.IByteBuffer.HasMemoryAddress">
  1356. <summary>
  1357. Returns {@code true} if and only if this buffer has a reference to the low-level memory address that points
  1358. to the backing data.
  1359. </summary>
  1360. </member>
  1361. <member name="M:DotNetty.Buffers.IByteBuffer.GetPinnableMemoryAddress">
  1362. <summary>
  1363. Returns the low-level memory address that point to the first byte of ths backing data.
  1364. </summary>
  1365. <returns>The low-level memory address</returns>
  1366. </member>
  1367. <member name="M:DotNetty.Buffers.IByteBuffer.AddressOfPinnedMemory">
  1368. <summary>
  1369. Returns the pointer address of the buffer if the memory is pinned.
  1370. </summary>
  1371. <returns>IntPtr.Zero if not pinned.</returns>
  1372. </member>
  1373. <member name="M:DotNetty.Buffers.IByteBuffer.Duplicate">
  1374. <summary>
  1375. Creates a deep clone of the existing byte array and returns it
  1376. </summary>
  1377. </member>
  1378. <member name="M:DotNetty.Buffers.IByteBuffer.Unwrap">
  1379. <summary>
  1380. Unwraps a nested buffer
  1381. </summary>
  1382. </member>
  1383. <member name="M:DotNetty.Buffers.IByteBuffer.Copy">
  1384. <summary>
  1385. Returns a copy of this buffer's readable bytes. Modifying the content of the
  1386. returned buffer or this buffer does not affect each other at all.This method is
  1387. identical to {@code buf.copy(buf.readerIndex(), buf.readableBytes())}.
  1388. This method does not modify {@code readerIndex} or {@code writerIndex} of this buffer.
  1389. </summary>
  1390. </member>
  1391. <member name="M:DotNetty.Buffers.IByteBuffer.ForEachByte(DotNetty.Common.Utilities.IByteProcessor)">
  1392. <summary>
  1393. Iterates over the readable bytes of this buffer with the specified <c>processor</c> in ascending order.
  1394. </summary>
  1395. <returns>
  1396. <c>-1</c> if the processor iterated to or beyond the end of the readable bytes.
  1397. The last-visited index If the <see cref="M:DotNetty.Common.Utilities.IByteProcessor.Process(System.Byte)" /> returned <c>false</c>.
  1398. </returns>
  1399. <param name="processor">Processor.</param>
  1400. </member>
  1401. <member name="M:DotNetty.Buffers.IByteBuffer.ForEachByte(System.Int32,System.Int32,DotNetty.Common.Utilities.IByteProcessor)">
  1402. <summary>
  1403. Iterates over the specified area of this buffer with the specified <paramref name="processor"/> in ascending order.
  1404. (i.e. <paramref name="index"/>, <c>(index + 1)</c>, .. <c>(index + length - 1)</c>)
  1405. </summary>
  1406. <returns>
  1407. <c>-1</c> if the processor iterated to or beyond the end of the specified area.
  1408. The last-visited index If the <see cref="M:DotNetty.Common.Utilities.IByteProcessor.Process(System.Byte)"/> returned <c>false</c>.
  1409. </returns>
  1410. <param name="index">Index.</param>
  1411. <param name="length">Length.</param>
  1412. <param name="processor">Processor.</param>
  1413. </member>
  1414. <member name="M:DotNetty.Buffers.IByteBuffer.ForEachByteDesc(DotNetty.Common.Utilities.IByteProcessor)">
  1415. <summary>
  1416. Iterates over the readable bytes of this buffer with the specified <paramref name="processor"/> in descending order.
  1417. </summary>
  1418. <returns>
  1419. <c>-1</c> if the processor iterated to or beyond the beginning of the readable bytes.
  1420. The last-visited index If the <see cref="M:DotNetty.Common.Utilities.IByteProcessor.Process(System.Byte)"/> returned <c>false</c>.
  1421. </returns>
  1422. <param name="processor">Processor.</param>
  1423. </member>
  1424. <member name="M:DotNetty.Buffers.IByteBuffer.ForEachByteDesc(System.Int32,System.Int32,DotNetty.Common.Utilities.IByteProcessor)">
  1425. <summary>
  1426. Iterates over the specified area of this buffer with the specified <paramref name="processor"/> in descending order.
  1427. (i.e. <c>(index + length - 1)</c>, <c>(index + length - 2)</c>, ... <paramref name="index"/>)
  1428. </summary>
  1429. <returns>
  1430. <c>-1</c> if the processor iterated to or beyond the beginning of the specified area.
  1431. The last-visited index If the <see cref="M:DotNetty.Common.Utilities.IByteProcessor.Process(System.Byte)"/> returned <c>false</c>.
  1432. </returns>
  1433. <param name="index">Index.</param>
  1434. <param name="length">Length.</param>
  1435. <param name="processor">Processor.</param>
  1436. </member>
  1437. <member name="T:DotNetty.Buffers.IByteBufferAllocator">
  1438. <summary>
  1439. Thread-safe interface for allocating <see cref="T:DotNetty.Buffers.IByteBuffer" />/.
  1440. </summary>
  1441. </member>
  1442. <member name="P:DotNetty.Buffers.IByteBufferAllocatorMetric.UsedHeapMemory">
  1443. <summary>
  1444. Returns the number of bytes of heap memory used by a {@link ByteBufAllocator} or {@code -1} if unknown.
  1445. </summary>
  1446. </member>
  1447. <member name="P:DotNetty.Buffers.IByteBufferAllocatorMetric.UsedDirectMemory">
  1448. <summary>
  1449. Returns the number of bytes of direct memory used by a {@link ByteBufAllocator} or {@code -1} if unknown.
  1450. </summary>
  1451. </member>
  1452. <member name="P:DotNetty.Buffers.IByteBufferAllocatorMetricProvider.Metric">
  1453. <summary>
  1454. Returns a <see cref="T:DotNetty.Buffers.IByteBufferAllocatorMetric"/> for a <see cref="T:DotNetty.Buffers.IByteBufferAllocator"/>
  1455. </summary>
  1456. </member>
  1457. <member name="P:DotNetty.Buffers.IByteBufferHolder.Content">
  1458. <summary>
  1459. Return the data which is held by this {@link ByteBufHolder}.
  1460. </summary>
  1461. </member>
  1462. <member name="M:DotNetty.Buffers.IByteBufferHolder.Copy">
  1463. <summary>
  1464. Create a deep copy of this {@link ByteBufHolder}.
  1465. </summary>
  1466. </member>
  1467. <member name="M:DotNetty.Buffers.IByteBufferHolder.Duplicate">
  1468. <summary>
  1469. Duplicate the {@link ByteBufHolder}. Be aware that this will not automatically call {@link #retain()}.
  1470. </summary>
  1471. </member>
  1472. <member name="M:DotNetty.Buffers.IByteBufferHolder.RetainedDuplicate">
  1473. <summary>
  1474. Duplicates this {@link ByteBufHolder}. This method returns a retained duplicate unlike {@link #duplicate()}.
  1475. </summary>
  1476. </member>
  1477. <member name="M:DotNetty.Buffers.IByteBufferHolder.Replace(DotNetty.Buffers.IByteBuffer)">
  1478. <summary>
  1479. Returns a new {@link ByteBufHolder} which contains the specified {@code content}.
  1480. </summary>
  1481. </member>
  1482. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumThreadCaches">
  1483. Returns the number of thread caches backed by this arena.
  1484. </member>
  1485. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumTinySubpages">
  1486. Returns the number of tiny sub-pages for the arena.
  1487. </member>
  1488. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumSmallSubpages">
  1489. Returns the number of small sub-pages for the arena.
  1490. </member>
  1491. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumChunkLists">
  1492. Returns the number of chunk lists for the arena.
  1493. </member>
  1494. <member name="P:DotNetty.Buffers.IPoolArenaMetric.TinySubpages">
  1495. Returns an unmodifiable {@link List} which holds {@link PoolSubpageMetric}s for tiny sub-pages.
  1496. </member>
  1497. <member name="P:DotNetty.Buffers.IPoolArenaMetric.SmallSubpages">
  1498. Returns an unmodifiable {@link List} which holds {@link PoolSubpageMetric}s for small sub-pages.
  1499. </member>
  1500. <member name="P:DotNetty.Buffers.IPoolArenaMetric.ChunkLists">
  1501. Returns an unmodifiable {@link List} which holds {@link PoolChunkListMetric}s.
  1502. </member>
  1503. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumAllocations">
  1504. Return the number of allocations done via the arena. This includes all sizes.
  1505. </member>
  1506. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumTinyAllocations">
  1507. Return the number of tiny allocations done via the arena.
  1508. </member>
  1509. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumSmallAllocations">
  1510. Return the number of small allocations done via the arena.
  1511. </member>
  1512. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumNormalAllocations">
  1513. Return the number of normal allocations done via the arena.
  1514. </member>
  1515. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumHugeAllocations">
  1516. Return the number of huge allocations done via the arena.
  1517. </member>
  1518. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumDeallocations">
  1519. Return the number of deallocations done via the arena. This includes all sizes.
  1520. </member>
  1521. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumTinyDeallocations">
  1522. Return the number of tiny deallocations done via the arena.
  1523. </member>
  1524. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumSmallDeallocations">
  1525. Return the number of small deallocations done via the arena.
  1526. </member>
  1527. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumNormalDeallocations">
  1528. Return the number of normal deallocations done via the arena.
  1529. </member>
  1530. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumHugeDeallocations">
  1531. Return the number of huge deallocations done via the arena.
  1532. </member>
  1533. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveAllocations">
  1534. Return the number of currently active allocations.
  1535. </member>
  1536. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveTinyAllocations">
  1537. Return the number of currently active tiny allocations.
  1538. </member>
  1539. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveSmallAllocations">
  1540. Return the number of currently active small allocations.
  1541. </member>
  1542. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveNormalAllocations">
  1543. Return the number of currently active normal allocations.
  1544. </member>
  1545. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveHugeAllocations">
  1546. Return the number of currently active huge allocations.
  1547. </member>
  1548. <member name="P:DotNetty.Buffers.IPoolArenaMetric.NumActiveBytes">
  1549. Return the number of active bytes that are currently allocated by the arena.
  1550. </member>
  1551. <member name="P:DotNetty.Buffers.IPoolChunkListMetric.MinUsage">
  1552. Return the minum usage of the chunk list before which chunks are promoted to the previous list.
  1553. </member>
  1554. <member name="P:DotNetty.Buffers.IPoolChunkListMetric.MaxUsage">
  1555. Return the minum usage of the chunk list after which chunks are promoted to the next list.
  1556. </member>
  1557. <member name="P:DotNetty.Buffers.IPoolChunkMetric.Usage">
  1558. Return the percentage of the current usage of the chunk.
  1559. </member>
  1560. <member name="P:DotNetty.Buffers.IPoolChunkMetric.ChunkSize">
  1561. Return the size of the chunk in bytes, this is the maximum of bytes that can be served out of the chunk.
  1562. </member>
  1563. <member name="P:DotNetty.Buffers.IPoolChunkMetric.FreeBytes">
  1564. Return the number of free bytes in the chunk.
  1565. </member>
  1566. <member name="P:DotNetty.Buffers.IPoolSubpageMetric.MaxNumElements">
  1567. Return the number of maximal elements that can be allocated out of the sub-page.
  1568. </member>
  1569. <member name="P:DotNetty.Buffers.IPoolSubpageMetric.NumAvailable">
  1570. Return the number of available elements to be allocated.
  1571. </member>
  1572. <member name="P:DotNetty.Buffers.IPoolSubpageMetric.ElementSize">
  1573. Return the size (in bytes) of the elements that will be allocated.
  1574. </member>
  1575. <member name="P:DotNetty.Buffers.IPoolSubpageMetric.PageSize">
  1576. Return the size (in bytes) of this page.
  1577. </member>
  1578. <member name="T:DotNetty.Buffers.PoolChunk`1">
  1579. <summary>
  1580. Description of algorithm for PageRun/PoolSubpage allocation from PoolChunk
  1581. Notation: The following terms are important to understand the code
  1582. > page - a page is the smallest unit of memory chunk that can be allocated
  1583. > chunk - a chunk is a collection of pages
  1584. > in this code chunkSize = 2^{maxOrder} /// pageSize
  1585. To begin we allocate a byte array of size = chunkSize
  1586. Whenever a ByteBuf of given size needs to be created we search for the first position
  1587. in the byte array that has enough empty space to accommodate the requested size and
  1588. return a (long) handle that encodes this offset information, (this memory segment is then
  1589. marked as reserved so it is always used by exactly one ByteBuf and no more)
  1590. For simplicity all sizes are normalized according to PoolArena#normalizeCapacity method
  1591. This ensures that when we request for memory segments of size >= pageSize the normalizedCapacity
  1592. equals the next nearest power of 2
  1593. To search for the first offset in chunk that has at least requested size available we construct a
  1594. complete balanced binary tree and store it in an array (just like heaps) - memoryMap
  1595. The tree looks like this (the size of each node being mentioned in the parenthesis)
  1596. depth=0 1 node (chunkSize)
  1597. depth=1 2 nodes (chunkSize/2)
  1598. ..
  1599. ..
  1600. depth=d 2^d nodes (chunkSize/2^d)
  1601. ..
  1602. depth=maxOrder 2^maxOrder nodes (chunkSize/2^{maxOrder} = pageSize)
  1603. depth=maxOrder is the last level and the leafs consist of pages
  1604. With this tree available searching in chunkArray translates like this:
  1605. To allocate a memory segment of size chunkSize/2^k we search for the first node (from left) at height k
  1606. which is unused
  1607. Algorithm:
  1608. ----------
  1609. Encode the tree in memoryMap with the notation
  1610. memoryMap[id] = x => in the subtree rooted at id, the first node that is free to be allocated
  1611. is at depth x (counted from depth=0) i.e., at depths [depth_of_id, x), there is no node that is free
  1612. As we allocate and free nodes, we update values stored in memoryMap so that the property is maintained
  1613. Initialization -
  1614. In the beginning we construct the memoryMap array by storing the depth of a node at each node
  1615. i.e., memoryMap[id] = depth_of_id
  1616. Observations:
  1617. -------------
  1618. 1) memoryMap[id] = depth_of_id => it is free / unallocated
  1619. 2) memoryMap[id] > depth_of_id => at least one of its child nodes is allocated, so we cannot allocate it, but
  1620. some of its children can still be allocated based on their availability
  1621. 3) memoryMap[id] = maxOrder + 1 => the node is fully allocated and thus none of its children can be allocated, it
  1622. is thus marked as unusable
  1623. Algorithm: [allocateNode(d) => we want to find the first node (from left) at height h that can be allocated]
  1624. ----------
  1625. 1) start at root (i.e., depth = 0 or id = 1)
  1626. 2) if memoryMap[1] > d => cannot be allocated from this chunk
  1627. 3) if left node value &lt;= h; we can allocate from left subtree so move to left and repeat until found
  1628. 4) else try in right subtree
  1629. Algorithm: [allocateRun(size)]
  1630. ----------
  1631. 1) Compute d = log_2(chunkSize/size)
  1632. 2) Return allocateNode(d)
  1633. Algorithm: [allocateSubpage(size)]
  1634. ----------
  1635. 1) use allocateNode(maxOrder) to find an empty (i.e., unused) leaf (i.e., page)
  1636. 2) use this handle to construct the PoolSubpage object or if it already exists just call init(normCapacity)
  1637. note that this PoolSubpage object is added to subpagesPool in the PoolArena when we init() it
  1638. Note:
  1639. -----
  1640. In the implementation for improving cache coherence,
  1641. we store 2 pieces of information (i.e, 2 byte vals) as a short value in memoryMap
  1642. memoryMap[id]= (depth_of_id, x)
  1643. where as per convention defined above
  1644. the second value (i.e, x) indicates that the first node which is free to be allocated is at depth x (from root)
  1645. </summary>
  1646. </member>
  1647. <member name="F:DotNetty.Buffers.PoolChunk`1.subpageOverflowMask">
  1648. Used to determine if the requested capacity is equal to or greater than pageSize.
  1649. </member>
  1650. <member name="F:DotNetty.Buffers.PoolChunk`1.unusable">
  1651. Used to mark memory as unusable
  1652. </member>
  1653. <member name="M:DotNetty.Buffers.PoolChunk`1.#ctor(DotNetty.Buffers.PoolArena{`0},`0,System.Int32,System.Int32)">
  1654. Creates a special chunk that is not pooled.
  1655. </member>
  1656. <member name="M:DotNetty.Buffers.PoolChunk`1.UpdateParentsAlloc(System.Int32)">
  1657. Update method used by allocate
  1658. This is triggered only when a successor is allocated and all its predecessors
  1659. need to update their state
  1660. The minimal depth at which subtree rooted at id has some free space
  1661. @param id id
  1662. </member>
  1663. <member name="M:DotNetty.Buffers.PoolChunk`1.UpdateParentsFree(System.Int32)">
  1664. Update method used by free
  1665. This needs to handle the special case when both children are completely free
  1666. in which case parent be directly allocated on request of size = child-size * 2
  1667. @param id id
  1668. </member>
  1669. <member name="M:DotNetty.Buffers.PoolChunk`1.AllocateNode(System.Int32)">
  1670. Algorithm to allocate an index in memoryMap when we query for a free node
  1671. at depth d
  1672. @param d depth
  1673. @return index in memoryMap
  1674. </member>
  1675. <member name="M:DotNetty.Buffers.PoolChunk`1.AllocateRun(System.Int32)">
  1676. Allocate a run of pages (>=1)
  1677. @param normCapacity normalized capacity
  1678. @return index in memoryMap
  1679. </member>
  1680. <member name="M:DotNetty.Buffers.PoolChunk`1.AllocateSubpage(System.Int32)">
  1681. Create/ initialize a new PoolSubpage of normCapacity
  1682. Any PoolSubpage created/ initialized here is added to subpage pool in the PoolArena that owns this PoolChunk
  1683. @param normCapacity normalized capacity
  1684. @return index in memoryMap
  1685. </member>
  1686. <member name="M:DotNetty.Buffers.PoolChunk`1.Free(System.Int64)">
  1687. Free a subpage or a run of pages
  1688. When a subpage is freed from PoolSubpage, it might be added back to subpage pool of the owning PoolArena
  1689. If the subpage pool in PoolArena has at least one other PoolSubpage of given elemSize, we can
  1690. completely free the owning Page so it is available for subsequent allocations
  1691. @param handle handle to free
  1692. </member>
  1693. <member name="M:DotNetty.Buffers.PoolChunk`1.RunLength(System.Int32)">
  1694. represents the size in #bytes supported by node 'id' in the tree
  1695. </member>
  1696. <member name="M:DotNetty.Buffers.PoolChunkList`1.CalculateMaxCapacity(System.Int32,System.Int32)">
  1697. Calculates the maximum capacity of a buffer that will ever be possible to allocate out of the {@link PoolChunk}s
  1698. that belong to the {@link PoolChunkList} with the given {@code minUsage} and {@code maxUsage} settings.
  1699. </member>
  1700. <member name="M:DotNetty.Buffers.PoolChunkList`1.Move0(DotNetty.Buffers.PoolChunk{`0})">
  1701. Moves the {@link PoolChunk} down the {@link PoolChunkList} linked-list so it will end up in the right
  1702. {@link PoolChunkList} that has the correct minUsage / maxUsage in respect to {@link PoolChunk#usage()}.
  1703. </member>
  1704. <member name="M:DotNetty.Buffers.PoolChunkList`1.Add0(DotNetty.Buffers.PoolChunk{`0})">
  1705. Adds the {@link PoolChunk} to this {@link PoolChunkList}.
  1706. </member>
  1707. <member name="M:DotNetty.Buffers.PooledByteBuffer`1.Reuse(System.Int32)">
  1708. Method must be called before reuse this {@link PooledByteBufAllocator}
  1709. </member>
  1710. <member name="M:DotNetty.Buffers.PooledByteBufferAllocator.DumpStats">
  1711. Returns the status of the allocator (which contains all metrics) as string. Be aware this may be expensive
  1712. and so should not called too frequently.
  1713. </member>
  1714. <member name="M:DotNetty.Buffers.PoolSubpage`1.#ctor(System.Int32)">
  1715. Special constructor that creates a linked list head
  1716. </member>
  1717. <member name="M:DotNetty.Buffers.PoolSubpage`1.Allocate">
  1718. Returns the bitmap index of the subpage allocation.
  1719. </member>
  1720. <member name="M:DotNetty.Buffers.PoolSubpage`1.Free(DotNetty.Buffers.PoolSubpage{`0},System.Int32)">
  1721. @return {@code true} if this subpage is in use.
  1722. {@code false} if this subpage is not used by its chunk and thus it's OK to be released.
  1723. </member>
  1724. <member name="T:DotNetty.Buffers.PoolThreadCache`1">
  1725. <summary>
  1726. Acts a Thread cache for allocations. This implementation is moduled after
  1727. <a href="http://people.freebsd.org/~jasone/jemalloc/bsdcan2006/jemalloc.pdf">jemalloc</a> and the descripted
  1728. technics of
  1729. <a
  1730. href="https://www.facebook.com/notes/facebook-engineering/scalable-memory-allocation-using-jemalloc/
  1731. 480222803919">
  1732. Scalable
  1733. memory allocation using jemalloc
  1734. </a>
  1735. .
  1736. </summary>
  1737. </member>
  1738. <member name="M:DotNetty.Buffers.PoolThreadCache`1.AllocateTiny(DotNetty.Buffers.PoolArena{`0},DotNetty.Buffers.PooledByteBuffer{`0},System.Int32,System.Int32)">
  1739. Try to allocate a tiny buffer out of the cache. Returns {@code true} if successful {@code false} otherwise
  1740. </member>
  1741. <member name="M:DotNetty.Buffers.PoolThreadCache`1.AllocateSmall(DotNetty.Buffers.PoolArena{`0},DotNetty.Buffers.PooledByteBuffer{`0},System.Int32,System.Int32)">
  1742. Try to allocate a small buffer out of the cache. Returns {@code true} if successful {@code false} otherwise
  1743. </member>
  1744. <member name="M:DotNetty.Buffers.PoolThreadCache`1.AllocateNormal(DotNetty.Buffers.PoolArena{`0},DotNetty.Buffers.PooledByteBuffer{`0},System.Int32,System.Int32)">
  1745. Try to allocate a small buffer out of the cache. Returns {@code true} if successful {@code false} otherwise
  1746. </member>
  1747. <member name="M:DotNetty.Buffers.PoolThreadCache`1.Add(DotNetty.Buffers.PoolArena{`0},DotNetty.Buffers.PoolChunk{`0},System.Int64,System.Int32,DotNetty.Buffers.SizeClass)">
  1748. Add {@link PoolChunk} and {@code handle} to the cache if there is enough room.
  1749. Returns {@code true} if it fit into the cache {@code false} otherwise.
  1750. </member>
  1751. <member name="M:DotNetty.Buffers.PoolThreadCache`1.Free">
  1752. Should be called if the Thread that uses this cache is about to exist to release resources out of the cache
  1753. </member>
  1754. <member name="T:DotNetty.Buffers.PoolThreadCache`1.SubPageMemoryRegionCache">
  1755. Cache used for buffers which are backed by TINY or SMALL size.
  1756. </member>
  1757. <member name="T:DotNetty.Buffers.PoolThreadCache`1.NormalMemoryRegionCache">
  1758. Cache used for buffers which are backed by NORMAL size.
  1759. </member>
  1760. <member name="M:DotNetty.Buffers.PoolThreadCache`1.MemoryRegionCache.InitBuf(DotNetty.Buffers.PoolChunk{`0},System.Int64,DotNetty.Buffers.PooledByteBuffer{`0},System.Int32)">
  1761. Init the {@link PooledByteBuffer} using the provided chunk and handle with the capacity restrictions.
  1762. </member>
  1763. <member name="M:DotNetty.Buffers.PoolThreadCache`1.MemoryRegionCache.Add(DotNetty.Buffers.PoolChunk{`0},System.Int64)">
  1764. Add to cache if not already full.
  1765. </member>
  1766. <member name="M:DotNetty.Buffers.PoolThreadCache`1.MemoryRegionCache.Allocate(DotNetty.Buffers.PooledByteBuffer{`0},System.Int32)">
  1767. Allocate something out of the cache if possible and remove the entry from the cache.
  1768. </member>
  1769. <member name="M:DotNetty.Buffers.PoolThreadCache`1.MemoryRegionCache.Free">
  1770. Clear out this cache and free up all previous cached {@link PoolChunk}s and {@code handle}s.
  1771. </member>
  1772. <member name="M:DotNetty.Buffers.PoolThreadCache`1.MemoryRegionCache.Trim">
  1773. Free up cached {@link PoolChunk}s if not allocated frequently enough.
  1774. </member>
  1775. <member name="T:DotNetty.Buffers.Unpooled">
  1776. <summary>
  1777. Utility class for managing and creating unpooled buffers
  1778. </summary>
  1779. </member>
  1780. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(System.Byte[])">
  1781. <summary>
  1782. Creates a new big-endian buffer which wraps the specified array.
  1783. A modification on the specified array's content will be visible to the returned buffer.
  1784. </summary>
  1785. </member>
  1786. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(System.Byte[],System.Int32,System.Int32)">
  1787. <summary>
  1788. Creates a new big-endian buffer which wraps the sub-region of the
  1789. specified array. A modification on the specified array's content
  1790. will be visible to the returned buffer.
  1791. </summary>
  1792. </member>
  1793. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(DotNetty.Buffers.IByteBuffer)">
  1794. <summary>
  1795. Creates a new buffer which wraps the specified buffer's readable bytes.
  1796. A modification on the specified buffer's content will be visible to the returned buffer.
  1797. </summary>
  1798. <param name="buffer">The buffer to wrap. Reference count ownership of this variable is transfered to this method.</param>
  1799. <returns>The readable portion of the buffer, or an empty buffer if there is no readable portion.</returns>
  1800. </member>
  1801. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(System.Byte[][])">
  1802. <summary>
  1803. Creates a new big-endian composite buffer which wraps the specified arrays without copying them.
  1804. A modification on the specified arrays' content will be visible to the returned buffer.
  1805. </summary>
  1806. </member>
  1807. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(DotNetty.Buffers.IByteBuffer[])">
  1808. <summary>
  1809. Creates a new big-endian composite buffer which wraps the readable bytes of the specified buffers without copying them.
  1810. A modification on the content of the specified buffers will be visible to the returned buffer.
  1811. </summary>
  1812. <param name="buffers">The buffers to wrap. Reference count ownership of all variables is transfered to this method.</param>
  1813. <returns>The readable portion of the buffers. The caller is responsible for releasing this buffer.</returns>
  1814. </member>
  1815. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(System.Int32,System.Byte[][])">
  1816. <summary>
  1817. Creates a new big-endian composite buffer which wraps the specified arrays without copying them.
  1818. A modification on the specified arrays' content will be visible to the returned buffer.
  1819. </summary>
  1820. </member>
  1821. <member name="M:DotNetty.Buffers.Unpooled.WrappedBuffer(System.Int32,DotNetty.Buffers.IByteBuffer[])">
  1822. <summary>
  1823. Creates a new big-endian composite buffer which wraps the readable bytes of the specified buffers without copying them.
  1824. A modification on the content of the specified buffers will be visible to the returned buffer.
  1825. </summary>
  1826. <param name="maxNumComponents">Advisement as to how many independent buffers are allowed to exist before consolidation occurs.</param>
  1827. <param name="buffers">The buffers to wrap. Reference count ownership of all variables is transfered to this method.</param>
  1828. <returns>The readable portion of the buffers. The caller is responsible for releasing this buffer.</returns>
  1829. </member>
  1830. <member name="M:DotNetty.Buffers.Unpooled.CopiedBuffer(System.Byte[])">
  1831. <summary>
  1832. Creates a new big-endian buffer whose content is a copy of the specified array
  1833. The new buffer's <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  1834. are <c>0</c> and <see cref="P:System.Array.Length" /> respectively.
  1835. </summary>
  1836. <param name="array">A buffer we're going to copy.</param>
  1837. <returns>The new buffer that copies the contents of array.</returns>
  1838. </member>
  1839. <member name="M:DotNetty.Buffers.Unpooled.CopiedBuffer(System.Byte[],System.Int32,System.Int32)">
  1840. <summary>
  1841. Creates a new big-endian buffer whose content is a copy of the specified array.
  1842. The new buffer's <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  1843. are <c>0</c> and <see cref="P:System.Array.Length" /> respectively.
  1844. </summary>
  1845. <param name="array">A buffer we're going to copy.</param>
  1846. <param name="offset">The index offset from which we're going to read array.</param>
  1847. <param name="length">
  1848. The number of bytes we're going to read from array beginning from position offset.
  1849. </param>
  1850. <returns>The new buffer that copies the contents of array.</returns>
  1851. </member>
  1852. <member name="M:DotNetty.Buffers.Unpooled.CopiedBuffer(DotNetty.Buffers.IByteBuffer)">
  1853. <summary>
  1854. Creates a new big-endian buffer whose content is a copy of the specified <see cref="T:System.Array" />.
  1855. The new buffer's <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  1856. are <c>0</c> and <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> respectively.
  1857. </summary>
  1858. <param name="buffer">A buffer we're going to copy.</param>
  1859. <returns>The new buffer that copies the contents of buffer.</returns>
  1860. </member>
  1861. <member name="M:DotNetty.Buffers.Unpooled.CopiedBuffer(System.Byte[][])">
  1862. <summary>
  1863. Creates a new big-endian buffer whose content is a merged copy of of the specified arrays.
  1864. The new buffer's <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  1865. are <c>0</c> and <see cref="P:System.Array.Length" /> respectively.
  1866. </summary>
  1867. <param name="arrays"></param>
  1868. <returns></returns>
  1869. </member>
  1870. <member name="M:DotNetty.Buffers.Unpooled.CopiedBuffer(DotNetty.Buffers.IByteBuffer[])">
  1871. <summary>
  1872. Creates a new big-endian buffer whose content is a merged copy of the specified <see cref="T:System.Array" />.
  1873. The new buffer's <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" /> and <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />
  1874. are <c>0</c> and <see cref="P:DotNetty.Buffers.IByteBuffer.Capacity" /> respectively.
  1875. </summary>
  1876. <param name="buffers">Buffers we're going to copy.</param>
  1877. <returns>The new buffer that copies the contents of buffers.</returns>
  1878. </member>
  1879. <member name="M:DotNetty.Buffers.Unpooled.CopyInt(System.Int32)">
  1880. <summary>
  1881. Creates a new 4-byte big-endian buffer that holds the specified 32-bit integer.
  1882. </summary>
  1883. </member>
  1884. <member name="M:DotNetty.Buffers.Unpooled.CopyInt(System.Int32[])">
  1885. <summary>
  1886. Create a big-endian buffer that holds a sequence of the specified 32-bit integers.
  1887. </summary>
  1888. </member>
  1889. <member name="M:DotNetty.Buffers.Unpooled.CopyShort(System.Int32)">
  1890. <summary>
  1891. Creates a new 2-byte big-endian buffer that holds the specified 16-bit integer.
  1892. </summary>
  1893. </member>
  1894. <member name="M:DotNetty.Buffers.Unpooled.CopyShort(System.Int16[])">
  1895. <summary>
  1896. Create a new big-endian buffer that holds a sequence of the specified 16-bit integers.
  1897. </summary>
  1898. </member>
  1899. <member name="M:DotNetty.Buffers.Unpooled.CopyShort(System.Int32[])">
  1900. <summary>
  1901. Create a new big-endian buffer that holds a sequence of the specified 16-bit integers.
  1902. </summary>
  1903. </member>
  1904. <member name="M:DotNetty.Buffers.Unpooled.CopyMedium(System.Int32)">
  1905. <summary>
  1906. Creates a new 3-byte big-endian buffer that holds the specified 24-bit integer.
  1907. </summary>
  1908. </member>
  1909. <member name="M:DotNetty.Buffers.Unpooled.CopyMedium(System.Int32[])">
  1910. <summary>
  1911. Create a new big-endian buffer that holds a sequence of the specified 24-bit integers.
  1912. </summary>
  1913. </member>
  1914. <member name="M:DotNetty.Buffers.Unpooled.CopyLong(System.Int64)">
  1915. <summary>
  1916. Creates a new 8-byte big-endian buffer that holds the specified 64-bit integer.
  1917. </summary>
  1918. </member>
  1919. <member name="M:DotNetty.Buffers.Unpooled.CopyLong(System.Int64[])">
  1920. <summary>
  1921. Create a new big-endian buffer that holds a sequence of the specified 64-bit integers.
  1922. </summary>
  1923. </member>
  1924. <member name="M:DotNetty.Buffers.Unpooled.CopyBoolean(System.Boolean)">
  1925. <summary>
  1926. Creates a new single-byte big-endian buffer that holds the specified boolean value.
  1927. </summary>
  1928. </member>
  1929. <member name="M:DotNetty.Buffers.Unpooled.CopyBoolean(System.Boolean[])">
  1930. <summary>
  1931. Create a new big-endian buffer that holds a sequence of the specified boolean values.
  1932. </summary>
  1933. </member>
  1934. <member name="M:DotNetty.Buffers.Unpooled.CopyFloat(System.Single)">
  1935. <summary>
  1936. Creates a new 4-byte big-endian buffer that holds the specified 32-bit floating point number.
  1937. </summary>
  1938. </member>
  1939. <member name="M:DotNetty.Buffers.Unpooled.CopyFloat(System.Single[])">
  1940. <summary>
  1941. Create a new big-endian buffer that holds a sequence of the specified 32-bit floating point numbers.
  1942. </summary>
  1943. </member>
  1944. <member name="M:DotNetty.Buffers.Unpooled.CopyDouble(System.Double)">
  1945. <summary>
  1946. Creates a new 8-byte big-endian buffer that holds the specified 64-bit floating point number.
  1947. </summary>
  1948. </member>
  1949. <member name="M:DotNetty.Buffers.Unpooled.CopyDouble(System.Double[])">
  1950. <summary>
  1951. Create a new big-endian buffer that holds a sequence of the specified 64-bit floating point numbers.
  1952. </summary>
  1953. </member>
  1954. <member name="M:DotNetty.Buffers.Unpooled.UnreleasableBuffer(DotNetty.Buffers.IByteBuffer)">
  1955. <summary>
  1956. Return a unreleasable view on the given {@link ByteBuf} which will just ignore release and retain calls.
  1957. </summary>
  1958. </member>
  1959. <member name="T:DotNetty.Buffers.UnpooledByteBufferAllocator">
  1960. <summary>
  1961. Unpooled implementation of <see cref="T:DotNetty.Buffers.IByteBufferAllocator" />.
  1962. </summary>
  1963. </member>
  1964. <member name="T:DotNetty.Buffers.WrappedByteBuffer">
  1965. Wraps another <see cref="T:DotNetty.Buffers.IByteBuffer"/>.
  1966. It's important that the {@link #readerIndex()} and {@link #writerIndex()} will not do any adjustments on the
  1967. indices on the fly because of internal optimizations made by {@link ByteBufUtil#writeAscii(ByteBuf, CharSequence)}
  1968. and {@link ByteBufUtil#writeUtf8(ByteBuf, CharSequence)}.
  1969. </member>
  1970. </members>
  1971. </doc>