SuperSocket.Facility.XML 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperSocket.Facility</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperSocket.Facility.PolicyServer.FlashPolicyServer">
  8. <summary>
  9. Flash policy AppServer
  10. </summary>
  11. </member>
  12. <member name="M:SuperSocket.Facility.PolicyServer.FlashPolicyServer.#ctor">
  13. <summary>
  14. Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.FlashPolicyServer"/> class.
  15. </summary>
  16. </member>
  17. <member name="M:SuperSocket.Facility.PolicyServer.FlashPolicyServer.SetupPolicyResponse(System.Byte[])">
  18. <summary>
  19. Setups the policy response.
  20. </summary>
  21. <param name="policyFileData">The policy file data.</param>
  22. <returns></returns>
  23. </member>
  24. <member name="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter">
  25. <summary>
  26. PolicyReceiveFilter
  27. </summary>
  28. </member>
  29. <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter.#ctor(System.Int32)">
  30. <summary>
  31. Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter"/> class.
  32. </summary>
  33. <param name="size">The size.</param>
  34. </member>
  35. <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  36. <summary>
  37. Filters the buffer after the server receive the enough size of data.
  38. </summary>
  39. <param name="buffer">The buffer.</param>
  40. <param name="offset">The offset.</param>
  41. <param name="length">The length.</param>
  42. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  43. <returns></returns>
  44. </member>
  45. <member name="P:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.FixRequestSize">
  46. <summary>
  47. Gets the size of the fix request.
  48. </summary>
  49. <value>
  50. The size of the fix request.
  51. </value>
  52. </member>
  53. <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.#ctor(System.Int32)">
  54. <summary>
  55. Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory"/> class.
  56. </summary>
  57. <param name="fixRequestSize">Size of the fix request.</param>
  58. </member>
  59. <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  60. <summary>
  61. Creates the filter.
  62. </summary>
  63. <param name="appServer">The app server.</param>
  64. <param name="appSession">The app session.</param>
  65. <param name="remoteEndPoint">The remote end point.</param>
  66. <returns></returns>
  67. </member>
  68. <member name="T:SuperSocket.Facility.PolicyServer.PolicyServer">
  69. <summary>
  70. PolicyServer base class
  71. </summary>
  72. </member>
  73. <member name="P:SuperSocket.Facility.PolicyServer.PolicyServer.PolicyResponse">
  74. <summary>
  75. Gets the policy response.
  76. </summary>
  77. </member>
  78. <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.#ctor">
  79. <summary>
  80. Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyServer"/> class.
  81. </summary>
  82. </member>
  83. <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)">
  84. <summary>
  85. Setups the specified root config.
  86. </summary>
  87. <param name="rootConfig">The root config.</param>
  88. <param name="config">The config.</param>
  89. <returns></returns>
  90. </member>
  91. <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.SetupPolicyResponse(System.Byte[])">
  92. <summary>
  93. Setups the policy response.
  94. </summary>
  95. <param name="policyFileData">The policy file data.</param>
  96. <returns></returns>
  97. </member>
  98. <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.GetPolicyFileResponse(System.Net.IPEndPoint)">
  99. <summary>
  100. Gets the policy file response.
  101. </summary>
  102. <param name="clientEndPoint">The client end point.</param>
  103. <returns></returns>
  104. </member>
  105. <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.ProcessRequest(SuperSocket.Facility.PolicyServer.PolicySession,System.Byte[])">
  106. <summary>
  107. Processes the request.
  108. </summary>
  109. <param name="session">The session.</param>
  110. <param name="data">The data.</param>
  111. </member>
  112. <member name="T:SuperSocket.Facility.PolicyServer.PolicySession">
  113. <summary>
  114. PolicySession
  115. </summary>
  116. </member>
  117. <member name="T:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer">
  118. <summary>
  119. Silverlight policy AppServer
  120. </summary>
  121. </member>
  122. <member name="M:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer.#ctor">
  123. <summary>
  124. Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer"/> class.
  125. </summary>
  126. </member>
  127. <member name="M:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer.ProcessRequest(SuperSocket.Facility.PolicyServer.PolicySession,System.Byte[])">
  128. <summary>
  129. Processes the request.
  130. </summary>
  131. <param name="session">The session.</param>
  132. <param name="data">The data.</param>
  133. </member>
  134. <member name="T:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1">
  135. <summary>
  136. ReceiveFilter for the protocol that each request has bengin and end mark
  137. </summary>
  138. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  139. </member>
  140. <member name="F:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.NullRequestInfo">
  141. <summary>
  142. Null request info
  143. </summary>
  144. </member>
  145. <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.#ctor(System.Byte[],System.Byte[])">
  146. <summary>
  147. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1"/> class.
  148. </summary>
  149. <param name="beginMark">The begin mark.</param>
  150. <param name="endMark">The end mark.</param>
  151. </member>
  152. <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  153. <summary>
  154. Filters the specified session.
  155. </summary>
  156. <param name="readBuffer">The read buffer.</param>
  157. <param name="offset">The offset.</param>
  158. <param name="length">The length.</param>
  159. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  160. <param name="rest">The rest.</param>
  161. <returns></returns>
  162. </member>
  163. <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  164. <summary>
  165. Processes the matched request.
  166. </summary>
  167. <param name="readBuffer">The read buffer.</param>
  168. <param name="offset">The offset.</param>
  169. <param name="length">The length.</param>
  170. <returns></returns>
  171. </member>
  172. <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.Reset">
  173. <summary>
  174. Resets this instance.
  175. </summary>
  176. </member>
  177. <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1">
  178. <summary>
  179. This Receive filter is designed for this kind protocol:
  180. each request has fixed count part which splited by a char(byte)
  181. for instance, request is defined like this "#12122#23343#4545456565#343435446#",
  182. because this request is splited into many parts by 5 '#', we can create a Receive filter by CountSpliterRequestFilter((byte)'#', 5)
  183. </summary>
  184. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  185. </member>
  186. <member name="F:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.NullRequestInfo">
  187. <summary>
  188. Null request info instance
  189. </summary>
  190. </member>
  191. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.#ctor(System.Byte,System.Int32)">
  192. <summary>
  193. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1"/> class.
  194. </summary>
  195. <param name="spliter">The spliter.</param>
  196. <param name="spliterCount">The spliter count.</param>
  197. </member>
  198. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  199. <summary>
  200. Filters the specified session.
  201. </summary>
  202. <param name="readBuffer">The read buffer.</param>
  203. <param name="offset">The offset.</param>
  204. <param name="length">The length.</param>
  205. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  206. <param name="rest">The rest.</param>
  207. <returns></returns>
  208. </member>
  209. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  210. <summary>
  211. Processes the matched request.
  212. </summary>
  213. <param name="readBuffer">The read buffer.</param>
  214. <param name="offset">The offset.</param>
  215. <param name="length">The length.</param>
  216. <returns></returns>
  217. </member>
  218. <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.LeftBufferSize">
  219. <summary>
  220. Gets the size of the rest buffer.
  221. </summary>
  222. <value>
  223. The size of the rest buffer.
  224. </value>
  225. </member>
  226. <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.NextReceiveFilter">
  227. <summary>
  228. Gets the next Receive filter.
  229. </summary>
  230. </member>
  231. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.Reset">
  232. <summary>
  233. Resets this instance.
  234. </summary>
  235. </member>
  236. <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.OffsetDelta">
  237. <summary>
  238. Gets the offset delta relative original receiving offset which will be used for next round receiving.
  239. </summary>
  240. </member>
  241. <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.State">
  242. <summary>
  243. Gets the filter state.
  244. </summary>
  245. <value>
  246. The filter state.
  247. </value>
  248. </member>
  249. <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter">
  250. <summary>
  251. This Receive filter is designed for this kind protocol:
  252. each request has fixed count part which splited by a char(byte)
  253. for instance, request is defined like this "#12122#23343#4545456565#343435446#",
  254. because this request is splited into many parts by 5 '#', we can create a Receive filter by CountSpliterRequestFilter((byte)'#', 5)
  255. </summary>
  256. </member>
  257. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32)">
  258. <summary>
  259. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class.
  260. </summary>
  261. <param name="spliter">The spliter.</param>
  262. <param name="spliterCount">The spliter count.</param>
  263. </member>
  264. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32,System.Text.Encoding)">
  265. <summary>
  266. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class.
  267. </summary>
  268. <param name="spliter">The spliter.</param>
  269. <param name="spliterCount">The spliter count.</param>
  270. <param name="encoding">The encoding.</param>
  271. </member>
  272. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32,System.Text.Encoding,System.Int32)">
  273. <summary>
  274. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class.
  275. </summary>
  276. <param name="spliter">The spliter.</param>
  277. <param name="spliterCount">The spliter count.</param>
  278. <param name="encoding">The encoding.</param>
  279. <param name="keyIndex">Index of the key.</param>
  280. </member>
  281. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  282. <summary>
  283. Processes the matched request.
  284. </summary>
  285. <param name="readBuffer">The read buffer.</param>
  286. <param name="offset">The offset.</param>
  287. <param name="length">The length.</param>
  288. <returns></returns>
  289. </member>
  290. <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`2">
  291. <summary>
  292. ReceiveFilterFactory for CountSpliterReceiveFilter
  293. </summary>
  294. <typeparam name="TRequestFilter">The type of the Receive filter.</typeparam>
  295. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  296. </member>
  297. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`2.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  298. <summary>
  299. Creates the filter.
  300. </summary>
  301. <param name="appServer">The app server.</param>
  302. <param name="appSession">The app session.</param>
  303. <param name="remoteEndPoint">The remote end point.</param>
  304. <returns></returns>
  305. </member>
  306. <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`1">
  307. <summary>
  308. ReceiveFilterFactory for CountSpliterReceiveFilter
  309. </summary>
  310. <typeparam name="TRequestFilter">The type of the Receive filter.</typeparam>
  311. </member>
  312. <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory">
  313. <summary>
  314. receiveFilterFactory for CountSpliterRequestFilter
  315. </summary>
  316. </member>
  317. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory.#ctor(System.Byte,System.Int32)">
  318. <summary>
  319. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory"/> class.
  320. </summary>
  321. <param name="spliter">The spliter.</param>
  322. <param name="count">The count.</param>
  323. </member>
  324. <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  325. <summary>
  326. Creates the filter.
  327. </summary>
  328. <param name="appServer">The app server.</param>
  329. <param name="appSession">The app session.</param>
  330. <param name="remoteEndPoint">The remote end point.</param>
  331. <returns></returns>
  332. </member>
  333. <member name="T:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1">
  334. <summary>
  335. FixedHeaderReceiveFilter,
  336. it is the Receive filter base for the protocol which define fixed length header and the header contains the request body length,
  337. you can implement your own Receive filter for this kind protocol easily by inheriting this class
  338. </summary>
  339. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  340. </member>
  341. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.#ctor(System.Int32)">
  342. <summary>
  343. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1"/> class.
  344. </summary>
  345. <param name="headerSize">Size of the header.</param>
  346. </member>
  347. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  348. <summary>
  349. Filters the specified session.
  350. </summary>
  351. <param name="readBuffer">The read buffer.</param>
  352. <param name="offset">The offset.</param>
  353. <param name="length">The length.</param>
  354. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  355. <param name="rest">The rest.</param>
  356. <returns></returns>
  357. </member>
  358. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  359. <summary>
  360. Processes the fix size request.
  361. </summary>
  362. <param name="buffer">The buffer.</param>
  363. <param name="offset">The offset.</param>
  364. <param name="length">The length.</param>
  365. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  366. <returns></returns>
  367. </member>
  368. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.GetBodyLengthFromHeader(System.Byte[],System.Int32,System.Int32)">
  369. <summary>
  370. Gets the body length from header.
  371. </summary>
  372. <param name="header">The header.</param>
  373. <param name="offset">The offset.</param>
  374. <param name="length">The length.</param>
  375. <returns></returns>
  376. </member>
  377. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.ResolveRequestInfo(System.ArraySegment{System.Byte},System.Byte[],System.Int32,System.Int32)">
  378. <summary>
  379. Resolves the request data.
  380. </summary>
  381. <param name="header">The header.</param>
  382. <param name="bodyBuffer">The body buffer.</param>
  383. <param name="offset">The offset.</param>
  384. <param name="length">The length.</param>
  385. <returns></returns>
  386. </member>
  387. <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.Reset">
  388. <summary>
  389. Resets this instance.
  390. </summary>
  391. </member>
  392. <member name="T:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1">
  393. <summary>
  394. FixedSizeReceiveFilter
  395. </summary>
  396. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  397. </member>
  398. <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Size">
  399. <summary>
  400. Gets the size of the fixed size Receive filter.
  401. </summary>
  402. </member>
  403. <member name="F:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.NullRequestInfo">
  404. <summary>
  405. Null RequestInfo
  406. </summary>
  407. </member>
  408. <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.#ctor(System.Int32)">
  409. <summary>
  410. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1"/> class.
  411. </summary>
  412. <param name="size">The size.</param>
  413. </member>
  414. <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  415. <summary>
  416. Filters the specified session.
  417. </summary>
  418. <param name="readBuffer">The read buffer.</param>
  419. <param name="offset">The offset.</param>
  420. <param name="length">The length.</param>
  421. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  422. <param name="rest">The rest.</param>
  423. <returns></returns>
  424. </member>
  425. <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  426. <summary>
  427. Filters the buffer after the server receive the enough size of data.
  428. </summary>
  429. <param name="buffer">The buffer.</param>
  430. <param name="offset">The offset.</param>
  431. <param name="length">The length.</param>
  432. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  433. <returns></returns>
  434. </member>
  435. <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.LeftBufferSize">
  436. <summary>
  437. Gets the size of the rest buffer.
  438. </summary>
  439. <value>
  440. The size of the rest buffer.
  441. </value>
  442. </member>
  443. <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.NextReceiveFilter">
  444. <summary>
  445. Gets the next Receive filter.
  446. </summary>
  447. </member>
  448. <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.SuperSocket#SocketBase#Protocol#IOffsetAdapter#OffsetDelta">
  449. <summary>
  450. Gets the offset delta.
  451. </summary>
  452. </member>
  453. <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.State">
  454. <summary>
  455. Gets the filter state.
  456. </summary>
  457. <value>
  458. The filter state.
  459. </value>
  460. </member>
  461. <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Reset">
  462. <summary>
  463. Resets this instance.
  464. </summary>
  465. </member>
  466. <member name="T:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1">
  467. <summary>
  468. HttpReceiveFilterBase
  469. </summary>
  470. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  471. </member>
  472. <member name="F:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.NewLine">
  473. <summary>
  474. Http header terminator
  475. </summary>
  476. </member>
  477. <member name="F:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.m_HeaderParsed">
  478. <summary>
  479. indicate whether the header has been parsed
  480. </summary>
  481. </member>
  482. <member name="P:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.HeaderItems">
  483. <summary>
  484. Gets the header items.
  485. </summary>
  486. </member>
  487. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.#ctor">
  488. <summary>
  489. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1"/> class.
  490. </summary>
  491. </member>
  492. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  493. <summary>
  494. Filters the specified session.
  495. </summary>
  496. <param name="readBuffer">The read buffer.</param>
  497. <param name="offset">The offset.</param>
  498. <param name="length">The length.</param>
  499. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  500. <param name="rest">The rest.</param>
  501. <returns></returns>
  502. </member>
  503. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.FilterRequestBody(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
  504. <summary>
  505. Filters the request body.
  506. </summary>
  507. <param name="readBuffer">The read buffer.</param>
  508. <param name="offset">The offset.</param>
  509. <param name="length">The length.</param>
  510. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  511. <param name="rest">The rest data size.</param>
  512. <returns></returns>
  513. </member>
  514. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)">
  515. <summary>
  516. Resolves the specified data.
  517. </summary>
  518. <param name="data">The data.</param>
  519. <param name="offset">The offset.</param>
  520. <param name="length">The length.</param>
  521. <returns></returns>
  522. </member>
  523. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.FilterRequestHeader(System.Collections.Specialized.NameValueCollection)">
  524. <summary>
  525. Filters the request header.
  526. </summary>
  527. <param name="header">The header.</param>
  528. <returns>
  529. return the parsed request info from header; if the request has body, this method should return null
  530. </returns>
  531. </member>
  532. <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.Reset">
  533. <summary>
  534. Resets this instance to inital state.
  535. </summary>
  536. </member>
  537. <member name="T:SuperSocket.Facility.Protocol.IHttpRequestInfo">
  538. <summary>
  539. IHttpRequestInfo
  540. </summary>
  541. </member>
  542. <member name="P:SuperSocket.Facility.Protocol.IHttpRequestInfo.Header">
  543. <summary>
  544. Gets the http header.
  545. </summary>
  546. </member>
  547. <member name="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase">
  548. <summary>
  549. HttpRequestInfoBase
  550. </summary>
  551. </member>
  552. <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase.Key">
  553. <summary>
  554. Gets the key of this request.
  555. </summary>
  556. </member>
  557. <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase.Header">
  558. <summary>
  559. Gets the http header.
  560. </summary>
  561. </member>
  562. <member name="M:SuperSocket.Facility.Protocol.HttpRequestInfoBase.#ctor(System.String,System.Collections.Specialized.NameValueCollection)">
  563. <summary>
  564. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase"/> class.
  565. </summary>
  566. <param name="key">The key.</param>
  567. <param name="header">The header.</param>
  568. </member>
  569. <member name="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1">
  570. <summary>
  571. HttpRequestInfoBase
  572. </summary>
  573. <typeparam name="TRequestBody">The type of the request body.</typeparam>
  574. </member>
  575. <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1.Body">
  576. <summary>
  577. Gets the body.
  578. </summary>
  579. </member>
  580. <member name="M:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1.#ctor(System.String,System.Collections.Specialized.NameValueCollection,`0)">
  581. <summary>
  582. Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1"/> class.
  583. </summary>
  584. <param name="key">The key.</param>
  585. <param name="header">The header.</param>
  586. <param name="body">The body.</param>
  587. </member>
  588. <member name="T:SuperSocket.Facility.Protocol.MimeHeaderHelper">
  589. <summary>
  590. MimeHeader Helper class
  591. </summary>
  592. </member>
  593. <member name="M:SuperSocket.Facility.Protocol.MimeHeaderHelper.ParseHttpHeader(System.String,System.Collections.Specialized.NameValueCollection)">
  594. <summary>
  595. Parses the HTTP header.
  596. </summary>
  597. <param name="headerData">The header data.</param>
  598. <param name="header">The header.</param>
  599. </member>
  600. </members>
  601. </doc>