SuperWebSocket.XML 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperWebSocket</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperWebSocket.Command.Binary`1">
  8. <summary>
  9. The command handling binary data
  10. </summary>
  11. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  12. </member>
  13. <member name="P:SuperWebSocket.Command.Binary`1.Name">
  14. <summary>
  15. Gets the name.
  16. </summary>
  17. </member>
  18. <member name="M:SuperWebSocket.Command.Binary`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  19. <summary>
  20. Executes the command.
  21. </summary>
  22. <param name="session">The session.</param>
  23. <param name="requestInfo">The request info.</param>
  24. </member>
  25. <member name="T:SuperWebSocket.Command.Close`1">
  26. <summary>
  27. The command handling close fragment
  28. </summary>
  29. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  30. </member>
  31. <member name="P:SuperWebSocket.Command.Close`1.Name">
  32. <summary>
  33. Gets the name.
  34. </summary>
  35. </member>
  36. <member name="M:SuperWebSocket.Command.Close`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  37. <summary>
  38. Executes the command.
  39. </summary>
  40. <param name="session">The session.</param>
  41. <param name="requestInfo">The request info.</param>
  42. </member>
  43. <member name="T:SuperWebSocket.Command.Continuation`1">
  44. <summary>
  45. The command handling continuation fragment
  46. </summary>
  47. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  48. </member>
  49. <member name="P:SuperWebSocket.Command.Continuation`1.Name">
  50. <summary>
  51. Gets the name.
  52. </summary>
  53. </member>
  54. <member name="M:SuperWebSocket.Command.Continuation`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  55. <summary>
  56. Executes the command.
  57. </summary>
  58. <param name="session">The session.</param>
  59. <param name="requestInfo">The request info.</param>
  60. </member>
  61. <member name="T:SuperWebSocket.Command.FragmentCommand`1">
  62. <summary>
  63. FragmentCommand
  64. </summary>
  65. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  66. </member>
  67. <member name="P:SuperWebSocket.Command.FragmentCommand`1.Utf8Encoding">
  68. <summary>
  69. Gets the UTF8 encoding which has been set ExceptionFallback.
  70. </summary>
  71. </member>
  72. <member name="M:SuperWebSocket.Command.FragmentCommand`1.#ctor">
  73. <summary>
  74. Initializes a new instance of the <see cref="T:SuperWebSocket.Command.FragmentCommand`1"/> class.
  75. </summary>
  76. </member>
  77. <member name="M:SuperWebSocket.Command.FragmentCommand`1.CheckFrame(SuperWebSocket.Protocol.WebSocketDataFrame)">
  78. <summary>
  79. Checks the frame.
  80. </summary>
  81. <param name="frame">The frame.</param>
  82. <returns></returns>
  83. </member>
  84. <member name="M:SuperWebSocket.Command.FragmentCommand`1.CheckControlFrame(SuperWebSocket.Protocol.WebSocketDataFrame)">
  85. <summary>
  86. Checks the control frame.
  87. </summary>
  88. <param name="frame">The frame.</param>
  89. <returns></returns>
  90. </member>
  91. <member name="M:SuperWebSocket.Command.FragmentCommand`1.GetWebSocketData(System.Collections.Generic.IList{SuperWebSocket.Protocol.WebSocketDataFrame})">
  92. <summary>
  93. Gets data from websocket frames.
  94. </summary>
  95. <param name="frames">The frames.</param>
  96. <returns></returns>
  97. </member>
  98. <member name="M:SuperWebSocket.Command.FragmentCommand`1.GetWebSocketText(System.Collections.Generic.IList{SuperWebSocket.Protocol.WebSocketDataFrame})">
  99. <summary>
  100. Gets text string from websocket frames.
  101. </summary>
  102. <param name="frames">The frames.</param>
  103. <returns></returns>
  104. </member>
  105. <member name="M:SuperWebSocket.Command.FragmentCommand`1.GetWebSocketData(SuperWebSocket.Protocol.WebSocketDataFrame)">
  106. <summary>
  107. Gets data from a websocket frame.
  108. </summary>
  109. <param name="frame">The frame.</param>
  110. <returns></returns>
  111. </member>
  112. <member name="M:SuperWebSocket.Command.FragmentCommand`1.GetWebSocketText(SuperWebSocket.Protocol.WebSocketDataFrame)">
  113. <summary>
  114. Gets text string from a websocket frame.
  115. </summary>
  116. <param name="frame">The frame.</param>
  117. <returns></returns>
  118. </member>
  119. <member name="T:SuperWebSocket.Command.HandShake`1">
  120. <summary>
  121. The command handle handshake request
  122. </summary>
  123. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  124. </member>
  125. <member name="P:SuperWebSocket.Command.HandShake`1.Name">
  126. <summary>
  127. Gets the name.
  128. </summary>
  129. </member>
  130. <member name="M:SuperWebSocket.Command.HandShake`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  131. <summary>
  132. Executes the command.
  133. </summary>
  134. <param name="session">The session.</param>
  135. <param name="requestInfo">The request info.</param>
  136. </member>
  137. <member name="T:SuperWebSocket.Command.Ping`1">
  138. <summary>
  139. The command handling Ping
  140. </summary>
  141. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  142. </member>
  143. <member name="P:SuperWebSocket.Command.Ping`1.Name">
  144. <summary>
  145. Gets the name.
  146. </summary>
  147. </member>
  148. <member name="M:SuperWebSocket.Command.Ping`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  149. <summary>
  150. Executes the command.
  151. </summary>
  152. <param name="session">The session.</param>
  153. <param name="requestInfo">The request info.</param>
  154. </member>
  155. <member name="T:SuperWebSocket.Command.Plain`1">
  156. <summary>
  157. The command to handling text message in plain text of hybi00
  158. </summary>
  159. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  160. </member>
  161. <member name="P:SuperWebSocket.Command.Plain`1.Name">
  162. <summary>
  163. Gets the name.
  164. </summary>
  165. </member>
  166. <member name="M:SuperWebSocket.Command.Plain`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  167. <summary>
  168. Executes the command.
  169. </summary>
  170. <param name="session">The session.</param>
  171. <param name="requestInfo">The request info.</param>
  172. </member>
  173. <member name="T:SuperWebSocket.Command.Pong`1">
  174. <summary>
  175. The command handling Pong
  176. </summary>
  177. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  178. </member>
  179. <member name="P:SuperWebSocket.Command.Pong`1.Name">
  180. <summary>
  181. Gets the name.
  182. </summary>
  183. </member>
  184. <member name="M:SuperWebSocket.Command.Pong`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  185. <summary>
  186. Executes the command.
  187. </summary>
  188. <param name="session">The session.</param>
  189. <param name="requestInfo">The request info.</param>
  190. </member>
  191. <member name="T:SuperWebSocket.Command.Text`1">
  192. <summary>
  193. The command handling Text fragment
  194. </summary>
  195. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  196. </member>
  197. <member name="P:SuperWebSocket.Command.Text`1.Name">
  198. <summary>
  199. Gets the name.
  200. </summary>
  201. </member>
  202. <member name="M:SuperWebSocket.Command.Text`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  203. <summary>
  204. Executes the command.
  205. </summary>
  206. <param name="session">The session.</param>
  207. <param name="requestInfo">The request info.</param>
  208. </member>
  209. <member name="T:SuperWebSocket.Config.CommandConfig">
  210. <summary>
  211. Command configuration
  212. </summary>
  213. </member>
  214. <member name="P:SuperWebSocket.Config.CommandConfig.Options">
  215. <summary>
  216. Gets the options.
  217. </summary>
  218. </member>
  219. <member name="M:SuperWebSocket.Config.CommandConfig.OnDeserializeUnrecognizedAttribute(System.String,System.String)">
  220. <summary>
  221. Gets a value indicating whether an unknown attribute is encountered during deserialization.
  222. </summary>
  223. <param name="name">The name of the unrecognized attribute.</param>
  224. <param name="value">The value of the unrecognized attribute.</param>
  225. <returns>
  226. true when an unknown attribute is encountered while deserializing; otherwise, false.
  227. </returns>
  228. </member>
  229. <member name="T:SuperWebSocket.Config.CommandConfigCollection">
  230. <summary>
  231. Command configuration collection
  232. </summary>
  233. </member>
  234. <member name="P:SuperWebSocket.Config.CommandConfigCollection.Item(System.Int32)">
  235. <summary>
  236. Gets or sets a property, attribute, or child element of this configuration element.
  237. </summary>
  238. <returns>The specified property, attribute, or child element</returns>
  239. </member>
  240. <member name="M:SuperWebSocket.Config.CommandConfigCollection.CreateNewElement">
  241. <summary>
  242. When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>.
  243. </summary>
  244. <returns>
  245. A new <see cref="T:System.Configuration.ConfigurationElement"/>.
  246. </returns>
  247. </member>
  248. <member name="M:SuperWebSocket.Config.CommandConfigCollection.GetElementKey(System.Configuration.ConfigurationElement)">
  249. <summary>
  250. Gets the element key for a specified configuration element when overridden in a derived class.
  251. </summary>
  252. <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param>
  253. <returns>
  254. An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>.
  255. </returns>
  256. </member>
  257. <member name="M:SuperWebSocket.Config.CommandConfigCollection.GetEnumerator">
  258. <summary>
  259. Gets the enumerator.
  260. </summary>
  261. <returns></returns>
  262. </member>
  263. <member name="T:SuperWebSocket.Config.SubProtocolConfig">
  264. <summary>
  265. SubProtocol configuration
  266. </summary>
  267. </member>
  268. <member name="M:SuperWebSocket.Config.SubProtocolConfig.#ctor">
  269. <summary>
  270. Initializes a new instance of the <see cref="T:SuperWebSocket.Config.SubProtocolConfig"/> class.
  271. </summary>
  272. </member>
  273. <member name="P:SuperWebSocket.Config.SubProtocolConfig.Type">
  274. <summary>
  275. Gets the type.
  276. </summary>
  277. </member>
  278. <member name="P:SuperWebSocket.Config.SubProtocolConfig.Commands">
  279. <summary>
  280. Gets the commands.
  281. </summary>
  282. </member>
  283. <member name="T:SuperWebSocket.Config.SubProtocolConfigCollection">
  284. <summary>
  285. SubProtocol configuation collection
  286. </summary>
  287. </member>
  288. <member name="M:SuperWebSocket.Config.SubProtocolConfigCollection.CreateNewElement">
  289. <summary>
  290. When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>.
  291. </summary>
  292. <returns>
  293. A new <see cref="T:System.Configuration.ConfigurationElement"/>.
  294. </returns>
  295. </member>
  296. <member name="M:SuperWebSocket.Config.SubProtocolConfigCollection.GetElementKey(System.Configuration.ConfigurationElement)">
  297. <summary>
  298. Gets the element key for a specified configuration element when overridden in a derived class.
  299. </summary>
  300. <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param>
  301. <returns>
  302. An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>.
  303. </returns>
  304. </member>
  305. <member name="M:SuperWebSocket.Config.SubProtocolConfigCollection.GetEnumerator">
  306. <summary>
  307. Gets the enumerator.
  308. </summary>
  309. <returns></returns>
  310. </member>
  311. <member name="P:SuperWebSocket.Config.SubProtocolConfigCollection.CollectionType">
  312. <summary>
  313. Gets the type of the <see cref="T:System.Configuration.ConfigurationElementCollection"/>.
  314. </summary>
  315. <returns>The <see cref="T:System.Configuration.ConfigurationElementCollectionType"/> of this collection.</returns>
  316. </member>
  317. <member name="P:SuperWebSocket.Config.SubProtocolConfigCollection.ElementName">
  318. <summary>
  319. Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class.
  320. </summary>
  321. <returns>The name of the collection; otherwise, an empty string. The default is an empty string.</returns>
  322. </member>
  323. <member name="T:SuperWebSocket.Extensions">
  324. <summary>
  325. Extension class
  326. </summary>
  327. </member>
  328. <member name="M:SuperWebSocket.Extensions.AppendFormatWithCrCf(System.Text.StringBuilder,System.String,System.Object)">
  329. <summary>
  330. Appends in the format with CrCf as suffix.
  331. </summary>
  332. <param name="builder">The builder.</param>
  333. <param name="format">The format.</param>
  334. <param name="arg">The arg.</param>
  335. </member>
  336. <member name="M:SuperWebSocket.Extensions.AppendFormatWithCrCf(System.Text.StringBuilder,System.String,System.Object[])">
  337. <summary>
  338. Appends in the format with CrCf as suffix.
  339. </summary>
  340. <param name="builder">The builder.</param>
  341. <param name="format">The format.</param>
  342. <param name="args">The args.</param>
  343. </member>
  344. <member name="M:SuperWebSocket.Extensions.AppendWithCrCf(System.Text.StringBuilder,System.String)">
  345. <summary>
  346. Appends with CrCf as suffix.
  347. </summary>
  348. <param name="builder">The builder.</param>
  349. <param name="content">The content.</param>
  350. </member>
  351. <member name="M:SuperWebSocket.Extensions.AppendWithCrCf(System.Text.StringBuilder)">
  352. <summary>
  353. Appends with CrCf as suffix.
  354. </summary>
  355. <param name="builder">The builder.</param>
  356. </member>
  357. <member name="T:SuperWebSocket.IBinaryDataConverter">
  358. <summary>
  359. The converter interface for converting binary data to text message
  360. </summary>
  361. </member>
  362. <member name="M:SuperWebSocket.IBinaryDataConverter.ToString(System.Byte[],System.Int32,System.Int32)">
  363. <summary>
  364. Returns a <see cref="T:System.String" /> that represents this instance.
  365. </summary>
  366. <param name="data">The data.</param>
  367. <param name="offset">The offset.</param>
  368. <param name="length">The length.</param>
  369. <returns>
  370. A <see cref="T:System.String" /> that represents this instance.
  371. </returns>
  372. </member>
  373. <member name="T:SuperWebSocket.JsonWebSocketSession">
  374. <summary>
  375. Json websocket session
  376. </summary>
  377. </member>
  378. <member name="T:SuperWebSocket.JsonWebSocketSession`1">
  379. <summary>
  380. Json websocket session
  381. </summary>
  382. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  383. </member>
  384. <member name="M:SuperWebSocket.JsonWebSocketSession`1.SendJsonMessage(System.String,System.Object)">
  385. <summary>
  386. Sends the json message.
  387. </summary>
  388. <param name="name">The name.</param>
  389. <param name="content">The content.</param>
  390. </member>
  391. <member name="T:SuperWebSocket.Protocol.CloseStatusCodeHybi10">
  392. <summary>
  393. Close status code for Hybi10
  394. </summary>
  395. </member>
  396. <member name="M:SuperWebSocket.Protocol.CloseStatusCodeHybi10.#ctor">
  397. <summary>
  398. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.CloseStatusCodeHybi10"/> class.
  399. </summary>
  400. </member>
  401. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.NormalClosure">
  402. <summary>
  403. Gets the code for normal closure.
  404. </summary>
  405. </member>
  406. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.GoingAway">
  407. <summary>
  408. Gets the code for going away.
  409. </summary>
  410. </member>
  411. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.ProtocolError">
  412. <summary>
  413. Gets the code for protocol error.
  414. </summary>
  415. </member>
  416. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.NotAcceptableData">
  417. <summary>
  418. Gets the code for not acceptable data.
  419. </summary>
  420. </member>
  421. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.TooLargeFrame">
  422. <summary>
  423. Gets the code for too large frame.
  424. </summary>
  425. </member>
  426. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.InvalidUTF8">
  427. <summary>
  428. Gets the code for invalid UT f8.
  429. </summary>
  430. </member>
  431. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.ViolatePolicy">
  432. <summary>
  433. Gets the code for violate policy.
  434. </summary>
  435. </member>
  436. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.ExtensionNotMatch">
  437. <summary>
  438. Gets the code for extension not match.
  439. </summary>
  440. </member>
  441. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.UnexpectedCondition">
  442. <summary>
  443. Gets the code for unexpected condition.
  444. </summary>
  445. </member>
  446. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.TLSHandshakeFailure">
  447. <summary>
  448. Gets the code for TLS handshake failure.
  449. </summary>
  450. </member>
  451. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeHybi10.NoStatusCode">
  452. <summary>
  453. Gets the code for no status code.
  454. </summary>
  455. </member>
  456. <member name="T:SuperWebSocket.Protocol.CloseStatusCodeRfc6455">
  457. <summary>
  458. Close status code for rfc6455
  459. </summary>
  460. </member>
  461. <member name="M:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.#ctor">
  462. <summary>
  463. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.CloseStatusCodeRfc6455"/> class.
  464. </summary>
  465. </member>
  466. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.NormalClosure">
  467. <summary>
  468. Gets the code for normal closure.
  469. </summary>
  470. </member>
  471. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.GoingAway">
  472. <summary>
  473. Gets the code for going away.
  474. </summary>
  475. </member>
  476. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.ProtocolError">
  477. <summary>
  478. Gets the code for protocol error.
  479. </summary>
  480. </member>
  481. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.NotAcceptableData">
  482. <summary>
  483. Gets the code for not acceptable data.
  484. </summary>
  485. </member>
  486. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.TooLargeFrame">
  487. <summary>
  488. Gets the code for too large frame.
  489. </summary>
  490. </member>
  491. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.InvalidUTF8">
  492. <summary>
  493. Gets the code for invalid UT f8.
  494. </summary>
  495. </member>
  496. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.ViolatePolicy">
  497. <summary>
  498. Gets the code for violate policy.
  499. </summary>
  500. </member>
  501. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.ExtensionNotMatch">
  502. <summary>
  503. Gets the code for extension not match.
  504. </summary>
  505. </member>
  506. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.UnexpectedCondition">
  507. <summary>
  508. Gets the code for unexpected condition.
  509. </summary>
  510. </member>
  511. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.TLSHandshakeFailure">
  512. <summary>
  513. Gets the code for TLS handshake failure.
  514. </summary>
  515. </member>
  516. <member name="P:SuperWebSocket.Protocol.CloseStatusCodeRfc6455.NoStatusCode">
  517. <summary>
  518. Gets the code for no status code.
  519. </summary>
  520. </member>
  521. <member name="T:SuperWebSocket.Protocol.DraftHybi00Processor">
  522. <summary>
  523. http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00
  524. </summary>
  525. </member>
  526. <member name="T:SuperWebSocket.Protocol.DraftHybi10Processor">
  527. <summary>
  528. http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10
  529. </summary>
  530. </member>
  531. <member name="T:SuperWebSocket.Protocol.HandshakeRequest">
  532. <summary>
  533. Handshake request
  534. </summary>
  535. </member>
  536. <member name="P:SuperWebSocket.Protocol.HandshakeRequest.Key">
  537. <summary>
  538. Gets the key of this request.
  539. </summary>
  540. </member>
  541. <member name="T:SuperWebSocket.Protocol.ICloseStatusCode">
  542. <summary>
  543. Close status code interface
  544. </summary>
  545. </member>
  546. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.ExtensionNotMatch">
  547. <summary>
  548. Gets the code for extension not match.
  549. </summary>
  550. </member>
  551. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.GoingAway">
  552. <summary>
  553. Gets the code for going away.
  554. </summary>
  555. </member>
  556. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.InvalidUTF8">
  557. <summary>
  558. Gets the code for invalid UT f8.
  559. </summary>
  560. </member>
  561. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.NormalClosure">
  562. <summary>
  563. Gets the code for normal closure.
  564. </summary>
  565. </member>
  566. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.NotAcceptableData">
  567. <summary>
  568. Gets the code for not acceptable data.
  569. </summary>
  570. </member>
  571. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.ProtocolError">
  572. <summary>
  573. Gets the code for protocol error.
  574. </summary>
  575. </member>
  576. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.TLSHandshakeFailure">
  577. <summary>
  578. Gets the code for TLS handshake failure.
  579. </summary>
  580. </member>
  581. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.TooLargeFrame">
  582. <summary>
  583. Gets the code for too large frame.
  584. </summary>
  585. </member>
  586. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.UnexpectedCondition">
  587. <summary>
  588. Gets the code for unexpected condition.
  589. </summary>
  590. </member>
  591. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.ViolatePolicy">
  592. <summary>
  593. Gets the code for violate policy.
  594. </summary>
  595. </member>
  596. <member name="P:SuperWebSocket.Protocol.ICloseStatusCode.NoStatusCode">
  597. <summary>
  598. Gets the code for no status code.
  599. </summary>
  600. </member>
  601. <member name="T:SuperWebSocket.Protocol.IWebSocketFragment">
  602. <summary>
  603. WebSocketFragment request info
  604. </summary>
  605. </member>
  606. <member name="T:SuperWebSocket.Protocol.MultipleProtocolSwitchProcessor">
  607. <summary>
  608. http://tools.ietf.org/html/rfc6455#section-4.4
  609. </summary>
  610. </member>
  611. <member name="T:SuperWebSocket.Protocol.PlainFragment">
  612. <summary>
  613. Plain text fragment
  614. </summary>
  615. </member>
  616. <member name="M:SuperWebSocket.Protocol.PlainFragment.#ctor(System.String)">
  617. <summary>
  618. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.PlainFragment"/> class.
  619. </summary>
  620. <param name="message">The message.</param>
  621. </member>
  622. <member name="P:SuperWebSocket.Protocol.PlainFragment.Message">
  623. <summary>
  624. Gets the message.
  625. </summary>
  626. </member>
  627. <member name="P:SuperWebSocket.Protocol.PlainFragment.Key">
  628. <summary>
  629. Gets the key of this request.
  630. </summary>
  631. </member>
  632. <member name="T:SuperWebSocket.Protocol.IProtocolProcessor">
  633. <summary>
  634. Protocol processor interface
  635. </summary>
  636. </member>
  637. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.CanSendBinaryData">
  638. <summary>
  639. Gets a value indicating whether this instance can send binary data.
  640. </summary>
  641. <value>
  642. <c>true</c> if this instance can send binary data; otherwise, <c>false</c>.
  643. </value>
  644. </member>
  645. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.CloseStatusClode">
  646. <summary>
  647. Gets the close status clode.
  648. </summary>
  649. </member>
  650. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.NextProcessor">
  651. <summary>
  652. Gets or sets the next processor.
  653. </summary>
  654. <value>
  655. The next processor.
  656. </value>
  657. </member>
  658. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.Handshake(SuperWebSocket.IWebSocketSession,SuperWebSocket.Protocol.WebSocketReceiveFilterBase,SuperSocket.SocketBase.Protocol.IReceiveFilter{SuperWebSocket.Protocol.IWebSocketFragment}@)">
  659. <summary>
  660. Handshakes the specified session.
  661. </summary>
  662. <param name="session">The session.</param>
  663. <param name="previousFilter">The previous filter.</param>
  664. <param name="dataFrameReader">The data frame reader.</param>
  665. <returns></returns>
  666. </member>
  667. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.GetEncodedPackage(System.Int32,System.Byte[],System.Int32,System.Int32)">
  668. <summary>
  669. Gets the encoded package.
  670. </summary>
  671. <param name="opCode">The op code.</param>
  672. <param name="data">The data.</param>
  673. <param name="offset">The offset.</param>
  674. <param name="length">The length.</param>
  675. <returns></returns>
  676. </member>
  677. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.GetEncodedPackage(System.Int32,System.String)">
  678. <summary>
  679. Gets the encoded package.
  680. </summary>
  681. <param name="opCode">The op code.</param>
  682. <param name="message">The message.</param>
  683. <returns></returns>
  684. </member>
  685. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendMessage(SuperWebSocket.IWebSocketSession,System.String)">
  686. <summary>
  687. Sends the message.
  688. </summary>
  689. <param name="session">The session.</param>
  690. <param name="message">The message.</param>
  691. </member>
  692. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.TrySendMessage(SuperWebSocket.IWebSocketSession,System.String)">
  693. <summary>
  694. Try to send the message.
  695. </summary>
  696. <param name="session">The session.</param>
  697. <param name="message">The message.</param>
  698. <returns>if the messaged has been enqueued into the sending queue, return true; else if the message failed to be enqueued becuase the sending is full, then return false</returns>
  699. </member>
  700. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendData(SuperWebSocket.IWebSocketSession,System.Byte[],System.Int32,System.Int32)">
  701. <summary>
  702. Sends the data.
  703. </summary>
  704. <param name="session">The session.</param>
  705. <param name="data">The data.</param>
  706. <param name="offset">The offset.</param>
  707. <param name="length">The length.</param>
  708. </member>
  709. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.TrySendData(SuperWebSocket.IWebSocketSession,System.Byte[],System.Int32,System.Int32)">
  710. <summary>
  711. Try to send the data.
  712. </summary>
  713. <param name="session">The session.</param>
  714. <param name="data">The data.</param>
  715. <param name="offset">The offset.</param>
  716. <param name="length">The length.</param>
  717. <returns>if the data has been enqueued into the sending queue, return true; else if the data failed to be enqueued becuase the sending is full, then return false</returns>
  718. </member>
  719. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendCloseHandshake(SuperWebSocket.IWebSocketSession,System.Int32,System.String)">
  720. <summary>
  721. Sends the close handshake.
  722. </summary>
  723. <param name="session">The session.</param>
  724. <param name="statusCode">The status code.</param>
  725. <param name="closeReason">The close reason.</param>
  726. </member>
  727. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendPong(SuperWebSocket.IWebSocketSession,System.Byte[])">
  728. <summary>
  729. Sends the pong.
  730. </summary>
  731. <param name="session">The session.</param>
  732. <param name="pong">The pong.</param>
  733. </member>
  734. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendPing(SuperWebSocket.IWebSocketSession,System.Byte[])">
  735. <summary>
  736. Sends the ping.
  737. </summary>
  738. <param name="session">The session.</param>
  739. <param name="ping">The ping.</param>
  740. </member>
  741. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.Version">
  742. <summary>
  743. Gets the version of current protocol.
  744. </summary>
  745. </member>
  746. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.IsValidCloseCode(System.Int32)">
  747. <summary>
  748. Determines whether [is valid close code] [the specified code].
  749. </summary>
  750. <param name="code">The code.</param>
  751. <returns>
  752. <c>true</c> if [is valid close code] [the specified code]; otherwise, <c>false</c>.
  753. </returns>
  754. </member>
  755. <member name="T:SuperWebSocket.Protocol.Rfc6455Processor">
  756. <summary>
  757. http://tools.ietf.org/html/rfc6455
  758. </summary>
  759. </member>
  760. <member name="M:SuperWebSocket.Protocol.WebSocketDataReceiveFilter.Reset">
  761. <summary>
  762. Resets this instance.
  763. </summary>
  764. </member>
  765. <member name="T:SuperWebSocket.Protocol.WebSocketReceiveFilterBase">
  766. <summary>
  767. WebSocketReceiveFilter basis
  768. </summary>
  769. </member>
  770. <member name="F:SuperWebSocket.Protocol.WebSocketReceiveFilterBase.SecKey3Len">
  771. <summary>
  772. The length of Sec3Key
  773. </summary>
  774. </member>
  775. <member name="M:SuperWebSocket.Protocol.WebSocketReceiveFilterBase.#ctor(SuperWebSocket.IWebSocketSession)">
  776. <summary>
  777. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.WebSocketReceiveFilterBase" /> class.
  778. </summary>
  779. <param name="session">The session.</param>
  780. </member>
  781. <member name="M:SuperWebSocket.Protocol.WebSocketReceiveFilterBase.#ctor(SuperWebSocket.Protocol.WebSocketReceiveFilterBase)">
  782. <summary>
  783. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.WebSocketReceiveFilterBase" /> class.
  784. </summary>
  785. <param name="previousReceiveFilter">The previous receive filter.</param>
  786. </member>
  787. <member name="M:SuperWebSocket.Protocol.WebSocketReceiveFilterBase.Handshake(SuperWebSocket.Protocol.IProtocolProcessor,SuperWebSocket.IWebSocketSession)">
  788. <summary>
  789. Handshakes the specified protocol processor.
  790. </summary>
  791. <param name="protocolProcessor">The protocol processor.</param>
  792. <param name="session">The session.</param>
  793. <returns></returns>
  794. </member>
  795. <member name="P:SuperWebSocket.Protocol.WebSocketReceiveFilterBase.HandshakeRequestInfo">
  796. <summary>
  797. Gets the handshake request info.
  798. </summary>
  799. </member>
  800. <member name="T:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`1">
  801. <summary>
  802. Async json sub command
  803. </summary>
  804. <typeparam name="TJsonCommandInfo">The type of the json command info.</typeparam>
  805. </member>
  806. <member name="T:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2">
  807. <summary>
  808. Async json sub command
  809. </summary>
  810. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  811. <typeparam name="TJsonCommandInfo">The type of the json command info.</typeparam>
  812. </member>
  813. <member name="M:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2.#ctor">
  814. <summary>
  815. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2"/> class.
  816. </summary>
  817. </member>
  818. <member name="M:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2.ExecuteJsonCommand(`0,`1)">
  819. <summary>
  820. Executes the json command.
  821. </summary>
  822. <param name="session">The session.</param>
  823. <param name="commandInfo">The command info.</param>
  824. </member>
  825. <member name="M:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2.ExecuteAsyncJsonCommand(`0,System.String,`1)">
  826. <summary>
  827. Executes the async json command.
  828. </summary>
  829. <param name="session">The session.</param>
  830. <param name="token">The token.</param>
  831. <param name="commandInfo">The command info.</param>
  832. </member>
  833. <member name="M:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2.SendJsonMessage(`0,System.String,System.Object)">
  834. <summary>
  835. Sends the json message.
  836. </summary>
  837. <param name="session">The session.</param>
  838. <param name="token">The token.</param>
  839. <param name="content">The content.</param>
  840. </member>
  841. <member name="M:SuperWebSocket.SubProtocol.AsyncJsonSubCommand`2.SendJsonMessage(`0,System.String,System.String,System.Object)">
  842. <summary>
  843. Sends the json message.
  844. </summary>
  845. <param name="session">The session.</param>
  846. <param name="name">The name.</param>
  847. <param name="token">The token.</param>
  848. <param name="content">The content.</param>
  849. </member>
  850. <member name="T:SuperWebSocket.SubProtocol.BasicSubCommandParser">
  851. <summary>
  852. Basic sub command parser
  853. </summary>
  854. </member>
  855. <member name="M:SuperWebSocket.SubProtocol.BasicSubCommandParser.ParseRequestInfo(System.String)">
  856. <summary>
  857. Parses the request info.
  858. </summary>
  859. <param name="source">The source.</param>
  860. <returns></returns>
  861. </member>
  862. <member name="T:SuperWebSocket.SubProtocol.BasicSubProtocol">
  863. <summary>
  864. Default basic sub protocol implementation
  865. </summary>
  866. </member>
  867. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor">
  868. <summary>
  869. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  870. </summary>
  871. </member>
  872. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.String)">
  873. <summary>
  874. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  875. </summary>
  876. <param name="name">The sub protocol name.</param>
  877. </member>
  878. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.Reflection.Assembly)">
  879. <summary>
  880. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  881. </summary>
  882. <param name="commandAssembly">The command assembly.</param>
  883. </member>
  884. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
  885. <summary>
  886. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  887. </summary>
  888. <param name="commandAssemblies">The command assemblies.</param>
  889. </member>
  890. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.String,System.Reflection.Assembly)">
  891. <summary>
  892. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  893. </summary>
  894. <param name="name">The sub protocol name.</param>
  895. <param name="commandAssembly">The command assembly.</param>
  896. </member>
  897. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
  898. <summary>
  899. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  900. </summary>
  901. <param name="name">The sub protocol name.</param>
  902. <param name="commandAssemblies">The command assemblies.</param>
  903. </member>
  904. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Reflection.Assembly},SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperWebSocket.SubProtocol.SubRequestInfo})">
  905. <summary>
  906. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol"/> class.
  907. </summary>
  908. <param name="name">The name.</param>
  909. <param name="commandAssemblies">The command assemblies.</param>
  910. <param name="requestInfoParser">The request info parser.</param>
  911. </member>
  912. <member name="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1">
  913. <summary>
  914. Default basic sub protocol implementation
  915. </summary>
  916. </member>
  917. <member name="F:SuperWebSocket.SubProtocol.BasicSubProtocol`1.DefaultName">
  918. <summary>
  919. Default basic sub protocol name
  920. </summary>
  921. </member>
  922. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor">
  923. <summary>
  924. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with the calling aseembly as command assembly
  925. </summary>
  926. </member>
  927. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.String)">
  928. <summary>
  929. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with the calling aseembly as command assembly
  930. </summary>
  931. <param name="name">The sub protocol name.</param>
  932. </member>
  933. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
  934. <summary>
  935. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with command assemblies
  936. </summary>
  937. <param name="commandAssemblies">The command assemblies.</param>
  938. </member>
  939. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.Reflection.Assembly)">
  940. <summary>
  941. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with single command assembly.
  942. </summary>
  943. <param name="commandAssembly">The command assembly.</param>
  944. </member>
  945. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.String,System.Reflection.Assembly)">
  946. <summary>
  947. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with name and single command assembly.
  948. </summary>
  949. <param name="name">The sub protocol name.</param>
  950. <param name="commandAssembly">The command assembly.</param>
  951. </member>
  952. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
  953. <summary>
  954. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class with name and command assemblies.
  955. </summary>
  956. <param name="name">The sub protocol name.</param>
  957. <param name="commandAssemblies">The command assemblies.</param>
  958. </member>
  959. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.#ctor(System.String,System.Collections.Generic.IEnumerable{System.Reflection.Assembly},SuperSocket.SocketBase.Protocol.IRequestInfoParser{SuperWebSocket.SubProtocol.SubRequestInfo})">
  960. <summary>
  961. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.BasicSubProtocol`1"/> class.
  962. </summary>
  963. <param name="name">The name.</param>
  964. <param name="commandAssemblies">The command assemblies.</param>
  965. <param name="requestInfoParser">The request info parser.</param>
  966. </member>
  967. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.Initialize(SuperSocket.SocketBase.IAppServer,SuperWebSocket.Config.SubProtocolConfig,SuperSocket.SocketBase.Logging.ILog)">
  968. <summary>
  969. Initializes with the specified config.
  970. </summary>
  971. <param name="appServer">The app server.</param>
  972. <param name="protocolConfig">The protocol config.</param>
  973. <param name="logger">The logger.</param>
  974. <returns></returns>
  975. </member>
  976. <member name="M:SuperWebSocket.SubProtocol.BasicSubProtocol`1.TryGetCommand(System.String,SuperWebSocket.SubProtocol.ISubCommand{`0}@)">
  977. <summary>
  978. Tries get command from the sub protocol's command inventory.
  979. </summary>
  980. <param name="name">The name.</param>
  981. <param name="command">The command.</param>
  982. <returns></returns>
  983. </member>
  984. <member name="T:SuperWebSocket.SubProtocol.ISubCommandFilterLoader">
  985. <summary>
  986. The basic interface of sub command filter loader
  987. </summary>
  988. </member>
  989. <member name="M:SuperWebSocket.SubProtocol.ISubCommandFilterLoader.LoadSubCommandFilters(System.Collections.Generic.IEnumerable{SuperWebSocket.SubProtocol.SubCommandFilterAttribute})">
  990. <summary>
  991. Loads the sub command filters.
  992. </summary>
  993. <param name="globalFilters">The global filters.</param>
  994. </member>
  995. <member name="T:SuperWebSocket.SubProtocol.ISubCommand`1">
  996. <summary>
  997. SubCommand interface
  998. </summary>
  999. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1000. </member>
  1001. <member name="M:SuperWebSocket.SubProtocol.ISubCommand`1.ExecuteCommand(`0,SuperWebSocket.SubProtocol.SubRequestInfo)">
  1002. <summary>
  1003. Executes the command.
  1004. </summary>
  1005. <param name="session">The session.</param>
  1006. <param name="requestInfo">The request info.</param>
  1007. </member>
  1008. <member name="T:SuperWebSocket.SubProtocol.ISubProtocol`1">
  1009. <summary>
  1010. SubProtocol interface
  1011. </summary>
  1012. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1013. </member>
  1014. <member name="M:SuperWebSocket.SubProtocol.ISubProtocol`1.Initialize(SuperSocket.SocketBase.IAppServer,SuperWebSocket.Config.SubProtocolConfig,SuperSocket.SocketBase.Logging.ILog)">
  1015. <summary>
  1016. Initializes with the specified config.
  1017. </summary>
  1018. <param name="appServer">The app server.</param>
  1019. <param name="protocolConfig">The protocol config.</param>
  1020. <param name="logger">The logger.</param>
  1021. <returns></returns>
  1022. </member>
  1023. <member name="P:SuperWebSocket.SubProtocol.ISubProtocol`1.Name">
  1024. <summary>
  1025. Gets the name.
  1026. </summary>
  1027. </member>
  1028. <member name="P:SuperWebSocket.SubProtocol.ISubProtocol`1.SubRequestParser">
  1029. <summary>
  1030. Gets the sub request parser.
  1031. </summary>
  1032. </member>
  1033. <member name="M:SuperWebSocket.SubProtocol.ISubProtocol`1.TryGetCommand(System.String,SuperWebSocket.SubProtocol.ISubCommand{`0}@)">
  1034. <summary>
  1035. Tries the get command.
  1036. </summary>
  1037. <param name="name">The name.</param>
  1038. <param name="command">The command.</param>
  1039. <returns></returns>
  1040. </member>
  1041. <member name="T:SuperWebSocket.SubProtocol.ISubRequestInfo">
  1042. <summary>
  1043. The basic interface of SubRequestInfo
  1044. </summary>
  1045. </member>
  1046. <member name="P:SuperWebSocket.SubProtocol.ISubRequestInfo.Token">
  1047. <summary>
  1048. Gets the token.
  1049. </summary>
  1050. <value>
  1051. The token.
  1052. </value>
  1053. </member>
  1054. <member name="T:SuperWebSocket.SubProtocol.JsonSubCommand`1">
  1055. <summary>
  1056. JsonSubCommand
  1057. </summary>
  1058. <typeparam name="TJsonCommandInfo">The type of the json command info.</typeparam>
  1059. </member>
  1060. <member name="T:SuperWebSocket.SubProtocol.JsonSubCommand`2">
  1061. <summary>
  1062. JsonSubCommand
  1063. </summary>
  1064. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1065. <typeparam name="TJsonCommandInfo">The type of the json command info.</typeparam>
  1066. </member>
  1067. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommand`2.GetJsonMessage(`0,System.Object)">
  1068. <summary>
  1069. Gets the json message.
  1070. </summary>
  1071. <param name="session">The session.</param>
  1072. <param name="content">The content.</param>
  1073. <returns></returns>
  1074. </member>
  1075. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommand`2.GetJsonMessage(`0,System.String,System.Object)">
  1076. <summary>
  1077. Gets the json message.
  1078. </summary>
  1079. <param name="session">The session.</param>
  1080. <param name="name">The name.</param>
  1081. <param name="content">The content.</param>
  1082. <returns></returns>
  1083. </member>
  1084. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommand`2.SendJsonMessage(`0,System.Object)">
  1085. <summary>
  1086. Sends the json message.
  1087. </summary>
  1088. <param name="session">The session.</param>
  1089. <param name="content">The content.</param>
  1090. </member>
  1091. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommand`2.SendJsonMessage(`0,System.String,System.Object)">
  1092. <summary>
  1093. Sends the json message.
  1094. </summary>
  1095. <param name="session">The session.</param>
  1096. <param name="name">The name.</param>
  1097. <param name="content">The content.</param>
  1098. </member>
  1099. <member name="T:SuperWebSocket.SubProtocol.JsonSubCommandBase`2">
  1100. <summary>
  1101. Json SubCommand base
  1102. </summary>
  1103. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1104. <typeparam name="TJsonCommandInfo">The type of the json command info.</typeparam>
  1105. </member>
  1106. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommandBase`2.#ctor">
  1107. <summary>
  1108. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.JsonSubCommandBase`2"/> class.
  1109. </summary>
  1110. </member>
  1111. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommandBase`2.ExecuteCommand(`0,SuperWebSocket.SubProtocol.SubRequestInfo)">
  1112. <summary>
  1113. Executes the command.
  1114. </summary>
  1115. <param name="session">The session.</param>
  1116. <param name="requestInfo">The request info.</param>
  1117. </member>
  1118. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommandBase`2.ExecuteJsonCommand(`0,`1)">
  1119. <summary>
  1120. Executes the json command.
  1121. </summary>
  1122. <param name="session">The session.</param>
  1123. <param name="commandInfo">The command info.</param>
  1124. </member>
  1125. <member name="M:SuperWebSocket.SubProtocol.JsonSubCommandBase`2.GetJsonMessage(`0,System.String,System.String,System.Object)">
  1126. <summary>
  1127. Gets the json message.
  1128. </summary>
  1129. <param name="session">The session.</param>
  1130. <param name="name">The name.</param>
  1131. <param name="token">The token.</param>
  1132. <param name="content">The content.</param>
  1133. <returns></returns>
  1134. </member>
  1135. <member name="T:SuperWebSocket.SubProtocol.SubCommandBase">
  1136. <summary>
  1137. SubCommand base
  1138. </summary>
  1139. </member>
  1140. <member name="T:SuperWebSocket.SubProtocol.SubCommandBase`1">
  1141. <summary>
  1142. SubCommand base
  1143. </summary>
  1144. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1145. </member>
  1146. <member name="P:SuperWebSocket.SubProtocol.SubCommandBase`1.Name">
  1147. <summary>
  1148. Gets the name.
  1149. </summary>
  1150. </member>
  1151. <member name="M:SuperWebSocket.SubProtocol.SubCommandBase`1.ExecuteCommand(`0,SuperWebSocket.SubProtocol.SubRequestInfo)">
  1152. <summary>
  1153. Executes the command.
  1154. </summary>
  1155. <param name="session">The session.</param>
  1156. <param name="requestInfo">The request info.</param>
  1157. </member>
  1158. <member name="T:SuperWebSocket.SubProtocol.SubCommandFilterAttribute">
  1159. <summary>
  1160. SubCommandFilter Attribute
  1161. </summary>
  1162. </member>
  1163. <member name="P:SuperWebSocket.SubProtocol.SubCommandFilterAttribute.SubProtocol">
  1164. <summary>
  1165. Gets or sets the sub protocol.
  1166. </summary>
  1167. <value>
  1168. The sub protocol.
  1169. </value>
  1170. </member>
  1171. <member name="T:SuperWebSocket.SubProtocol.SubProtocolBase`1">
  1172. <summary>
  1173. SubProtocol basis
  1174. </summary>
  1175. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1176. </member>
  1177. <member name="M:SuperWebSocket.SubProtocol.SubProtocolBase`1.#ctor(System.String)">
  1178. <summary>
  1179. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.SubProtocolBase`1"/> class.
  1180. </summary>
  1181. <param name="name">The name.</param>
  1182. </member>
  1183. <member name="P:SuperWebSocket.SubProtocol.SubProtocolBase`1.Name">
  1184. <summary>
  1185. Gets the name.
  1186. </summary>
  1187. </member>
  1188. <member name="M:SuperWebSocket.SubProtocol.SubProtocolBase`1.Initialize(SuperSocket.SocketBase.IAppServer,SuperWebSocket.Config.SubProtocolConfig,SuperSocket.SocketBase.Logging.ILog)">
  1189. <summary>
  1190. Initializes with the specified config.
  1191. </summary>
  1192. <param name="appServer">The app server.</param>
  1193. <param name="protocolConfig">The protocol config.</param>
  1194. <param name="logger">The logger.</param>
  1195. <returns></returns>
  1196. </member>
  1197. <member name="P:SuperWebSocket.SubProtocol.SubProtocolBase`1.SubRequestParser">
  1198. <summary>
  1199. Gets or sets the sub request parser.
  1200. </summary>
  1201. <value>
  1202. The sub request parser.
  1203. </value>
  1204. </member>
  1205. <member name="M:SuperWebSocket.SubProtocol.SubProtocolBase`1.TryGetCommand(System.String,SuperWebSocket.SubProtocol.ISubCommand{`0}@)">
  1206. <summary>
  1207. Tries the get command.
  1208. </summary>
  1209. <param name="name">The name.</param>
  1210. <param name="command">The command.</param>
  1211. <returns></returns>
  1212. </member>
  1213. <member name="T:SuperWebSocket.SubProtocol.SubRequestInfo">
  1214. <summary>
  1215. SubProtocol RequestInfo type
  1216. </summary>
  1217. </member>
  1218. <member name="P:SuperWebSocket.SubProtocol.SubRequestInfo.Token">
  1219. <summary>
  1220. Gets the token of this request, used for callback
  1221. </summary>
  1222. </member>
  1223. <member name="M:SuperWebSocket.SubProtocol.SubRequestInfo.#ctor(System.String,System.String,System.String)">
  1224. <summary>
  1225. Initializes a new instance of the <see cref="T:SuperWebSocket.SubProtocol.SubRequestInfo"/> class.
  1226. </summary>
  1227. <param name="key">The key.</param>
  1228. <param name="token">The token.</param>
  1229. <param name="data">The data.</param>
  1230. </member>
  1231. <member name="T:SuperWebSocket.TextEncodingBinaryDataConverter">
  1232. <summary>
  1233. Text encoding binary data converter
  1234. </summary>
  1235. </member>
  1236. <member name="P:SuperWebSocket.TextEncodingBinaryDataConverter.Encoding">
  1237. <summary>
  1238. Gets the encoding.
  1239. </summary>
  1240. <value>
  1241. The encoding.
  1242. </value>
  1243. </member>
  1244. <member name="M:SuperWebSocket.TextEncodingBinaryDataConverter.#ctor(System.Text.Encoding)">
  1245. <summary>
  1246. Initializes a new instance of the <see cref="T:SuperWebSocket.TextEncodingBinaryDataConverter" /> class.
  1247. </summary>
  1248. <param name="encoding">The encoding.</param>
  1249. </member>
  1250. <member name="M:SuperWebSocket.TextEncodingBinaryDataConverter.ToString(System.Byte[],System.Int32,System.Int32)">
  1251. <summary>
  1252. Returns a <see cref="T:System.String" /> that represents this instance.
  1253. </summary>
  1254. <param name="data">The data.</param>
  1255. <param name="offset">The offset.</param>
  1256. <param name="length">The length.</param>
  1257. <returns>
  1258. A <see cref="T:System.String" /> that represents this instance.
  1259. </returns>
  1260. </member>
  1261. <member name="T:SuperWebSocket.WebSocketProtocol">
  1262. <summary>
  1263. WebSocket protocol
  1264. </summary>
  1265. </member>
  1266. <member name="M:SuperWebSocket.WebSocketProtocol.#ctor">
  1267. <summary>
  1268. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketProtocol"/> class.
  1269. </summary>
  1270. </member>
  1271. <member name="M:SuperWebSocket.WebSocketProtocol.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)">
  1272. <summary>
  1273. Creates the filter.
  1274. </summary>
  1275. <param name="appServer">The app server.</param>
  1276. <param name="appSession">The app session.</param>
  1277. <param name="remoteEndPoint">The remote end point.</param>
  1278. <returns></returns>
  1279. </member>
  1280. <member name="T:SuperWebSocket.IWebSocketServer">
  1281. <summary>
  1282. WebSocket server interface
  1283. </summary>
  1284. </member>
  1285. <member name="P:SuperWebSocket.IWebSocketServer.WebSocketProtocolProcessor">
  1286. <summary>
  1287. Gets the web socket protocol processor.
  1288. </summary>
  1289. </member>
  1290. <member name="M:SuperWebSocket.IWebSocketServer.ValidateHandshake(SuperWebSocket.IWebSocketSession,System.String)">
  1291. <summary>
  1292. Validates the handshake request.
  1293. </summary>
  1294. <param name="session">The session.</param>
  1295. <param name="origin">The origin.</param>
  1296. <returns>the validation result</returns>
  1297. </member>
  1298. <member name="T:SuperWebSocket.WebSocketServer">
  1299. <summary>
  1300. WebSocket AppServer
  1301. </summary>
  1302. </member>
  1303. <member name="M:SuperWebSocket.WebSocketServer.#ctor(System.Collections.Generic.IEnumerable{SuperWebSocket.SubProtocol.ISubProtocol{SuperWebSocket.WebSocketSession}})">
  1304. <summary>
  1305. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer"/> class.
  1306. </summary>
  1307. <param name="subProtocols">The sub protocols.</param>
  1308. </member>
  1309. <member name="M:SuperWebSocket.WebSocketServer.#ctor(SuperWebSocket.SubProtocol.ISubProtocol{SuperWebSocket.WebSocketSession})">
  1310. <summary>
  1311. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer"/> class.
  1312. </summary>
  1313. <param name="subProtocol">The sub protocol.</param>
  1314. </member>
  1315. <member name="M:SuperWebSocket.WebSocketServer.#ctor">
  1316. <summary>
  1317. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer"/> class.
  1318. </summary>
  1319. </member>
  1320. <member name="T:SuperWebSocket.WebSocketServer`1">
  1321. <summary>
  1322. WebSocket AppServer
  1323. </summary>
  1324. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1325. </member>
  1326. <member name="P:SuperWebSocket.WebSocketServer`1.BinaryDataConverter">
  1327. <summary>
  1328. Gets or sets the binary data converter.
  1329. </summary>
  1330. <value>
  1331. The binary data converter.
  1332. </value>
  1333. </member>
  1334. <member name="M:SuperWebSocket.WebSocketServer`1.#ctor(System.Collections.Generic.IEnumerable{SuperWebSocket.SubProtocol.ISubProtocol{`0}})">
  1335. <summary>
  1336. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer`1"/> class.
  1337. </summary>
  1338. <param name="subProtocols">The sub protocols.</param>
  1339. </member>
  1340. <member name="M:SuperWebSocket.WebSocketServer`1.#ctor(SuperWebSocket.SubProtocol.ISubProtocol{`0})">
  1341. <summary>
  1342. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer`1"/> class.
  1343. </summary>
  1344. <param name="subProtocol">The sub protocol.</param>
  1345. </member>
  1346. <member name="M:SuperWebSocket.WebSocketServer`1.#ctor">
  1347. <summary>
  1348. Initializes a new instance of the <see cref="T:SuperWebSocket.WebSocketServer`1"/> class.
  1349. </summary>
  1350. </member>
  1351. <member name="F:SuperWebSocket.WebSocketServer`1.m_OpenHandshakeTimeOut">
  1352. <summary>
  1353. The openning handshake timeout, in seconds
  1354. </summary>
  1355. </member>
  1356. <member name="F:SuperWebSocket.WebSocketServer`1.m_CloseHandshakeTimeOut">
  1357. <summary>
  1358. The closing handshake timeout, in seconds
  1359. </summary>
  1360. </member>
  1361. <member name="F:SuperWebSocket.WebSocketServer`1.m_HandshakePendingQueueCheckingInterval">
  1362. <summary>
  1363. The interval of checking handshake pending queue, in seconds
  1364. </summary>
  1365. </member>
  1366. <member name="M:SuperWebSocket.WebSocketServer`1.GetSubProtocol(System.String)">
  1367. <summary>
  1368. Gets the sub protocol by sub protocol name.
  1369. </summary>
  1370. <param name="name">The name.</param>
  1371. <returns></returns>
  1372. </member>
  1373. <member name="P:SuperWebSocket.WebSocketServer`1.ReceiveFilterFactory">
  1374. <summary>
  1375. Gets the request filter factory.
  1376. </summary>
  1377. </member>
  1378. <member name="M:SuperWebSocket.WebSocketServer`1.ValidateHandshake(`0,System.String)">
  1379. <summary>
  1380. Validates the handshake request.
  1381. </summary>
  1382. <param name="session">The session.</param>
  1383. <param name="origin">The origin in the handshake request.</param>
  1384. <returns></returns>
  1385. </member>
  1386. <member name="M:SuperWebSocket.WebSocketServer`1.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)">
  1387. <summary>
  1388. Setups with the specified root config.
  1389. </summary>
  1390. <param name="rootConfig">The root config.</param>
  1391. <param name="config">The config.</param>
  1392. <returns></returns>
  1393. </member>
  1394. <member name="M:SuperWebSocket.WebSocketServer`1.OnStarted">
  1395. <summary>
  1396. Called when [started].
  1397. </summary>
  1398. </member>
  1399. <member name="M:SuperWebSocket.WebSocketServer`1.OnNewSessionConnected(`0)">
  1400. <summary>
  1401. Called when [new session connected].
  1402. </summary>
  1403. <param name="session">The session.</param>
  1404. </member>
  1405. <member name="E:SuperWebSocket.WebSocketServer`1.NewRequestReceived">
  1406. <summary>
  1407. Occurs when [new request received].
  1408. </summary>
  1409. <exception cref="T:System.NotSupportedException"></exception>
  1410. </member>
  1411. <member name="E:SuperWebSocket.WebSocketServer`1.NewMessageReceived">
  1412. <summary>
  1413. Occurs when [new message received].
  1414. </summary>
  1415. </member>
  1416. <member name="E:SuperWebSocket.WebSocketServer`1.NewDataReceived">
  1417. <summary>
  1418. Occurs when [new data received].
  1419. </summary>
  1420. </member>
  1421. <member name="M:SuperWebSocket.WebSocketServer`1.SetupCommands(System.Collections.Generic.Dictionary{System.String,SuperSocket.SocketBase.Command.ICommand{`0,SuperWebSocket.Protocol.IWebSocketFragment}})">
  1422. <summary>
  1423. Setups the commands.
  1424. </summary>
  1425. <param name="discoveredCommands">The discovered commands.</param>
  1426. <returns></returns>
  1427. </member>
  1428. <member name="M:SuperWebSocket.WebSocketServer`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  1429. <summary>
  1430. Executes the command.
  1431. </summary>
  1432. <param name="session">The session.</param>
  1433. <param name="requestInfo">The request info.</param>
  1434. </member>
  1435. <member name="M:SuperWebSocket.WebSocketServer`1.Broadcast(System.Collections.Generic.IEnumerable{`0},System.Byte[],System.Int32,System.Int32,System.Action{`0,System.Boolean})">
  1436. <summary>
  1437. Broadcasts data to the specified sessions.
  1438. </summary>
  1439. <param name="sessions">The sessions.</param>
  1440. <param name="data">The data.</param>
  1441. <param name="offset">The offset.</param>
  1442. <param name="length">The length.</param>
  1443. <param name="sendFeedback">The send feedback.</param>
  1444. </member>
  1445. <member name="M:SuperWebSocket.WebSocketServer`1.Broadcast(System.Collections.Generic.IEnumerable{`0},System.String,System.Action{`0,System.Boolean})">
  1446. <summary>
  1447. Broadcasts message to the specified sessions.
  1448. </summary>
  1449. <param name="sessions">The sessions.</param>
  1450. <param name="message">The message.</param>
  1451. <param name="sendFeedback">The send feedback.</param>
  1452. </member>
  1453. <member name="M:SuperWebSocket.WebSocketServer`1.JsonSerialize(System.Object)">
  1454. <summary>
  1455. Serialize the target object by JSON
  1456. </summary>
  1457. <param name="target">The target.</param>
  1458. <returns></returns>
  1459. </member>
  1460. <member name="M:SuperWebSocket.WebSocketServer`1.JsonDeserialize(System.String,System.Type)">
  1461. <summary>
  1462. Deserialize the JSON string to target type object.
  1463. </summary>
  1464. <param name="json">The json.</param>
  1465. <param name="type">The type.</param>
  1466. <returns></returns>
  1467. </member>
  1468. <member name="T:SuperWebSocket.IWebSocketSession">
  1469. <summary>
  1470. WebSocketSession basic interface
  1471. </summary>
  1472. </member>
  1473. <member name="P:SuperWebSocket.IWebSocketSession.Method">
  1474. <summary>
  1475. Gets or sets the method.
  1476. </summary>
  1477. <value>
  1478. The method.
  1479. </value>
  1480. </member>
  1481. <member name="P:SuperWebSocket.IWebSocketSession.Host">
  1482. <summary>
  1483. Gets the host.
  1484. </summary>
  1485. </member>
  1486. <member name="P:SuperWebSocket.IWebSocketSession.Path">
  1487. <summary>
  1488. Gets or sets the path.
  1489. </summary>
  1490. <value>
  1491. The path.
  1492. </value>
  1493. </member>
  1494. <member name="P:SuperWebSocket.IWebSocketSession.HttpVersion">
  1495. <summary>
  1496. Gets or sets the HTTP version.
  1497. </summary>
  1498. <value>
  1499. The HTTP version.
  1500. </value>
  1501. </member>
  1502. <member name="P:SuperWebSocket.IWebSocketSession.SecWebSocketVersion">
  1503. <summary>
  1504. Gets the sec web socket version.
  1505. </summary>
  1506. </member>
  1507. <member name="P:SuperWebSocket.IWebSocketSession.Origin">
  1508. <summary>
  1509. Gets the origin.
  1510. </summary>
  1511. </member>
  1512. <member name="P:SuperWebSocket.IWebSocketSession.UriScheme">
  1513. <summary>
  1514. Gets the URI scheme.
  1515. </summary>
  1516. </member>
  1517. <member name="P:SuperWebSocket.IWebSocketSession.Handshaked">
  1518. <summary>
  1519. Gets a value indicating whether this <see cref="T:SuperWebSocket.IWebSocketSession" /> is handshaked.
  1520. </summary>
  1521. <value>
  1522. <c>true</c> if handshaked; otherwise, <c>false</c>.
  1523. </value>
  1524. </member>
  1525. <member name="M:SuperWebSocket.IWebSocketSession.SendRawData(System.Byte[],System.Int32,System.Int32)">
  1526. <summary>
  1527. Sends the raw binary data to client.
  1528. </summary>
  1529. <param name="data">The data.</param>
  1530. <param name="offset">The offset.</param>
  1531. <param name="length">The length.</param>
  1532. </member>
  1533. <member name="M:SuperWebSocket.IWebSocketSession.TrySendRawData(System.Byte[],System.Int32,System.Int32)">
  1534. <summary>
  1535. Try to send the raw binary data to client.
  1536. </summary>
  1537. <param name="data">The data.</param>
  1538. <param name="offset">The offset.</param>
  1539. <param name="length">The length.</param>
  1540. <returns>if the data to be sent is queued, return true, else the queue is full, then return false</returns>
  1541. </member>
  1542. <member name="P:SuperWebSocket.IWebSocketSession.AppServer">
  1543. <summary>
  1544. Gets the app server.
  1545. </summary>
  1546. </member>
  1547. <member name="P:SuperWebSocket.IWebSocketSession.ProtocolProcessor">
  1548. <summary>
  1549. Gets or sets the protocol processor.
  1550. </summary>
  1551. <value>
  1552. The protocol processor.
  1553. </value>
  1554. </member>
  1555. <member name="M:SuperWebSocket.IWebSocketSession.GetAvailableSubProtocol(System.String)">
  1556. <summary>
  1557. Gets the available sub protocol.
  1558. </summary>
  1559. <param name="protocol">The protocol.</param>
  1560. <returns></returns>
  1561. </member>
  1562. <member name="T:SuperWebSocket.WebSocketSession">
  1563. <summary>
  1564. WebSocket AppSession
  1565. </summary>
  1566. </member>
  1567. <member name="P:SuperWebSocket.WebSocketSession.AppServer">
  1568. <summary>
  1569. Gets the app server.
  1570. </summary>
  1571. </member>
  1572. <member name="T:SuperWebSocket.WebSocketSession`1">
  1573. <summary>
  1574. WebSocket AppSession class
  1575. </summary>
  1576. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1577. </member>
  1578. <member name="P:SuperWebSocket.WebSocketSession`1.Method">
  1579. <summary>
  1580. Gets or sets the method.
  1581. </summary>
  1582. <value>
  1583. The method.
  1584. </value>
  1585. </member>
  1586. <member name="P:SuperWebSocket.WebSocketSession`1.Path">
  1587. <summary>
  1588. Gets or sets the path.
  1589. </summary>
  1590. <value>
  1591. The path.
  1592. </value>
  1593. </member>
  1594. <member name="P:SuperWebSocket.WebSocketSession`1.HttpVersion">
  1595. <summary>
  1596. Gets or sets the HTTP version.
  1597. </summary>
  1598. <value>
  1599. The HTTP version.
  1600. </value>
  1601. </member>
  1602. <member name="P:SuperWebSocket.WebSocketSession`1.Host">
  1603. <summary>
  1604. Gets the host.
  1605. </summary>
  1606. </member>
  1607. <member name="P:SuperWebSocket.WebSocketSession`1.Origin">
  1608. <summary>
  1609. Gets the origin.
  1610. </summary>
  1611. </member>
  1612. <member name="P:SuperWebSocket.WebSocketSession`1.Upgrade">
  1613. <summary>
  1614. Gets the upgrade.
  1615. </summary>
  1616. </member>
  1617. <member name="P:SuperWebSocket.WebSocketSession`1.Connection">
  1618. <summary>
  1619. Gets the connection.
  1620. </summary>
  1621. </member>
  1622. <member name="P:SuperWebSocket.WebSocketSession`1.SecWebSocketVersion">
  1623. <summary>
  1624. Gets the sec web socket version.
  1625. </summary>
  1626. </member>
  1627. <member name="P:SuperWebSocket.WebSocketSession`1.SecWebSocketProtocol">
  1628. <summary>
  1629. Gets the sec web socket protocol.
  1630. </summary>
  1631. </member>
  1632. <member name="P:SuperWebSocket.WebSocketSession`1.CurrentToken">
  1633. <summary>
  1634. Gets the current token.
  1635. </summary>
  1636. </member>
  1637. <member name="P:SuperWebSocket.WebSocketSession`1.AppServer">
  1638. <summary>
  1639. Gets the app server.
  1640. </summary>
  1641. </member>
  1642. <member name="P:SuperWebSocket.WebSocketSession`1.UriScheme">
  1643. <summary>
  1644. Gets the URI scheme, ws or wss
  1645. </summary>
  1646. </member>
  1647. <member name="P:SuperWebSocket.WebSocketSession`1.SubProtocol">
  1648. <summary>
  1649. Gets the sub protocol.
  1650. </summary>
  1651. </member>
  1652. <member name="P:SuperWebSocket.WebSocketSession`1.Handshaked">
  1653. <summary>
  1654. Gets a value indicating whether this <see cref="T:SuperWebSocket.IWebSocketSession" /> is handshaked.
  1655. </summary>
  1656. <value>
  1657. <c>true</c> if handshaked; otherwise, <c>false</c>.
  1658. </value>
  1659. </member>
  1660. <member name="P:SuperWebSocket.WebSocketSession`1.InClosing">
  1661. <summary>
  1662. Gets a value indicating whether the session [in closing].
  1663. </summary>
  1664. <value>
  1665. <c>true</c> if [in closing]; otherwise, <c>false</c>.
  1666. </value>
  1667. </member>
  1668. <member name="M:SuperWebSocket.WebSocketSession`1.OnInit">
  1669. <summary>
  1670. Called when [init].
  1671. </summary>
  1672. </member>
  1673. <member name="M:SuperWebSocket.WebSocketSession`1.SetCookie">
  1674. <summary>
  1675. Sets the cookie.
  1676. </summary>
  1677. </member>
  1678. <member name="P:SuperWebSocket.WebSocketSession`1.Cookies">
  1679. <summary>
  1680. Gets the cookies.
  1681. </summary>
  1682. </member>
  1683. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.String)">
  1684. <summary>
  1685. Sends the message to client.
  1686. </summary>
  1687. <param name="message">The message.</param>
  1688. </member>
  1689. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.String)">
  1690. <summary>
  1691. Tries to send.
  1692. </summary>
  1693. <param name="message">The message to be sent.</param>
  1694. <returns></returns>
  1695. </member>
  1696. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.Byte[],System.Int32,System.Int32)">
  1697. <summary>
  1698. Sends the data to client.
  1699. </summary>
  1700. <param name="data">The data.</param>
  1701. <param name="offset">The offset.</param>
  1702. <param name="length">The length.</param>
  1703. </member>
  1704. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.ArraySegment{System.Byte})">
  1705. <summary>
  1706. Tries to send the data over the websocket connection.
  1707. </summary>
  1708. <param name="segment">The segment to be sent.</param>
  1709. <returns></returns>
  1710. </member>
  1711. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.Byte[],System.Int32,System.Int32)">
  1712. <summary>
  1713. Tries to send the data over the websocket connection.
  1714. </summary>
  1715. <param name="data">The data.</param>
  1716. <param name="offset">The offset.</param>
  1717. <param name="length">The length.</param>
  1718. <returns></returns>
  1719. </member>
  1720. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.ArraySegment{System.Byte})">
  1721. <summary>
  1722. Sends the segment to client.
  1723. </summary>
  1724. <param name="segment">The segment.</param>
  1725. </member>
  1726. <member name="M:SuperWebSocket.WebSocketSession`1.SuperWebSocket#IWebSocketSession#SendRawData(System.Byte[],System.Int32,System.Int32)">
  1727. <summary>
  1728. Sends the raw binary data.
  1729. </summary>
  1730. <param name="data">The data.</param>
  1731. <param name="offset">The offset.</param>
  1732. <param name="length">The length.</param>
  1733. </member>
  1734. <member name="M:SuperWebSocket.WebSocketSession`1.SuperWebSocket#IWebSocketSession#TrySendRawData(System.Byte[],System.Int32,System.Int32)">
  1735. <summary>
  1736. Try to send the raw binary data to client.
  1737. </summary>
  1738. <param name="data">The data.</param>
  1739. <param name="offset">The offset.</param>
  1740. <param name="length">The length.</param>
  1741. <returns>
  1742. if the data to be sent is queued, return true, else the queue is full, then return false
  1743. </returns>
  1744. </member>
  1745. <member name="M:SuperWebSocket.WebSocketSession`1.TrySendRawData(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  1746. <summary>
  1747. Tries the send raw data segments.
  1748. </summary>
  1749. <param name="segments">The segments.</param>
  1750. <returns></returns>
  1751. </member>
  1752. <member name="M:SuperWebSocket.WebSocketSession`1.CloseWithHandshake(System.String)">
  1753. <summary>
  1754. Closes the with handshake.
  1755. </summary>
  1756. <param name="reasonText">The reason text.</param>
  1757. </member>
  1758. <member name="M:SuperWebSocket.WebSocketSession`1.CloseWithHandshake(System.Int32,System.String)">
  1759. <summary>
  1760. Closes the with handshake.
  1761. </summary>
  1762. <param name="statusCode">The status code.</param>
  1763. <param name="reasonText">The reason text.</param>
  1764. </member>
  1765. <member name="M:SuperWebSocket.WebSocketSession`1.SendCloseHandshakeResponse(System.Int32)">
  1766. <summary>
  1767. Sends the close handshake response.
  1768. </summary>
  1769. <param name="statusCode">The status code.</param>
  1770. </member>
  1771. <member name="M:SuperWebSocket.WebSocketSession`1.Close(SuperSocket.SocketBase.CloseReason)">
  1772. <summary>
  1773. Closes the specified reason.
  1774. </summary>
  1775. <param name="reason">The reason.</param>
  1776. </member>
  1777. <member name="P:SuperWebSocket.WebSocketSession`1.ProtocolProcessor">
  1778. <summary>
  1779. Gets or sets the protocol processor.
  1780. </summary>
  1781. <value>
  1782. The protocol processor.
  1783. </value>
  1784. </member>
  1785. <member name="M:SuperWebSocket.WebSocketSession`1.HandleUnknownCommand(SuperWebSocket.SubProtocol.SubRequestInfo)">
  1786. <summary>
  1787. Handles the unknown command.
  1788. </summary>
  1789. <param name="requestInfo">The request info.</param>
  1790. </member>
  1791. <member name="M:SuperWebSocket.WebSocketSession`1.HandleUnknownRequest(SuperWebSocket.Protocol.IWebSocketFragment)">
  1792. <summary>
  1793. Handles the unknown request.
  1794. </summary>
  1795. <param name="requestInfo">The request info.</param>
  1796. </member>
  1797. </members>
  1798. </doc>