DotNetty.Codecs.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DotNetty.Codecs</name>
  5. </assembly>
  6. <members>
  7. <member name="F:DotNetty.Codecs.Base64.Base64Dialect.STANDARD">
  8. <summary>
  9. http://www.faqs.org/rfcs/rfc3548.html
  10. Table 1: The Base 64 Alphabet
  11. </summary>
  12. </member>
  13. <member name="F:DotNetty.Codecs.Base64.Base64Dialect.URL_SAFE">
  14. <summary>
  15. http://www.faqs.org/rfcs/rfc3548.html
  16. Table 2: The "URL and Filename safe" Base 64 Alphabet
  17. </summary>
  18. </member>
  19. <member name="F:DotNetty.Codecs.ByteToMessageDecoder.MergeCumulator">
  20. <summary>
  21. Cumulates instances of <see cref="T:DotNetty.Buffers.IByteBuffer" /> by merging them into one <see cref="T:DotNetty.Buffers.IByteBuffer" />, using memory
  22. copies.
  23. </summary>
  24. </member>
  25. <member name="F:DotNetty.Codecs.ByteToMessageDecoder.CompositionCumulation">
  26. <summary>
  27. Cumulate instances of <see cref="T:DotNetty.Buffers.IByteBuffer" /> by add them to a <see cref="T:DotNetty.Buffers.CompositeByteBuffer" /> and therefore
  28. avoiding memory copy when possible.
  29. </summary>
  30. <remarks>
  31. Be aware that <see cref="T:DotNetty.Buffers.CompositeByteBuffer" /> use a more complex indexing implementation so depending on your
  32. use-case
  33. and the decoder implementation this may be slower then just use the <see cref="F:DotNetty.Codecs.ByteToMessageDecoder.MergeCumulator" />.
  34. </remarks>
  35. </member>
  36. <member name="P:DotNetty.Codecs.ByteToMessageDecoder.SingleDecode">
  37. <summary>
  38. Determines whether only one message should be decoded per <see cref="M:DotNetty.Codecs.ByteToMessageDecoder.ChannelRead(DotNetty.Transport.Channels.IChannelHandlerContext,System.Object)" /> call.
  39. Default is <code>false</code> as this has performance impacts.
  40. </summary>
  41. <remarks>Is particularly useful in support of protocol upgrade scenarios.</remarks>
  42. </member>
  43. <member name="P:DotNetty.Codecs.ByteToMessageDecoder.ActualReadableBytes">
  44. <summary>
  45. Returns the actual number of readable bytes in the internal cumulative
  46. buffer of this decoder. You usually do not need to rely on this value
  47. to write a decoder. Use it only when you must use it at your own risk.
  48. This method is a shortcut to <see cref="P:DotNetty.Buffers.IByteBuffer.ReadableBytes" /> of <see cref="P:DotNetty.Codecs.ByteToMessageDecoder.InternalBuffer" />.
  49. </summary>
  50. </member>
  51. <member name="T:DotNetty.Codecs.CodecException">
  52. <summary>
  53. An <see cref="T:System.Exception" /> which is thrown by a codec.
  54. </summary>
  55. </member>
  56. <member name="T:DotNetty.Codecs.Compression.Adler32">
  57. <summary>
  58. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Adler32.java
  59. </summary>
  60. </member>
  61. <member name="T:DotNetty.Codecs.Compression.CRC32">
  62. <summary>
  63. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/CRC32.java
  64. </summary>
  65. </member>
  66. <member name="T:DotNetty.Codecs.Compression.Deflate">
  67. <summary>
  68. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Deflate.java
  69. </summary>
  70. </member>
  71. <member name="T:DotNetty.Codecs.Compression.Deflater">
  72. <summary>
  73. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Deflater.java
  74. </summary>
  75. </member>
  76. <member name="T:DotNetty.Codecs.Compression.GZIPException">
  77. <summary>
  78. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/GZIPException.java
  79. </summary>
  80. </member>
  81. <member name="T:DotNetty.Codecs.Compression.GZIPHeader">
  82. <summary>
  83. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/GZIPHeader.java
  84. http://www.ietf.org/rfc/rfc1952.txt
  85. </summary>
  86. </member>
  87. <member name="T:DotNetty.Codecs.Compression.InfBlocks">
  88. <summary>
  89. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/InfBlocks.java
  90. </summary>
  91. </member>
  92. <member name="T:DotNetty.Codecs.Compression.InfCodes">
  93. <summary>
  94. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/InfCodes.java
  95. </summary>
  96. </member>
  97. <member name="T:DotNetty.Codecs.Compression.Inflate">
  98. <summary>
  99. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Inflate.java
  100. </summary>
  101. </member>
  102. <member name="T:DotNetty.Codecs.Compression.Inflater">
  103. <summary>
  104. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Inflater.java
  105. </summary>
  106. </member>
  107. <member name="T:DotNetty.Codecs.Compression.InfTree">
  108. <summary>
  109. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/InfTree.java
  110. </summary>
  111. </member>
  112. <member name="T:DotNetty.Codecs.Compression.JZlib">
  113. <summary>
  114. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/JZlib.java
  115. </summary>
  116. </member>
  117. <member name="M:DotNetty.Codecs.Compression.JZlibEncoder.#ctor(DotNetty.Codecs.Compression.ZlibWrapper,System.Int32,System.Int32,System.Int32)">
  118. Creates a new zlib encoder with the specified {@code compressionLevel},
  119. the specified {@code windowBits}, the specified {@code memLevel}, and
  120. the specified wrapper.
  121. @param compressionLevel
  122. {@code 1} yields the fastest compression and {@code 9} yields the
  123. best compression. {@code 0} means no compression. The default
  124. compression level is {@code 6}.
  125. @param windowBits
  126. The base two logarithm of the size of the history buffer. The
  127. value should be in the range {@code 9} to {@code 15} inclusive.
  128. Larger values result in better compression at the expense of
  129. memory usage. The default value is {@code 15}.
  130. @param memLevel
  131. How much memory should be allocated for the internal compression
  132. state. {@code 1} uses minimum memory and {@code 9} uses maximum
  133. memory. Larger values result in better and faster compression
  134. at the expense of memory usage. The default value is {@code 8}
  135. @throws CompressionException if failed to initialize zlib
  136. </member>
  137. <member name="T:DotNetty.Codecs.Compression.StaticTree">
  138. <summary>
  139. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/StaticTree.java
  140. </summary>
  141. </member>
  142. <member name="T:DotNetty.Codecs.Compression.Tree">
  143. <summary>
  144. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/Tree.java
  145. </summary>
  146. </member>
  147. <member name="M:DotNetty.Codecs.Compression.ZlibEncoder.CloseAsync">
  148. Close this {@link ZlibEncoder} and so finish the encoding.
  149. The returned {@link ChannelFuture} will be notified once the
  150. operation completes.
  151. </member>
  152. <member name="T:DotNetty.Codecs.Compression.ZlibWrapper">
  153. The container file formats that wrap the stream compressed by the DEFLATE
  154. algorithm.
  155. </member>
  156. <member name="F:DotNetty.Codecs.Compression.ZlibWrapper.Zlib">
  157. The ZLIB wrapper as specified in <a href="http://tools.ietf.org/html/rfc1950">RFC 1950</a>.
  158. </member>
  159. <member name="F:DotNetty.Codecs.Compression.ZlibWrapper.Gzip">
  160. The GZIP wrapper as specified in <a href="http://tools.ietf.org/html/rfc1952">RFC 1952</a>.
  161. </member>
  162. <member name="F:DotNetty.Codecs.Compression.ZlibWrapper.None">
  163. Raw DEFLATE stream only (no header and no footer).
  164. </member>
  165. <member name="F:DotNetty.Codecs.Compression.ZlibWrapper.ZlibOrNone">
  166. Try {@link #ZLIB} first and then {@link #NONE} if the first attempt fails.
  167. Please note that you can specify this wrapper type only when decompressing.
  168. </member>
  169. <member name="T:DotNetty.Codecs.Compression.ZStream">
  170. <summary>
  171. https://github.com/ymnk/jzlib/blob/master/src/main/java/com/jcraft/jzlib/ZStream.java
  172. </summary>
  173. </member>
  174. <member name="M:DotNetty.Codecs.Compression.ZStream.End">
  175. Those methods are expected to be override by Inflater and Deflater.
  176. In the future, they will become abstract methods.
  177. </member>
  178. <member name="T:DotNetty.Codecs.CorruptedFrameException">
  179. <summary>
  180. A <see cref="T:DotNetty.Codecs.DecoderException" /> which is thrown when the received frame data could not
  181. be decoded by an inbound handler.
  182. </summary>
  183. </member>
  184. <member name="T:DotNetty.Codecs.DelimiterBasedFrameDecoder">
  185. <summary>
  186. A decoder that splits the received <see cref="T:DotNetty.Buffers.IByteBuffer" /> by one or more
  187. delimiters.It is particularly useful for decoding the frames which ends
  188. with a delimiter such as <see cref="M:DotNetty.Codecs.Delimiters.NullDelimiter" /> or
  189. <see cref="M:DotNetty.Codecs.Delimiters.LineDelimiter" />
  190. <h3>Specifying more than one delimiter </h3>
  191. <see cref="M:DotNetty.Codecs.Delimiters.NullDelimiter" /> allows you to specify more than one
  192. delimiter. If more than one delimiter is found in the buffer, it chooses
  193. the delimiter which produces the shortest frame. For example, if you have
  194. the following data in the buffer:
  195. +--------------+
  196. | ABC\nDEF\r\n |
  197. +--------------+
  198. a <see cref="M:DotNetty.Codecs.Delimiters.LineDelimiter" /> will choose '\n' as the first delimiter and produce two
  199. frames:
  200. +-----+-----+
  201. | ABC | DEF |
  202. +-----+-----+
  203. rather than incorrectly choosing '\r\n' as the first delimiter:
  204. +----------+
  205. | ABC\nDEF |
  206. +----------+
  207. </summary>
  208. </member>
  209. <member name="M:DotNetty.Codecs.DelimiterBasedFrameDecoder.#ctor(System.Int32,System.Boolean,System.Boolean,DotNetty.Buffers.IByteBuffer[])">
  210. <summary>Common constructor</summary>
  211. <param name="maxFrameLength">
  212. The maximum length of the decoded frame
  213. NOTE: A see <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is thrown if the length of the frame exceeds this
  214. value.
  215. </param>
  216. <param name="stripDelimiter">whether the decoded frame should strip out the delimiter or not</param>
  217. <param name="failFast">
  218. If true, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is
  219. thrown as soon as the decoder notices the length of the
  220. frame will exceed<tt>maxFrameLength</tt> regardless of
  221. whether the entire frame has been read.
  222. If false, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is
  223. thrown after the entire frame that exceeds maxFrameLength has been read.
  224. </param>
  225. <param name="delimiters">delimiters</param>
  226. </member>
  227. <member name="M:DotNetty.Codecs.DelimiterBasedFrameDecoder.IsLineBased(DotNetty.Buffers.IByteBuffer[])">
  228. <summary>Returns true if the delimiters are "\n" and "\r\n"</summary>
  229. </member>
  230. <member name="M:DotNetty.Codecs.DelimiterBasedFrameDecoder.IsSubclass">
  231. <summary>ReturnsReturn true if the current instance is a subclass of DelimiterBasedFrameDecoder</summary>
  232. </member>
  233. <member name="M:DotNetty.Codecs.DelimiterBasedFrameDecoder.Decode(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Buffers.IByteBuffer)">
  234. <summary>Create a frame out of the <see cref="T:DotNetty.Buffers.IByteBuffer" /> and return it</summary>
  235. <param name="ctx">
  236. the <see cref="T:DotNetty.Transport.Channels.IChannelHandlerContext" /> which this
  237. <see cref="T:DotNetty.Codecs.ByteToMessageDecoder" /> belongs to
  238. </param>
  239. <param name="buffer">the <see cref="T:DotNetty.Buffers.IByteBuffer" /> from which to read data</param>
  240. <returns>
  241. the <see cref="T:DotNetty.Buffers.IByteBuffer" /> which represent the frame or null if no frame could be
  242. created.
  243. </returns>
  244. </member>
  245. <member name="M:DotNetty.Codecs.DelimiterBasedFrameDecoder.IndexOf(DotNetty.Buffers.IByteBuffer,DotNetty.Buffers.IByteBuffer)">
  246. Returns the number of bytes between the readerIndex of the haystack and
  247. the first needle found in the haystack. -1 is returned if no needle is
  248. found in the haystack.
  249. </member>
  250. <member name="M:DotNetty.Codecs.Delimiters.NullDelimiter">
  251. <summary>Returns a null (0x00) delimiter, which could be used for Flash XML socket or any similar protocols</summary>
  252. </member>
  253. <member name="M:DotNetty.Codecs.Delimiters.LineDelimiter">
  254. <summary>
  255. Returns {@code CR ('\r')} and {@code LF ('\n')} delimiters, which could
  256. be used for text-based line protocols.
  257. </summary>
  258. </member>
  259. <member name="T:DotNetty.Codecs.Json.JsonObjectDecoder">
  260. <summary>
  261. Splits a byte stream of JSON objects and arrays into individual objects/arrays and passes them up the
  262. <see cref="T:DotNetty.Transport.Channels.IChannelPipeline" />.
  263. This class does not do any real parsing or validation. A sequence of bytes is considered a JSON object/array
  264. if it contains a matching number of opening and closing braces/brackets. It's up to a subsequent
  265. <see cref="T:DotNetty.Transport.Channels.IChannelHandler" />
  266. to parse the JSON text into a more usable form i.e.a POCO.
  267. </summary>
  268. </member>
  269. <!-- Badly formed XML comment ignored for member "T:DotNetty.Codecs.LengthFieldBasedFrameDecoder" -->
  270. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.#ctor(System.Int32,System.Int32,System.Int32)">
  271. <summary>
  272. Create a new instance.
  273. </summary>
  274. <param name="maxFrameLength">
  275. The maximum length of the frame. If the length of the frame is
  276. greater than this value then <see cref="T:DotNetty.Codecs.TooLongFrameException" /> will be thrown.
  277. </param>
  278. <param name="lengthFieldOffset">The offset of the length field.</param>
  279. <param name="lengthFieldLength">The length of the length field.</param>
  280. </member>
  281. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  282. <summary>
  283. Create a new instance.
  284. </summary>
  285. <param name="maxFrameLength">
  286. The maximum length of the frame. If the length of the frame is
  287. greater than this value then <see cref="T:DotNetty.Codecs.TooLongFrameException" /> will be thrown.
  288. </param>
  289. <param name="lengthFieldOffset">The offset of the length field.</param>
  290. <param name="lengthFieldLength">The length of the length field.</param>
  291. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  292. <param name="initialBytesToStrip">the number of first bytes to strip out from the decoded frame.</param>
  293. </member>
  294. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  295. <summary>
  296. Create a new instance.
  297. </summary>
  298. <param name="maxFrameLength">
  299. The maximum length of the frame. If the length of the frame is
  300. greater than this value then <see cref="T:DotNetty.Codecs.TooLongFrameException" /> will be thrown.
  301. </param>
  302. <param name="lengthFieldOffset">The offset of the length field.</param>
  303. <param name="lengthFieldLength">The length of the length field.</param>
  304. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  305. <param name="initialBytesToStrip">the number of first bytes to strip out from the decoded frame.</param>
  306. <param name="failFast">
  307. If <c>true</c>, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is thrown as soon as the decoder notices the length
  308. of the frame will exceeed <see cref="F:DotNetty.Codecs.LengthFieldBasedFrameDecoder.maxFrameLength" /> regardless of whether the entire frame has been
  309. read. If <c>false</c>, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is thrown after the entire frame that exceeds
  310. <see cref="F:DotNetty.Codecs.LengthFieldBasedFrameDecoder.maxFrameLength" /> has been read.
  311. Defaults to <c>true</c> in other overloads.
  312. </param>
  313. </member>
  314. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.#ctor(DotNetty.Buffers.ByteOrder,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  315. <summary>
  316. Create a new instance.
  317. </summary>
  318. <param name="byteOrder">The <see cref="T:DotNetty.Buffers.ByteOrder" /> of the lenght field.</param>
  319. <param name="maxFrameLength">
  320. The maximum length of the frame. If the length of the frame is
  321. greater than this value then <see cref="T:DotNetty.Codecs.TooLongFrameException" /> will be thrown.
  322. </param>
  323. <param name="lengthFieldOffset">The offset of the length field.</param>
  324. <param name="lengthFieldLength">The length of the length field.</param>
  325. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  326. <param name="initialBytesToStrip">the number of first bytes to strip out from the decoded frame.</param>
  327. <param name="failFast">
  328. If <c>true</c>, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is thrown as soon as the decoder notices the length
  329. of the frame will exceeed <see cref="F:DotNetty.Codecs.LengthFieldBasedFrameDecoder.maxFrameLength" /> regardless of whether the entire frame has been
  330. read. If <c>false</c>, a <see cref="T:DotNetty.Codecs.TooLongFrameException" /> is thrown after the entire frame that exceeds
  331. <see cref="F:DotNetty.Codecs.LengthFieldBasedFrameDecoder.maxFrameLength" /> has been read.
  332. Defaults to <c>true</c> in other overloads.
  333. </param>
  334. </member>
  335. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.Decode(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Buffers.IByteBuffer)">
  336. <summary>
  337. Create a frame out of the <see cref="T:DotNetty.Buffers.IByteBuffer" /> and return it.
  338. </summary>
  339. <param name="context">
  340. The <see cref="T:DotNetty.Transport.Channels.IChannelHandlerContext" /> which this <see cref="T:DotNetty.Codecs.ByteToMessageDecoder" /> belongs
  341. to.
  342. </param>
  343. <param name="input">The <see cref="T:DotNetty.Buffers.IByteBuffer" /> from which to read data.</param>
  344. <returns>The <see cref="T:DotNetty.Buffers.IByteBuffer" /> which represents the frame or <c>null</c> if no frame could be created.</returns>
  345. </member>
  346. <member name="M:DotNetty.Codecs.LengthFieldBasedFrameDecoder.GetUnadjustedFrameLength(DotNetty.Buffers.IByteBuffer,System.Int32,System.Int32,DotNetty.Buffers.ByteOrder)">
  347. <summary>
  348. Decodes the specified region of the buffer into an unadjusted frame length. The default implementation is
  349. capable of decoding the specified region into an unsigned 8/16/24/32/64 bit integer. Override this method to
  350. decode the length field encoded differently.
  351. Note that this method must not modify the state of the specified buffer (e.g.
  352. <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />,
  353. <see cref="P:DotNetty.Buffers.IByteBuffer.WriterIndex" />, and the content of the buffer.)
  354. </summary>
  355. <param name="buffer">The buffer we'll be extracting the frame length from.</param>
  356. <param name="offset">The offset from the absolute <see cref="P:DotNetty.Buffers.IByteBuffer.ReaderIndex" />.</param>
  357. <param name="length">The length of the framelenght field. Expected: 1, 2, 3, 4, or 8.</param>
  358. <param name="order">The preferred <see cref="T:DotNetty.Buffers.ByteOrder" /> of buffer.</param>
  359. <returns>A long integer that represents the unadjusted length of the next frame.</returns>
  360. </member>
  361. <member name="T:DotNetty.Codecs.LengthFieldPrepender">
  362. <summary>
  363. An encoder that prepends the length of the message. The length value is
  364. prepended as a binary form.
  365. <p />
  366. For example, <tt>{@link LengthFieldPrepender}(2)</tt> will encode the
  367. following 12-bytes string:
  368. <pre>
  369. +----------------+
  370. | "HELLO, WORLD" |
  371. +----------------+
  372. </pre>
  373. into the following:
  374. <pre>
  375. +--------+----------------+
  376. + 0x000C | "HELLO, WORLD" |
  377. +--------+----------------+
  378. </pre>
  379. If you turned on the {@code lengthIncludesLengthFieldLength} flag in the
  380. constructor, the encoded data would look like the following
  381. (12 (original data) + 2 (prepended data) = 14 (0xE)):
  382. <pre>
  383. +--------+----------------+
  384. + 0x000E | "HELLO, WORLD" |
  385. +--------+----------------+
  386. </pre>
  387. </summary>
  388. </member>
  389. <member name="M:DotNetty.Codecs.LengthFieldPrepender.#ctor(System.Int32)">
  390. <summary>
  391. Creates a new <see cref="T:DotNetty.Codecs.LengthFieldPrepender" /> instance.
  392. </summary>
  393. <param name="lengthFieldLength">
  394. The length of the prepended length field.
  395. Only 1, 2, 3, 4, and 8 are allowed.
  396. </param>
  397. </member>
  398. <member name="M:DotNetty.Codecs.LengthFieldPrepender.#ctor(System.Int32,System.Boolean)">
  399. <summary>
  400. Creates a new <see cref="T:DotNetty.Codecs.LengthFieldPrepender" /> instance.
  401. </summary>
  402. <param name="lengthFieldLength">
  403. The length of the prepended length field.
  404. Only 1, 2, 3, 4, and 8 are allowed.
  405. </param>
  406. <param name="lengthFieldIncludesLengthFieldLength">
  407. If <c>true</c>, the length of the prepended length field is added
  408. to the value of the prepended length field.
  409. </param>
  410. </member>
  411. <member name="M:DotNetty.Codecs.LengthFieldPrepender.#ctor(System.Int32,System.Int32)">
  412. <summary>
  413. Creates a new <see cref="T:DotNetty.Codecs.LengthFieldPrepender" /> instance.
  414. </summary>
  415. <param name="lengthFieldLength">
  416. The length of the prepended length field.
  417. Only 1, 2, 3, 4, and 8 are allowed.
  418. </param>
  419. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  420. </member>
  421. <member name="M:DotNetty.Codecs.LengthFieldPrepender.#ctor(System.Int32,System.Int32,System.Boolean)">
  422. <summary>
  423. Creates a new <see cref="T:DotNetty.Codecs.LengthFieldPrepender" /> instance.
  424. </summary>
  425. <param name="lengthFieldLength">
  426. The length of the prepended length field.
  427. Only 1, 2, 3, 4, and 8 are allowed.
  428. </param>
  429. <param name="lengthFieldIncludesLengthFieldLength">
  430. If <c>true</c>, the length of the prepended length field is added
  431. to the value of the prepended length field.
  432. </param>
  433. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  434. </member>
  435. <member name="M:DotNetty.Codecs.LengthFieldPrepender.#ctor(DotNetty.Buffers.ByteOrder,System.Int32,System.Int32,System.Boolean)">
  436. <summary>
  437. Creates a new <see cref="T:DotNetty.Codecs.LengthFieldPrepender" /> instance.
  438. </summary>
  439. <param name="byteOrder">The <see cref="T:DotNetty.Buffers.ByteOrder" /> of the length field.</param>
  440. <param name="lengthFieldLength">
  441. The length of the prepended length field.
  442. Only 1, 2, 3, 4, and 8 are allowed.
  443. </param>
  444. <param name="lengthFieldIncludesLengthFieldLength">
  445. If <c>true</c>, the length of the prepended length field is added
  446. to the value of the prepended length field.
  447. </param>
  448. <param name="lengthAdjustment">The compensation value to add to the value of the length field.</param>
  449. </member>
  450. <member name="T:DotNetty.Codecs.LineBasedFrameDecoder">
  451. <summary>
  452. A decoder that splits the received {@link ByteBuf}s on line endings.
  453. Both {@code "\n"} and {@code "\r\n"} are handled.
  454. For a more general delimiter-based decoder, see {@link DelimiterBasedFrameDecoder}.
  455. </summary>
  456. </member>
  457. <member name="F:DotNetty.Codecs.LineBasedFrameDecoder.maxLength">
  458. Maximum length of a frame we're willing to decode.
  459. </member>
  460. <member name="F:DotNetty.Codecs.LineBasedFrameDecoder.failFast">
  461. Whether or not to throw an exception as soon as we exceed maxLength.
  462. </member>
  463. <member name="F:DotNetty.Codecs.LineBasedFrameDecoder.discarding">
  464. True if we're discarding input because we're already over maxLength.
  465. </member>
  466. <member name="M:DotNetty.Codecs.LineBasedFrameDecoder.#ctor(System.Int32)">
  467. <summary>
  468. Initializes a new instance of the <see cref="T:DotNetty.Codecs.LineBasedFrameDecoder" /> class.
  469. </summary>
  470. <param name="maxLength">
  471. the maximum length of the decoded frame.
  472. A {@link TooLongFrameException} is thrown if
  473. the length of the frame exceeds this value.
  474. </param>
  475. </member>
  476. <member name="M:DotNetty.Codecs.LineBasedFrameDecoder.#ctor(System.Int32,System.Boolean,System.Boolean)">
  477. <summary>
  478. Initializes a new instance of the <see cref="T:DotNetty.Codecs.LineBasedFrameDecoder" /> class.
  479. </summary>
  480. <param name="maxLength">
  481. the maximum length of the decoded frame.
  482. A {@link TooLongFrameException} is thrown if
  483. the length of the frame exceeds this value.
  484. </param>
  485. <param name="stripDelimiter">
  486. whether the decoded frame should strip out the
  487. delimiter or not
  488. </param>
  489. <param name="failFast">
  490. If <tt>true</tt>, a {@link TooLongFrameException} is
  491. thrown as soon as the decoder notices the length of the
  492. frame will exceed <tt>maxFrameLength</tt> regardless of
  493. whether the entire frame has been read.
  494. If <tt>false</tt>, a {@link TooLongFrameException} is
  495. thrown after the entire frame that exceeds
  496. <tt>maxFrameLength</tt> has been read.
  497. </param>
  498. </member>
  499. <member name="M:DotNetty.Codecs.LineBasedFrameDecoder.Decode(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Buffers.IByteBuffer)">
  500. <summary>
  501. Create a frame out of the {@link ByteBuf} and return it.
  502. </summary>
  503. <param name="ctx">the {@link ChannelHandlerContext} which this {@link ByteToMessageDecoder} belongs to</param>
  504. <param name="buffer">the {@link ByteBuf} from which to read data</param>
  505. </member>
  506. <member name="T:DotNetty.Codecs.MessageAggregator`4">
  507. <inheritdoc />
  508. <summary>
  509. An abstract <see cref="T:DotNetty.Transport.Channels.IChannelHandler" /> that aggregates a series of message objects
  510. into a single aggregated message.
  511. 'A series of messages' is composed of the following:
  512. a single start message which optionally contains the first part of the content, and
  513. 1 or more content messages. The content of the aggregated message will be the merged
  514. content of the start message and its following content messages. If this aggregator
  515. encounters a content message where { @link #isLastContentMessage(ByteBufHolder)}
  516. return true for, the aggregator will finish the aggregation and produce the aggregated
  517. message and expect another start message.
  518. </summary>
  519. <typeparam name="TMessage">The type that covers both start message and content message</typeparam>
  520. <typeparam name="TStart">The type of the start message</typeparam>
  521. <typeparam name="TContent">The type of the content message</typeparam>
  522. <typeparam name="TOutput">The type of the aggregated message</typeparam>
  523. </member>
  524. <member name="T:DotNetty.Codecs.MessageToMessageDecoder`1">
  525. <summary>
  526. Message to message decoder.
  527. </summary>
  528. </member>
  529. <member name="M:DotNetty.Codecs.MessageToMessageDecoder`1.Decode(DotNetty.Transport.Channels.IChannelHandlerContext,`0,System.Collections.Generic.List{System.Object})">
  530. <summary>
  531. Decode from one message to an other. This method will be called for each written message that can be handled
  532. by this encoder.
  533. </summary>
  534. <param name="context">the {@link ChannelHandlerContext} which this {@link MessageToMessageDecoder} belongs to</param>
  535. <param name="message">the message to decode to an other one</param>
  536. <param name="output">the {@link List} to which decoded messages should be added</param>
  537. </member>
  538. <member name="M:DotNetty.Codecs.MessageToMessageEncoder`1.AcceptOutboundMessage(System.Object)">
  539. <summary>
  540. Returns {@code true} if the given message should be handled. If {@code false} it will be passed to the next
  541. {@link ChannelHandler} in the {@link ChannelPipeline}.
  542. </summary>
  543. </member>
  544. <member name="M:DotNetty.Codecs.MessageToMessageEncoder`1.Encode(DotNetty.Transport.Channels.IChannelHandlerContext,`0,System.Collections.Generic.List{System.Object})">
  545. <summary>
  546. Encode from one message to an other. This method will be called for each written message that can be handled
  547. by this encoder.
  548. @param context the {@link ChannelHandlerContext} which this {@link MessageToMessageEncoder} belongs to
  549. @param message the message to encode to an other one
  550. @param output the {@link List} into which the encoded message should be added
  551. needs to do some kind of aggragation
  552. @throws Exception is thrown if an error accour
  553. </summary>
  554. </member>
  555. <member name="T:DotNetty.Codecs.Protobuf.ProtobufVarint32FrameDecoder">
  556. A decoder that splits the received {@link ByteBuf}s dynamically by the
  557. value of the Google Protocol Buffers
  558. http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
  559. Base 128 Varints integer length field in the message.
  560. For example:
  561. BEFORE DECODE (302 bytes) AFTER DECODE (300 bytes)
  562. +--------+---------------+ +---------------+
  563. | Length | Protobuf Data |----->| Protobuf Data |
  564. | 0xAC02 | (300 bytes) | | (300 bytes) |
  565. +--------+---------------+ +---------------+
  566. </member>
  567. <member name="T:DotNetty.Codecs.Protobuf.ProtobufVarint32LengthFieldPrepender">
  568. An encoder that prepends the the Google Protocol Buffers
  569. http://code.google.com/apis/protocolbuffers/docs/encoding.html#varints
  570. Base 128 Varints integer length field.
  571. For example:
  572. BEFORE ENCODE (300 bytes) AFTER ENCODE (302 bytes)
  573. +---------------+ +--------+---------------+
  574. | Protobuf Data |-------------->| Length | Protobuf Data |
  575. | (300 bytes) | | 0xAC02 | (300 bytes) |
  576. +---------------+ +--------+---------------+
  577. </member>
  578. <member name="M:DotNetty.Codecs.StringDecoder.#ctor">
  579. <summary>
  580. Initializes a new instance of the <see cref="T:DotNetty.Codecs.StringDecoder" /> class with the current system
  581. character set.
  582. </summary>
  583. </member>
  584. <member name="M:DotNetty.Codecs.StringDecoder.#ctor(System.Text.Encoding)">
  585. <summary>
  586. Initializes a new instance of the <see cref="T:DotNetty.Codecs.StringDecoder" /> class with the specified character
  587. set..
  588. </summary>
  589. <param name="encoding">Encoding.</param>
  590. </member>
  591. <member name="T:DotNetty.Codecs.StringEncoder">
  592. Encodes the requested {@link String} into a {@link ByteBuf}.
  593. A typical setup for a text-based line protocol in a TCP/IP socket would be:
  594. <pre>
  595. {@link ChannelPipeline} pipeline = ...;
  596. // Decoders
  597. pipeline.addLast("frameDecoder", new {@link LineBasedFrameDecoder}(80));
  598. pipeline.addLast("stringDecoder", new {@link StringDecoder}(CharsetUtil.UTF_8));
  599. // Encoder
  600. pipeline.addLast("stringEncoder", new {@link StringEncoder}(CharsetUtil.UTF_8));
  601. </pre>
  602. and then you can use a {@link String} instead of a {@link ByteBuf}
  603. as a message:
  604. <pre>
  605. void channelRead({@link ChannelHandlerContext} ctx, {@link String} msg) {
  606. ch.write("Did you say '" + msg + "'?\n");
  607. }
  608. </pre>
  609. </member>
  610. <member name="M:DotNetty.Codecs.StringEncoder.#ctor">
  611. <summary>
  612. Initializes a new instance of the <see cref="T:DotNetty.Codecs.StringEncoder" /> class with the current system
  613. character set.
  614. </summary>
  615. </member>
  616. <member name="M:DotNetty.Codecs.StringEncoder.#ctor(System.Text.Encoding)">
  617. <summary>
  618. Initializes a new instance of the <see cref="T:DotNetty.Codecs.StringEncoder" /> class with the specified character
  619. set..
  620. </summary>
  621. <param name="encoding">Encoding.</param>
  622. </member>
  623. <member name="T:DotNetty.Codecs.TooLongFrameException">
  624. <summary>
  625. A <see cref="T:DotNetty.Codecs.DecoderException" /> which is thrown when the length of the frame
  626. decoded is greater than the allowed maximum.
  627. </summary>
  628. </member>
  629. <member name="T:DotNetty.Codecs.UnsupportedMessageTypeException">
  630. <summary>
  631. Thrown if an unsupported message is received by an codec.
  632. </summary>
  633. </member>
  634. </members>
  635. </doc>