SuperWebSocket.XML 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805
  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.IProtocolProcessor">
  602. <summary>
  603. Protocol processor interface
  604. </summary>
  605. </member>
  606. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.CanSendBinaryData">
  607. <summary>
  608. Gets a value indicating whether this instance can send binary data.
  609. </summary>
  610. <value>
  611. <c>true</c> if this instance can send binary data; otherwise, <c>false</c>.
  612. </value>
  613. </member>
  614. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.CloseStatusClode">
  615. <summary>
  616. Gets the close status clode.
  617. </summary>
  618. </member>
  619. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.NextProcessor">
  620. <summary>
  621. Gets or sets the next processor.
  622. </summary>
  623. <value>
  624. The next processor.
  625. </value>
  626. </member>
  627. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.Handshake(SuperWebSocket.IWebSocketSession,SuperWebSocket.Protocol.WebSocketReceiveFilterBase,SuperSocket.SocketBase.Protocol.IReceiveFilter{SuperWebSocket.Protocol.IWebSocketFragment}@)">
  628. <summary>
  629. Handshakes the specified session.
  630. </summary>
  631. <param name="session">The session.</param>
  632. <param name="previousFilter">The previous filter.</param>
  633. <param name="dataFrameReader">The data frame reader.</param>
  634. <returns></returns>
  635. </member>
  636. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.GetEncodedPackage(System.Int32,System.Byte[],System.Int32,System.Int32)">
  637. <summary>
  638. Gets the encoded package.
  639. </summary>
  640. <param name="opCode">The op code.</param>
  641. <param name="data">The data.</param>
  642. <param name="offset">The offset.</param>
  643. <param name="length">The length.</param>
  644. <returns></returns>
  645. </member>
  646. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.GetEncodedPackage(System.Int32,System.String)">
  647. <summary>
  648. Gets the encoded package.
  649. </summary>
  650. <param name="opCode">The op code.</param>
  651. <param name="message">The message.</param>
  652. <returns></returns>
  653. </member>
  654. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendMessage(SuperWebSocket.IWebSocketSession,System.String)">
  655. <summary>
  656. Sends the message.
  657. </summary>
  658. <param name="session">The session.</param>
  659. <param name="message">The message.</param>
  660. </member>
  661. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.TrySendMessage(SuperWebSocket.IWebSocketSession,System.String)">
  662. <summary>
  663. Try to send the message.
  664. </summary>
  665. <param name="session">The session.</param>
  666. <param name="message">The message.</param>
  667. <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>
  668. </member>
  669. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendData(SuperWebSocket.IWebSocketSession,System.Byte[],System.Int32,System.Int32)">
  670. <summary>
  671. Sends the data.
  672. </summary>
  673. <param name="session">The session.</param>
  674. <param name="data">The data.</param>
  675. <param name="offset">The offset.</param>
  676. <param name="length">The length.</param>
  677. </member>
  678. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.TrySendData(SuperWebSocket.IWebSocketSession,System.Byte[],System.Int32,System.Int32)">
  679. <summary>
  680. Try to send the data.
  681. </summary>
  682. <param name="session">The session.</param>
  683. <param name="data">The data.</param>
  684. <param name="offset">The offset.</param>
  685. <param name="length">The length.</param>
  686. <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>
  687. </member>
  688. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendCloseHandshake(SuperWebSocket.IWebSocketSession,System.Int32,System.String)">
  689. <summary>
  690. Sends the close handshake.
  691. </summary>
  692. <param name="session">The session.</param>
  693. <param name="statusCode">The status code.</param>
  694. <param name="closeReason">The close reason.</param>
  695. </member>
  696. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendPong(SuperWebSocket.IWebSocketSession,System.Byte[])">
  697. <summary>
  698. Sends the pong.
  699. </summary>
  700. <param name="session">The session.</param>
  701. <param name="pong">The pong.</param>
  702. </member>
  703. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.SendPing(SuperWebSocket.IWebSocketSession,System.Byte[])">
  704. <summary>
  705. Sends the ping.
  706. </summary>
  707. <param name="session">The session.</param>
  708. <param name="ping">The ping.</param>
  709. </member>
  710. <member name="P:SuperWebSocket.Protocol.IProtocolProcessor.Version">
  711. <summary>
  712. Gets the version of current protocol.
  713. </summary>
  714. </member>
  715. <member name="M:SuperWebSocket.Protocol.IProtocolProcessor.IsValidCloseCode(System.Int32)">
  716. <summary>
  717. Determines whether [is valid close code] [the specified code].
  718. </summary>
  719. <param name="code">The code.</param>
  720. <returns>
  721. <c>true</c> if [is valid close code] [the specified code]; otherwise, <c>false</c>.
  722. </returns>
  723. </member>
  724. <member name="T:SuperWebSocket.Protocol.IWebSocketFragment">
  725. <summary>
  726. WebSocketFragment request info
  727. </summary>
  728. </member>
  729. <member name="T:SuperWebSocket.Protocol.MultipleProtocolSwitchProcessor">
  730. <summary>
  731. http://tools.ietf.org/html/rfc6455#section-4.4
  732. </summary>
  733. </member>
  734. <member name="T:SuperWebSocket.Protocol.PlainFragment">
  735. <summary>
  736. Plain text fragment
  737. </summary>
  738. </member>
  739. <member name="M:SuperWebSocket.Protocol.PlainFragment.#ctor(System.String)">
  740. <summary>
  741. Initializes a new instance of the <see cref="T:SuperWebSocket.Protocol.PlainFragment"/> class.
  742. </summary>
  743. <param name="message">The message.</param>
  744. </member>
  745. <member name="P:SuperWebSocket.Protocol.PlainFragment.Message">
  746. <summary>
  747. Gets the message.
  748. </summary>
  749. </member>
  750. <member name="P:SuperWebSocket.Protocol.PlainFragment.Key">
  751. <summary>
  752. Gets the key of this request.
  753. </summary>
  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,Microsoft.Extensions.Logging.ILogger)">
  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.ISubCommand`1">
  985. <summary>
  986. SubCommand interface
  987. </summary>
  988. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  989. </member>
  990. <member name="M:SuperWebSocket.SubProtocol.ISubCommand`1.ExecuteCommand(`0,SuperWebSocket.SubProtocol.SubRequestInfo)">
  991. <summary>
  992. Executes the command.
  993. </summary>
  994. <param name="session">The session.</param>
  995. <param name="requestInfo">The request info.</param>
  996. </member>
  997. <member name="T:SuperWebSocket.SubProtocol.ISubCommandFilterLoader">
  998. <summary>
  999. The basic interface of sub command filter loader
  1000. </summary>
  1001. </member>
  1002. <member name="M:SuperWebSocket.SubProtocol.ISubCommandFilterLoader.LoadSubCommandFilters(System.Collections.Generic.IEnumerable{SuperWebSocket.SubProtocol.SubCommandFilterAttribute})">
  1003. <summary>
  1004. Loads the sub command filters.
  1005. </summary>
  1006. <param name="globalFilters">The global filters.</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,Microsoft.Extensions.Logging.ILogger)">
  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,Microsoft.Extensions.Logging.ILogger)">
  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.RegisterSubProtocol(System.Collections.Generic.IEnumerable{SuperWebSocket.SubProtocol.ISubProtocol{`0}})">
  1379. <summary>
  1380. Register sub protocols, Only use after empty create
  1381. </summary>
  1382. <param name="subProtocols"></param>
  1383. <exception cref="T:System.Exception"></exception>
  1384. </member>
  1385. <member name="M:SuperWebSocket.WebSocketServer`1.ValidateHandshake(`0,System.String)">
  1386. <summary>
  1387. Validates the handshake request.
  1388. </summary>
  1389. <param name="session">The session.</param>
  1390. <param name="origin">The origin in the handshake request.</param>
  1391. <returns></returns>
  1392. </member>
  1393. <member name="M:SuperWebSocket.WebSocketServer`1.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)">
  1394. <summary>
  1395. Setups with the specified root config.
  1396. </summary>
  1397. <param name="rootConfig">The root config.</param>
  1398. <param name="config">The config.</param>
  1399. <returns></returns>
  1400. </member>
  1401. <member name="M:SuperWebSocket.WebSocketServer`1.OnStarted">
  1402. <summary>
  1403. Called when [started].
  1404. </summary>
  1405. </member>
  1406. <member name="M:SuperWebSocket.WebSocketServer`1.OnNewSessionConnected(`0)">
  1407. <summary>
  1408. Called when [new session connected].
  1409. </summary>
  1410. <param name="session">The session.</param>
  1411. </member>
  1412. <member name="E:SuperWebSocket.WebSocketServer`1.NewRequestReceived">
  1413. <summary>
  1414. Occurs when [new request received].
  1415. </summary>
  1416. <exception cref="T:System.NotSupportedException"></exception>
  1417. </member>
  1418. <member name="E:SuperWebSocket.WebSocketServer`1.NewMessageReceived">
  1419. <summary>
  1420. Occurs when [new message received].
  1421. </summary>
  1422. </member>
  1423. <member name="E:SuperWebSocket.WebSocketServer`1.NewDataReceived">
  1424. <summary>
  1425. Occurs when [new data received].
  1426. </summary>
  1427. </member>
  1428. <member name="M:SuperWebSocket.WebSocketServer`1.SetupCommands(System.Collections.Generic.Dictionary{System.String,SuperSocket.SocketBase.Command.ICommand{`0,SuperWebSocket.Protocol.IWebSocketFragment}})">
  1429. <summary>
  1430. Setups the commands.
  1431. </summary>
  1432. <param name="discoveredCommands">The discovered commands.</param>
  1433. <returns></returns>
  1434. </member>
  1435. <member name="M:SuperWebSocket.WebSocketServer`1.ExecuteCommand(`0,SuperWebSocket.Protocol.IWebSocketFragment)">
  1436. <summary>
  1437. Executes the command.
  1438. </summary>
  1439. <param name="session">The session.</param>
  1440. <param name="requestInfo">The request info.</param>
  1441. </member>
  1442. <member name="M:SuperWebSocket.WebSocketServer`1.Broadcast(System.Collections.Generic.IEnumerable{`0},System.Byte[],System.Int32,System.Int32,System.Action{`0,System.Boolean})">
  1443. <summary>
  1444. Broadcasts data to the specified sessions.
  1445. </summary>
  1446. <param name="sessions">The sessions.</param>
  1447. <param name="data">The data.</param>
  1448. <param name="offset">The offset.</param>
  1449. <param name="length">The length.</param>
  1450. <param name="sendFeedback">The send feedback.</param>
  1451. </member>
  1452. <member name="M:SuperWebSocket.WebSocketServer`1.Broadcast(System.Collections.Generic.IEnumerable{`0},System.String,System.Action{`0,System.Boolean})">
  1453. <summary>
  1454. Broadcasts message to the specified sessions.
  1455. </summary>
  1456. <param name="sessions">The sessions.</param>
  1457. <param name="message">The message.</param>
  1458. <param name="sendFeedback">The send feedback.</param>
  1459. </member>
  1460. <member name="M:SuperWebSocket.WebSocketServer`1.JsonSerialize(System.Object)">
  1461. <summary>
  1462. Serialize the target object by JSON
  1463. </summary>
  1464. <param name="target">The target.</param>
  1465. <returns></returns>
  1466. </member>
  1467. <member name="M:SuperWebSocket.WebSocketServer`1.JsonDeserialize(System.String,System.Type)">
  1468. <summary>
  1469. Deserialize the JSON string to target type object.
  1470. </summary>
  1471. <param name="json">The json.</param>
  1472. <param name="type">The type.</param>
  1473. <returns></returns>
  1474. </member>
  1475. <member name="T:SuperWebSocket.IWebSocketSession">
  1476. <summary>
  1477. WebSocketSession basic interface
  1478. </summary>
  1479. </member>
  1480. <member name="P:SuperWebSocket.IWebSocketSession.Method">
  1481. <summary>
  1482. Gets or sets the method.
  1483. </summary>
  1484. <value>
  1485. The method.
  1486. </value>
  1487. </member>
  1488. <member name="P:SuperWebSocket.IWebSocketSession.Host">
  1489. <summary>
  1490. Gets the host.
  1491. </summary>
  1492. </member>
  1493. <member name="P:SuperWebSocket.IWebSocketSession.Path">
  1494. <summary>
  1495. Gets or sets the path.
  1496. </summary>
  1497. <value>
  1498. The path.
  1499. </value>
  1500. </member>
  1501. <member name="P:SuperWebSocket.IWebSocketSession.HttpVersion">
  1502. <summary>
  1503. Gets or sets the HTTP version.
  1504. </summary>
  1505. <value>
  1506. The HTTP version.
  1507. </value>
  1508. </member>
  1509. <member name="P:SuperWebSocket.IWebSocketSession.SecWebSocketVersion">
  1510. <summary>
  1511. Gets the sec web socket version.
  1512. </summary>
  1513. </member>
  1514. <member name="P:SuperWebSocket.IWebSocketSession.Origin">
  1515. <summary>
  1516. Gets the origin.
  1517. </summary>
  1518. </member>
  1519. <member name="P:SuperWebSocket.IWebSocketSession.UriScheme">
  1520. <summary>
  1521. Gets the URI scheme.
  1522. </summary>
  1523. </member>
  1524. <member name="P:SuperWebSocket.IWebSocketSession.Handshaked">
  1525. <summary>
  1526. Gets a value indicating whether this <see cref="T:SuperWebSocket.IWebSocketSession" /> is handshaked.
  1527. </summary>
  1528. <value>
  1529. <c>true</c> if handshaked; otherwise, <c>false</c>.
  1530. </value>
  1531. </member>
  1532. <member name="M:SuperWebSocket.IWebSocketSession.SendRawData(System.Byte[],System.Int32,System.Int32)">
  1533. <summary>
  1534. Sends the raw binary data to client.
  1535. </summary>
  1536. <param name="data">The data.</param>
  1537. <param name="offset">The offset.</param>
  1538. <param name="length">The length.</param>
  1539. </member>
  1540. <member name="M:SuperWebSocket.IWebSocketSession.TrySendRawData(System.Byte[],System.Int32,System.Int32)">
  1541. <summary>
  1542. Try to send the raw binary data to client.
  1543. </summary>
  1544. <param name="data">The data.</param>
  1545. <param name="offset">The offset.</param>
  1546. <param name="length">The length.</param>
  1547. <returns>if the data to be sent is queued, return true, else the queue is full, then return false</returns>
  1548. </member>
  1549. <member name="P:SuperWebSocket.IWebSocketSession.AppServer">
  1550. <summary>
  1551. Gets the app server.
  1552. </summary>
  1553. </member>
  1554. <member name="P:SuperWebSocket.IWebSocketSession.ProtocolProcessor">
  1555. <summary>
  1556. Gets or sets the protocol processor.
  1557. </summary>
  1558. <value>
  1559. The protocol processor.
  1560. </value>
  1561. </member>
  1562. <member name="M:SuperWebSocket.IWebSocketSession.GetAvailableSubProtocol(System.String)">
  1563. <summary>
  1564. Gets the available sub protocol.
  1565. </summary>
  1566. <param name="protocol">The protocol.</param>
  1567. <returns></returns>
  1568. </member>
  1569. <member name="T:SuperWebSocket.WebSocketSession">
  1570. <summary>
  1571. WebSocket AppSession
  1572. </summary>
  1573. </member>
  1574. <member name="P:SuperWebSocket.WebSocketSession.AppServer">
  1575. <summary>
  1576. Gets the app server.
  1577. </summary>
  1578. </member>
  1579. <member name="T:SuperWebSocket.WebSocketSession`1">
  1580. <summary>
  1581. WebSocket AppSession class
  1582. </summary>
  1583. <typeparam name="TWebSocketSession">The type of the web socket session.</typeparam>
  1584. </member>
  1585. <member name="P:SuperWebSocket.WebSocketSession`1.Method">
  1586. <summary>
  1587. Gets or sets the method.
  1588. </summary>
  1589. <value>
  1590. The method.
  1591. </value>
  1592. </member>
  1593. <member name="P:SuperWebSocket.WebSocketSession`1.Path">
  1594. <summary>
  1595. Gets or sets the path.
  1596. </summary>
  1597. <value>
  1598. The path.
  1599. </value>
  1600. </member>
  1601. <member name="P:SuperWebSocket.WebSocketSession`1.HttpVersion">
  1602. <summary>
  1603. Gets or sets the HTTP version.
  1604. </summary>
  1605. <value>
  1606. The HTTP version.
  1607. </value>
  1608. </member>
  1609. <member name="P:SuperWebSocket.WebSocketSession`1.Host">
  1610. <summary>
  1611. Gets the host.
  1612. </summary>
  1613. </member>
  1614. <member name="P:SuperWebSocket.WebSocketSession`1.Origin">
  1615. <summary>
  1616. Gets the origin.
  1617. </summary>
  1618. </member>
  1619. <member name="P:SuperWebSocket.WebSocketSession`1.Upgrade">
  1620. <summary>
  1621. Gets the upgrade.
  1622. </summary>
  1623. </member>
  1624. <member name="P:SuperWebSocket.WebSocketSession`1.Connection">
  1625. <summary>
  1626. Gets the connection.
  1627. </summary>
  1628. </member>
  1629. <member name="P:SuperWebSocket.WebSocketSession`1.SecWebSocketVersion">
  1630. <summary>
  1631. Gets the sec web socket version.
  1632. </summary>
  1633. </member>
  1634. <member name="P:SuperWebSocket.WebSocketSession`1.SecWebSocketProtocol">
  1635. <summary>
  1636. Gets the sec web socket protocol.
  1637. </summary>
  1638. </member>
  1639. <member name="P:SuperWebSocket.WebSocketSession`1.CurrentToken">
  1640. <summary>
  1641. Gets the current token.
  1642. </summary>
  1643. </member>
  1644. <member name="P:SuperWebSocket.WebSocketSession`1.AppServer">
  1645. <summary>
  1646. Gets the app server.
  1647. </summary>
  1648. </member>
  1649. <member name="P:SuperWebSocket.WebSocketSession`1.UriScheme">
  1650. <summary>
  1651. Gets the URI scheme, ws or wss
  1652. </summary>
  1653. </member>
  1654. <member name="P:SuperWebSocket.WebSocketSession`1.SubProtocol">
  1655. <summary>
  1656. Gets the sub protocol.
  1657. </summary>
  1658. </member>
  1659. <member name="P:SuperWebSocket.WebSocketSession`1.Handshaked">
  1660. <summary>
  1661. Gets a value indicating whether this <see cref="T:SuperWebSocket.IWebSocketSession" /> is handshaked.
  1662. </summary>
  1663. <value>
  1664. <c>true</c> if handshaked; otherwise, <c>false</c>.
  1665. </value>
  1666. </member>
  1667. <member name="P:SuperWebSocket.WebSocketSession`1.InClosing">
  1668. <summary>
  1669. Gets a value indicating whether the session [in closing].
  1670. </summary>
  1671. <value>
  1672. <c>true</c> if [in closing]; otherwise, <c>false</c>.
  1673. </value>
  1674. </member>
  1675. <member name="M:SuperWebSocket.WebSocketSession`1.OnInit">
  1676. <summary>
  1677. Called when [init].
  1678. </summary>
  1679. </member>
  1680. <member name="M:SuperWebSocket.WebSocketSession`1.SetCookie">
  1681. <summary>
  1682. Sets the cookie.
  1683. </summary>
  1684. </member>
  1685. <member name="P:SuperWebSocket.WebSocketSession`1.Cookies">
  1686. <summary>
  1687. Gets the cookies.
  1688. </summary>
  1689. </member>
  1690. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.String)">
  1691. <summary>
  1692. Sends the message to client.
  1693. </summary>
  1694. <param name="message">The message.</param>
  1695. </member>
  1696. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.String)">
  1697. <summary>
  1698. Tries to send.
  1699. </summary>
  1700. <param name="message">The message to be sent.</param>
  1701. <returns></returns>
  1702. </member>
  1703. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.Byte[],System.Int32,System.Int32)">
  1704. <summary>
  1705. Sends the data to client.
  1706. </summary>
  1707. <param name="data">The data.</param>
  1708. <param name="offset">The offset.</param>
  1709. <param name="length">The length.</param>
  1710. </member>
  1711. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.ArraySegment{System.Byte})">
  1712. <summary>
  1713. Tries to send the data over the websocket connection.
  1714. </summary>
  1715. <param name="segment">The segment to be sent.</param>
  1716. <returns></returns>
  1717. </member>
  1718. <member name="M:SuperWebSocket.WebSocketSession`1.TrySend(System.Byte[],System.Int32,System.Int32)">
  1719. <summary>
  1720. Tries to send the data over the websocket connection.
  1721. </summary>
  1722. <param name="data">The data.</param>
  1723. <param name="offset">The offset.</param>
  1724. <param name="length">The length.</param>
  1725. <returns></returns>
  1726. </member>
  1727. <member name="M:SuperWebSocket.WebSocketSession`1.Send(System.ArraySegment{System.Byte})">
  1728. <summary>
  1729. Sends the segment to client.
  1730. </summary>
  1731. <param name="segment">The segment.</param>
  1732. </member>
  1733. <member name="M:SuperWebSocket.WebSocketSession`1.SuperWebSocket#IWebSocketSession#SendRawData(System.Byte[],System.Int32,System.Int32)">
  1734. <summary>
  1735. Sends the raw binary data.
  1736. </summary>
  1737. <param name="data">The data.</param>
  1738. <param name="offset">The offset.</param>
  1739. <param name="length">The length.</param>
  1740. </member>
  1741. <member name="M:SuperWebSocket.WebSocketSession`1.SuperWebSocket#IWebSocketSession#TrySendRawData(System.Byte[],System.Int32,System.Int32)">
  1742. <summary>
  1743. Try to send the raw binary data to client.
  1744. </summary>
  1745. <param name="data">The data.</param>
  1746. <param name="offset">The offset.</param>
  1747. <param name="length">The length.</param>
  1748. <returns>
  1749. if the data to be sent is queued, return true, else the queue is full, then return false
  1750. </returns>
  1751. </member>
  1752. <member name="M:SuperWebSocket.WebSocketSession`1.TrySendRawData(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  1753. <summary>
  1754. Tries the send raw data segments.
  1755. </summary>
  1756. <param name="segments">The segments.</param>
  1757. <returns></returns>
  1758. </member>
  1759. <member name="M:SuperWebSocket.WebSocketSession`1.CloseWithHandshake(System.String)">
  1760. <summary>
  1761. Closes the with handshake.
  1762. </summary>
  1763. <param name="reasonText">The reason text.</param>
  1764. </member>
  1765. <member name="M:SuperWebSocket.WebSocketSession`1.CloseWithHandshake(System.Int32,System.String)">
  1766. <summary>
  1767. Closes the with handshake.
  1768. </summary>
  1769. <param name="statusCode">The status code.</param>
  1770. <param name="reasonText">The reason text.</param>
  1771. </member>
  1772. <member name="M:SuperWebSocket.WebSocketSession`1.SendCloseHandshakeResponse(System.Int32)">
  1773. <summary>
  1774. Sends the close handshake response.
  1775. </summary>
  1776. <param name="statusCode">The status code.</param>
  1777. </member>
  1778. <member name="M:SuperWebSocket.WebSocketSession`1.Close(SuperSocket.SocketBase.CloseReason)">
  1779. <summary>
  1780. Closes the specified reason.
  1781. </summary>
  1782. <param name="reason">The reason.</param>
  1783. </member>
  1784. <member name="P:SuperWebSocket.WebSocketSession`1.ProtocolProcessor">
  1785. <summary>
  1786. Gets or sets the protocol processor.
  1787. </summary>
  1788. <value>
  1789. The protocol processor.
  1790. </value>
  1791. </member>
  1792. <member name="M:SuperWebSocket.WebSocketSession`1.HandleUnknownCommand(SuperWebSocket.SubProtocol.SubRequestInfo)">
  1793. <summary>
  1794. Handles the unknown command.
  1795. </summary>
  1796. <param name="requestInfo">The request info.</param>
  1797. </member>
  1798. <member name="M:SuperWebSocket.WebSocketSession`1.HandleUnknownRequest(SuperWebSocket.Protocol.IWebSocketFragment)">
  1799. <summary>
  1800. Handles the unknown request.
  1801. </summary>
  1802. <param name="requestInfo">The request info.</param>
  1803. </member>
  1804. </members>
  1805. </doc>