DotNetty.Codecs.Http.xml 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DotNetty.Codecs.Http</name>
  5. </assembly>
  6. <members>
  7. <member name="P:DotNetty.Codecs.Http.Cookies.ICookie.Wrap">
  8. <summary>
  9. Returns true if the raw value of this {@link Cookie},
  10. was wrapped with double quotes in original Set-Cookie header.
  11. </summary>
  12. </member>
  13. <member name="P:DotNetty.Codecs.Http.Cookies.ICookie.IsHttpOnly">
  14. <summary>
  15. Checks to see if this Cookie can only be accessed via HTTP.
  16. If this returns true, the Cookie cannot be accessed through
  17. client side script - But only if the browser supports it.
  18. For more information, please look "http://www.owasp.org/index.php/HTTPOnly".
  19. </summary>
  20. </member>
  21. <member name="M:DotNetty.Codecs.Http.HttpClientUpgradeHandler.IUpgradeCodec.UpgradeTo(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Codecs.Http.IFullHttpResponse)">
  22. </member>
  23. <member name="T:DotNetty.Codecs.Http.HttpHeaderNames">
  24. Standard HTTP header names.
  25. These are all defined as lowercase to support HTTP/2 requirements while also not
  26. violating HTTP/1.x requirements.New header names should always be lowercase.
  27. </member>
  28. <member name="M:DotNetty.Codecs.Http.HttpHeaders.Copy">
  29. <summary>
  30. Deep copy of the headers.
  31. </summary>
  32. <returns>A deap copy of this.</returns>
  33. </member>
  34. <member name="F:DotNetty.Codecs.Http.HttpMethod.Options">
  35. The OPTIONS method represents a request for information about the communication options
  36. available on the request/response chain identified by the Request-URI. This method allows
  37. the client to determine the options and/or requirements associated with a resource, or the
  38. capabilities of a server, without implying a resource action or initiating a resource
  39. retrieval.
  40. </member>
  41. <member name="F:DotNetty.Codecs.Http.HttpMethod.Get">
  42. The GET method means retrieve whatever information (in the form of an entity) is identified
  43. by the Request-URI. If the Request-URI refers to a data-producing process, it is the
  44. produced data which shall be returned as the entity in the response and not the source text
  45. of the process, unless that text happens to be the output of the process.
  46. </member>
  47. <member name="F:DotNetty.Codecs.Http.HttpMethod.Head">
  48. The HEAD method is identical to GET except that the server MUST NOT return a message-body
  49. in the response.
  50. </member>
  51. <member name="F:DotNetty.Codecs.Http.HttpMethod.Post">
  52. The POST method is used to request that the origin server accept the entity enclosed in the
  53. request as a new subordinate of the resource identified by the Request-URI in the
  54. Request-Line.
  55. </member>
  56. <member name="F:DotNetty.Codecs.Http.HttpMethod.Put">
  57. The PUT method requests that the enclosed entity be stored under the supplied Request-URI.
  58. </member>
  59. <member name="F:DotNetty.Codecs.Http.HttpMethod.Patch">
  60. The PATCH method requests that a set of changes described in the
  61. request entity be applied to the resource identified by the Request-URI.
  62. </member>
  63. <member name="F:DotNetty.Codecs.Http.HttpMethod.Delete">
  64. The DELETE method requests that the origin server delete the resource identified by the
  65. Request-URI.
  66. </member>
  67. <member name="F:DotNetty.Codecs.Http.HttpMethod.Trace">
  68. The TRACE method is used to invoke a remote, application-layer loop- back of the request
  69. message.
  70. </member>
  71. <member name="F:DotNetty.Codecs.Http.HttpMethod.Connect">
  72. This specification reserves the method name CONNECT for use with a proxy that can dynamically
  73. switch to being a tunnel
  74. </member>
  75. <member name="T:DotNetty.Codecs.Http.HttpResponseStatus">
  76. The response code and its description of HTTP or its derived protocols, such as
  77. <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a> and
  78. <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
  79. </member>
  80. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Continue">
  81. 100 Continue
  82. </member>
  83. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.SwitchingProtocols">
  84. 101 Switching Protocols
  85. </member>
  86. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Processing">
  87. 102 Processing (WebDAV, RFC2518)
  88. </member>
  89. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.OK">
  90. 200 OK
  91. </member>
  92. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Created">
  93. 201 Created
  94. </member>
  95. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Accepted">
  96. 202 Accepted
  97. </member>
  98. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NonAuthoritativeInformation">
  99. 203 Non-Authoritative Information (since HTTP/1.1)
  100. </member>
  101. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NoContent">
  102. 204 No Content
  103. </member>
  104. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.ResetContent">
  105. 205 Reset Content
  106. </member>
  107. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.PartialContent">
  108. 206 Partial Content
  109. </member>
  110. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.MultiStatus">
  111. 207 Multi-Status (WebDAV, RFC2518)
  112. </member>
  113. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.MultipleChoices">
  114. 300 Multiple Choices
  115. </member>
  116. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.MovedPermanently">
  117. 301 Moved Permanently
  118. </member>
  119. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Found">
  120. 302 Found
  121. </member>
  122. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.SeeOther">
  123. 303 See Other (since HTTP/1.1)
  124. </member>
  125. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NotModified">
  126. 304 Not Modified
  127. </member>
  128. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.UseProxy">
  129. 305 Use Proxy (since HTTP/1.1)
  130. </member>
  131. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.TemporaryRedirect">
  132. 307 Temporary Redirect (since HTTP/1.1)
  133. </member>
  134. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.PermanentRedirect">
  135. 308 Permanent Redirect (RFC7538)
  136. </member>
  137. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.BadRequest">
  138. 400 Bad Request
  139. </member>
  140. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Unauthorized">
  141. 401 Unauthorized
  142. </member>
  143. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.PaymentRequired">
  144. 402 Payment Required
  145. </member>
  146. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Forbidden">
  147. 403 Forbidden
  148. </member>
  149. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NotFound">
  150. 404 Not Found
  151. </member>
  152. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.MethodNotAllowed">
  153. 405 Method Not Allowed
  154. </member>
  155. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NotAcceptable">
  156. 406 Not Acceptable
  157. </member>
  158. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.ProxyAuthenticationRequired">
  159. 407 Proxy Authentication Required
  160. </member>
  161. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.RequestTimeout">
  162. 408 Request Timeout
  163. </member>
  164. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Conflict">
  165. 409 Conflict
  166. </member>
  167. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Gone">
  168. 410 Gone
  169. </member>
  170. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.LengthRequired">
  171. 411 Length Required
  172. </member>
  173. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.PreconditionFailed">
  174. 412 Precondition Failed
  175. </member>
  176. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.RequestEntityTooLarge">
  177. 413 Request Entity Too Large
  178. </member>
  179. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.RequestUriTooLong">
  180. 414 Request-URI Too Long
  181. </member>
  182. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.UnsupportedMediaType">
  183. 415 Unsupported Media Type
  184. </member>
  185. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.RequestedRangeNotSatisfiable">
  186. 416 Requested Range Not Satisfiable
  187. </member>
  188. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.ExpectationFailed">
  189. 417 Expectation Failed
  190. </member>
  191. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.MisdirectedRequest">
  192. 421 Misdirected Request
  193. <a href="https://tools.ietf.org/html/draft-ietf-httpbis-http2-15#section-9.1.2">421 Status Code</a>
  194. </member>
  195. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.UnprocessableEntity">
  196. 422 Unprocessable Entity (WebDAV, RFC4918)
  197. </member>
  198. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.Locked">
  199. 423 Locked (WebDAV, RFC4918)
  200. </member>
  201. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.FailedDependency">
  202. 424 Failed Dependency (WebDAV, RFC4918)
  203. </member>
  204. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.UnorderedCollection">
  205. 425 Unordered Collection (WebDAV, RFC3648)
  206. </member>
  207. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.UpgradeRequired">
  208. 426 Upgrade Required (RFC2817)
  209. </member>
  210. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.PreconditionRequired">
  211. 428 Precondition Required (RFC6585)
  212. </member>
  213. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.TooManyRequests">
  214. 429 Too Many Requests (RFC6585)
  215. </member>
  216. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.RequestHeaderFieldsTooLarge">
  217. 431 Request Header Fields Too Large (RFC6585)
  218. </member>
  219. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.InternalServerError">
  220. 500 Internal Server Error
  221. </member>
  222. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NotImplemented">
  223. 501 Not Implemented
  224. </member>
  225. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.BadGateway">
  226. 502 Bad Gateway
  227. </member>
  228. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.ServiceUnavailable">
  229. 503 Service Unavailable
  230. </member>
  231. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.GatewayTimeout">
  232. 504 Gateway Timeout
  233. </member>
  234. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.HttpVersionNotSupported">
  235. 505 HTTP Version Not Supported
  236. </member>
  237. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.VariantAlsoNegotiates">
  238. 506 Variant Also Negotiates (RFC2295)
  239. </member>
  240. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.InsufficientStorage">
  241. 507 Insufficient Storage (WebDAV, RFC4918)
  242. </member>
  243. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NotExtended">
  244. 510 Not Extended (RFC2774)
  245. </member>
  246. <member name="F:DotNetty.Codecs.Http.HttpResponseStatus.NetworkAuthenticationRequired">
  247. 511 Network Authentication Required (RFC6585)
  248. </member>
  249. <member name="F:DotNetty.Codecs.Http.HttpServerCodec.queue">
  250. A queue that is used for correlating a request and a response.
  251. </member>
  252. <member name="M:DotNetty.Codecs.Http.HttpServerKeepAliveHandler.IsSelfDefinedMessageLength(DotNetty.Codecs.Http.IHttpResponse)">
  253. <summary>
  254. Keep-alive only works if the client can detect when the message has ended without relying on the connection being
  255. closed.
  256. https://tools.ietf.org/html/rfc7230#section-6.3
  257. https://tools.ietf.org/html/rfc7230#section-3.3.2
  258. https://tools.ietf.org/html/rfc7230#section-3.3.3
  259. </summary>
  260. <param name="response">The HttpResponse to check</param>
  261. <returns>true if the response has a self defined message length.</returns>
  262. </member>
  263. <member name="T:DotNetty.Codecs.Http.HttpServerUpgradeHandler.ISourceCodec">
  264. <summary>
  265. The source codec that is used in the pipeline initially.
  266. </summary>
  267. </member>
  268. <member name="M:DotNetty.Codecs.Http.HttpServerUpgradeHandler.ISourceCodec.UpgradeFrom(DotNetty.Transport.Channels.IChannelHandlerContext)">
  269. <summary>
  270. Removes this codec (i.e. all associated handlers) from the pipeline.
  271. </summary>
  272. </member>
  273. <member name="T:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodec">
  274. <summary>
  275. A codec that the source can be upgraded to.
  276. </summary>
  277. </member>
  278. <member name="P:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodec.RequiredUpgradeHeaders">
  279. <summary>
  280. Gets all protocol-specific headers required by this protocol for a successful upgrade.
  281. Any supplied header will be required to appear in the {@link HttpHeaderNames#CONNECTION} header as well.
  282. </summary>
  283. </member>
  284. <member name="M:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodec.PrepareUpgradeResponse(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Codecs.Http.IFullHttpRequest,DotNetty.Codecs.Http.HttpHeaders)">
  285. <summary>
  286. Prepares the {@code upgradeHeaders} for a protocol update based upon the contents of {@code upgradeRequest}.
  287. This method returns a boolean value to proceed or abort the upgrade in progress. If {@code false} is
  288. returned, the upgrade is aborted and the {@code upgradeRequest} will be passed through the inbound pipeline
  289. as if no upgrade was performed. If {@code true} is returned, the upgrade will proceed to the next
  290. step which invokes {@link #upgradeTo}. When returning {@code true}, you can add headers to
  291. the {@code upgradeHeaders} so that they are added to the 101 Switching protocols response.
  292. </summary>
  293. </member>
  294. <member name="M:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodec.UpgradeTo(DotNetty.Transport.Channels.IChannelHandlerContext,DotNetty.Codecs.Http.IFullHttpRequest)">
  295. <summary>
  296. Performs an HTTP protocol upgrade from the source codec. This method is responsible for
  297. adding all handlers required for the new protocol.
  298. ctx the context for the current handler.
  299. upgradeRequest the request that triggered the upgrade to this protocol.
  300. </summary>
  301. </member>
  302. <member name="T:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodecFactory">
  303. <summary>
  304. Creates a new UpgradeCodec for the requested protocol name.
  305. </summary>
  306. </member>
  307. <member name="M:DotNetty.Codecs.Http.HttpServerUpgradeHandler.IUpgradeCodecFactory.NewUpgradeCodec(DotNetty.Common.Utilities.ICharSequence)">
  308. <summary>
  309. Invoked by {@link HttpServerUpgradeHandler} for all the requested protocol names in the order of
  310. the client preference.The first non-{@code null} {@link UpgradeCodec} returned by this method
  311. will be selected.
  312. </summary>
  313. </member>
  314. <member name="T:DotNetty.Codecs.Http.Multipart.IHttpDataFactory">
  315. <summary>
  316. Interface to enable creation of IPostHttpData objects
  317. </summary>
  318. </member>
  319. <member name="T:DotNetty.Codecs.Http.QueryStringEncoder">
  320. <summary>
  321. Creates an URL-encoded URI from a path string and key-value parameter pairs.
  322. This encoder is for one time use only. Create a new instance for each URI.
  323. {@link QueryStringEncoder} encoder = new {@link QueryStringEncoder}("/hello");
  324. encoder.addParam("recipient", "world");
  325. assert encoder.toString().equals("/hello?recipient=world");
  326. </summary>
  327. </member>
  328. <member name="M:DotNetty.Codecs.Http.WebSockets.CloseWebSocketFrame.StatusCode">
  329. <summary>
  330. Returns the closing status code as per http://tools.ietf.org/html/rfc6455#section-7.4 RFC 6455.
  331. If a getStatus code is set, -1 is returned.
  332. </summary>
  333. </member>
  334. <member name="M:DotNetty.Codecs.Http.WebSockets.CloseWebSocketFrame.ReasonText">
  335. <summary>
  336. Returns the reason text as per http://tools.ietf.org/html/rfc6455#section-7.4 RFC 6455
  337. If a reason text is not supplied, an empty string is returned.
  338. </summary>
  339. </member>
  340. <member name="P:DotNetty.Codecs.Http.WebSockets.Extensions.IWebSocketExtension.Rsv">
  341. <summary>
  342. The reserved bit value to ensure that no other extension should interfere.
  343. </summary>
  344. </member>
  345. <member name="T:DotNetty.Codecs.Http.WebSockets.IWebSocketFrameDecoder">
  346. <summary>
  347. Marker interface which all WebSocketFrame decoders need to implement. This makes it
  348. easier to access the added encoder later in the <see cref="T:DotNetty.Transport.Channels.IChannelPipeline"/>
  349. </summary>
  350. </member>
  351. <member name="T:DotNetty.Codecs.Http.WebSockets.IWebSocketFrameEncoder">
  352. <summary>
  353. Marker interface which all WebSocketFrame encoders need to implement. This makes it
  354. easier to access the added encoder later in the <see cref="T:DotNetty.Transport.Channels.IChannelPipeline"/>.
  355. </summary>
  356. </member>
  357. <member name="F:DotNetty.Codecs.Http.WebSockets.WebSocket08FrameEncoder.GatheringWriteThreshold">
  358. </member>
  359. <member name="T:DotNetty.Codecs.Http.WebSockets.WebSocketClientProtocolHandler.ClientHandshakeStateEvent">
  360. <summary>
  361. Events that are fired to notify about handshake status
  362. </summary>
  363. </member>
  364. <member name="F:DotNetty.Codecs.Http.WebSockets.WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HandshakeIssued">
  365. <summary>
  366. The Handshake was started but the server did not response yet to the request
  367. </summary>
  368. </member>
  369. <member name="F:DotNetty.Codecs.Http.WebSockets.WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HandshakeComplete">
  370. <summary>
  371. The Handshake was complete succesful and so the channel was upgraded to websockets
  372. </summary>
  373. </member>
  374. <member name="P:DotNetty.Codecs.Http.WebSockets.WebSocketFrame.IsFinalFragment">
  375. <summary>
  376. Flag to indicate if this frame is the final fragment in a message. The first fragment (frame)
  377. may also be the final fragment.
  378. </summary>
  379. </member>
  380. <member name="P:DotNetty.Codecs.Http.WebSockets.WebSocketFrame.Rsv">
  381. <summary>
  382. RSV1, RSV2, RSV3 used for extensions
  383. </summary>
  384. </member>
  385. </members>
  386. </doc>