SuperSocket.Common.xml 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperSocket.Common</name>
  5. </assembly>
  6. <members>
  7. <member name="P:SuperSocket.Common.ArraySegmentEx`1.Array">
  8. <summary>
  9. Gets the array.
  10. </summary>
  11. </member>
  12. <member name="P:SuperSocket.Common.ArraySegmentEx`1.Count">
  13. <summary>
  14. Gets the count.
  15. </summary>
  16. </member>
  17. <member name="P:SuperSocket.Common.ArraySegmentEx`1.Offset">
  18. <summary>
  19. Gets the offset.
  20. </summary>
  21. </member>
  22. <member name="T:SuperSocket.Common.ArraySegmentList`1">
  23. <summary>
  24. ArraySegmentList
  25. </summary>
  26. <typeparam name="T"></typeparam>
  27. </member>
  28. <member name="M:SuperSocket.Common.ArraySegmentList`1.#ctor">
  29. <summary>
  30. Initializes a new instance of the <see cref="T:SuperSocket.Common.ArraySegmentList`1"/> class.
  31. </summary>
  32. </member>
  33. <member name="M:SuperSocket.Common.ArraySegmentList`1.IndexOf(`0)">
  34. <summary>
  35. Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>.
  36. </summary>
  37. <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
  38. <returns>
  39. The index of <paramref name="item"/> if found in the list; otherwise, -1.
  40. </returns>
  41. </member>
  42. <member name="M:SuperSocket.Common.ArraySegmentList`1.Insert(System.Int32,`0)">
  43. <summary>
  44. NotSupported
  45. </summary>
  46. </member>
  47. <member name="M:SuperSocket.Common.ArraySegmentList`1.RemoveAt(System.Int32)">
  48. <summary>
  49. NotSupported
  50. </summary>
  51. </member>
  52. <member name="P:SuperSocket.Common.ArraySegmentList`1.Item(System.Int32)">
  53. <summary>
  54. Gets or sets the element at the specified index.
  55. </summary>
  56. <returns>
  57. The element at the specified index.
  58. </returns>
  59. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.
  60. </exception>
  61. <exception cref="T:System.NotSupportedException">
  62. The property is set and the <see cref="T:System.Collections.Generic.IList`1"/> is read-only.
  63. </exception>
  64. </member>
  65. <member name="M:SuperSocket.Common.ArraySegmentList`1.Add(`0)">
  66. <summary>
  67. NotSupported
  68. </summary>
  69. </member>
  70. <member name="M:SuperSocket.Common.ArraySegmentList`1.Clear">
  71. <summary>
  72. NotSupported
  73. </summary>
  74. </member>
  75. <member name="M:SuperSocket.Common.ArraySegmentList`1.Contains(`0)">
  76. <summary>
  77. NotSupported
  78. </summary>
  79. </member>
  80. <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[],System.Int32)">
  81. <summary>
  82. Copies to.
  83. </summary>
  84. <param name="array">The array.</param>
  85. <param name="arrayIndex">Index of the array.</param>
  86. </member>
  87. <member name="P:SuperSocket.Common.ArraySegmentList`1.Count">
  88. <summary>
  89. Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
  90. </summary>
  91. <returns>
  92. The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
  93. </returns>
  94. </member>
  95. <member name="P:SuperSocket.Common.ArraySegmentList`1.IsReadOnly">
  96. <summary>
  97. Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
  98. </summary>
  99. <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false.
  100. </returns>
  101. </member>
  102. <member name="M:SuperSocket.Common.ArraySegmentList`1.Remove(`0)">
  103. <summary>
  104. NotSupported
  105. </summary>
  106. </member>
  107. <member name="M:SuperSocket.Common.ArraySegmentList`1.GetEnumerator">
  108. <summary>
  109. NotSupported
  110. </summary>
  111. </member>
  112. <member name="M:SuperSocket.Common.ArraySegmentList`1.System#Collections#IEnumerable#GetEnumerator">
  113. <summary>
  114. NotSupported
  115. </summary>
  116. </member>
  117. <member name="M:SuperSocket.Common.ArraySegmentList`1.RemoveSegmentAt(System.Int32)">
  118. <summary>
  119. Removes the segment at.
  120. </summary>
  121. <param name="index">The index.</param>
  122. </member>
  123. <member name="M:SuperSocket.Common.ArraySegmentList`1.AddSegment(`0[],System.Int32,System.Int32)">
  124. <summary>
  125. Adds the segment to the list.
  126. </summary>
  127. <param name="array">The array.</param>
  128. <param name="offset">The offset.</param>
  129. <param name="length">The length.</param>
  130. </member>
  131. <member name="M:SuperSocket.Common.ArraySegmentList`1.AddSegment(`0[],System.Int32,System.Int32,System.Boolean)">
  132. <summary>
  133. Adds the segment to the list.
  134. </summary>
  135. <param name="array">The array.</param>
  136. <param name="offset">The offset.</param>
  137. <param name="length">The length.</param>
  138. <param name="toBeCopied">if set to <c>true</c> [to be copied].</param>
  139. </member>
  140. <member name="P:SuperSocket.Common.ArraySegmentList`1.SegmentCount">
  141. <summary>
  142. Gets the segment count.
  143. </summary>
  144. </member>
  145. <member name="M:SuperSocket.Common.ArraySegmentList`1.ClearSegements">
  146. <summary>
  147. Clears all the segements.
  148. </summary>
  149. </member>
  150. <member name="M:SuperSocket.Common.ArraySegmentList`1.ToArrayData">
  151. <summary>
  152. Read all data in this list to the array data.
  153. </summary>
  154. <returns></returns>
  155. </member>
  156. <member name="M:SuperSocket.Common.ArraySegmentList`1.ToArrayData(System.Int32,System.Int32)">
  157. <summary>
  158. Read the data in specific range to the array data.
  159. </summary>
  160. <param name="startIndex">The start index.</param>
  161. <param name="length">The length.</param>
  162. <returns></returns>
  163. </member>
  164. <member name="M:SuperSocket.Common.ArraySegmentList`1.TrimEnd(System.Int32)">
  165. <summary>
  166. Trims the end.
  167. </summary>
  168. <param name="trimSize">Size of the trim.</param>
  169. </member>
  170. <member name="M:SuperSocket.Common.ArraySegmentList`1.SearchLastSegment(SuperSocket.Common.SearchMarkState{`0})">
  171. <summary>
  172. Searches the last segment.
  173. </summary>
  174. <param name="state">The state.</param>
  175. <returns></returns>
  176. </member>
  177. <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[])">
  178. <summary>
  179. Copies to.
  180. </summary>
  181. <param name="to">To.</param>
  182. <returns></returns>
  183. </member>
  184. <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[],System.Int32,System.Int32,System.Int32)">
  185. <summary>
  186. Copies to.
  187. </summary>
  188. <param name="to">To.</param>
  189. <param name="srcIndex">Index of the SRC.</param>
  190. <param name="toIndex">To index.</param>
  191. <param name="length">The length.</param>
  192. <returns></returns>
  193. </member>
  194. <member name="T:SuperSocket.Common.ArraySegmentList">
  195. <summary>
  196. ArraySegmentList
  197. </summary>
  198. </member>
  199. <member name="M:SuperSocket.Common.ArraySegmentList.Decode(System.Text.Encoding)">
  200. <summary>
  201. Decodes bytes to string by the specified encoding.
  202. </summary>
  203. <param name="encoding">The encoding.</param>
  204. <returns></returns>
  205. </member>
  206. <member name="M:SuperSocket.Common.ArraySegmentList.Decode(System.Text.Encoding,System.Int32,System.Int32)">
  207. <summary>
  208. Decodes bytes to string by the specified encoding.
  209. </summary>
  210. <param name="encoding">The encoding.</param>
  211. <param name="offset">The offset.</param>
  212. <param name="length">The length.</param>
  213. <returns></returns>
  214. </member>
  215. <member name="M:SuperSocket.Common.ArraySegmentList.DecodeMask(System.Byte[],System.Int32,System.Int32)">
  216. <summary>
  217. Decodes data by the mask.
  218. </summary>
  219. <param name="mask">The mask.</param>
  220. <param name="offset">The offset.</param>
  221. <param name="length">The length.</param>
  222. </member>
  223. <member name="T:SuperSocket.Common.AssemblyUtil">
  224. <summary>
  225. Assembly Util Class
  226. </summary>
  227. </member>
  228. <member name="M:SuperSocket.Common.AssemblyUtil.CreateInstance``1(System.String)">
  229. <summary>
  230. Creates the instance from type name.
  231. </summary>
  232. <typeparam name="T"></typeparam>
  233. <param name="type">The type.</param>
  234. <returns></returns>
  235. </member>
  236. <member name="M:SuperSocket.Common.AssemblyUtil.CreateInstance``1(System.String,System.Object[])">
  237. <summary>
  238. Creates the instance from type name and parameters.
  239. </summary>
  240. <typeparam name="T"></typeparam>
  241. <param name="type">The type.</param>
  242. <param name="parameters">The parameters.</param>
  243. <returns></returns>
  244. </member>
  245. <member name="M:SuperSocket.Common.AssemblyUtil.GetType(System.String,System.Boolean,System.Boolean)">
  246. <summary>
  247. Gets the type by the full name, also return matched generic type without checking generic type parameters in the name.
  248. </summary>
  249. <param name="fullTypeName">Full name of the type.</param>
  250. <param name="throwOnError">if set to <c>true</c> [throw on error].</param>
  251. <param name="ignoreCase">if set to <c>true</c> [ignore case].</param>
  252. <returns></returns>
  253. </member>
  254. <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementTypes``1(System.Reflection.Assembly)">
  255. <summary>
  256. Gets the implement types from assembly.
  257. </summary>
  258. <typeparam name="TBaseType">The type of the base type.</typeparam>
  259. <param name="assembly">The assembly.</param>
  260. <returns></returns>
  261. </member>
  262. <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementedObjectsByInterface``1(System.Reflection.Assembly)">
  263. <summary>
  264. Gets the implemented objects by interface.
  265. </summary>
  266. <typeparam name="TBaseInterface">The type of the base interface.</typeparam>
  267. <param name="assembly">The assembly.</param>
  268. <returns></returns>
  269. </member>
  270. <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementedObjectsByInterface``1(System.Reflection.Assembly,System.Type)">
  271. <summary>
  272. Gets the implemented objects by interface.
  273. </summary>
  274. <typeparam name="TBaseInterface">The type of the base interface.</typeparam>
  275. <param name="assembly">The assembly.</param>
  276. <param name="targetType">Type of the target.</param>
  277. <returns></returns>
  278. </member>
  279. <member name="M:SuperSocket.Common.AssemblyUtil.BinaryClone``1(``0)">
  280. <summary>
  281. Clone object in binary format.
  282. </summary>
  283. <typeparam name="T"></typeparam>
  284. <param name="target">The target.</param>
  285. <returns></returns>
  286. </member>
  287. <member name="M:SuperSocket.Common.AssemblyUtil.CopyPropertiesTo``1(``0,``0)">
  288. <summary>
  289. Copies the properties of one object to another object.
  290. </summary>
  291. <typeparam name="T"></typeparam>
  292. <param name="source">The source.</param>
  293. <param name="target">The target.</param>
  294. <returns></returns>
  295. </member>
  296. <member name="M:SuperSocket.Common.AssemblyUtil.CopyPropertiesTo``1(``0,System.Predicate{System.Reflection.PropertyInfo},``0)">
  297. <summary>
  298. Copies the properties of one object to another object.
  299. </summary>
  300. <typeparam name="T"></typeparam>
  301. <param name="source">The source.</param>
  302. <param name="predict">The properties predict.</param>
  303. <param name="target">The target.</param>
  304. <returns></returns>
  305. </member>
  306. <member name="M:SuperSocket.Common.AssemblyUtil.GetAssembliesFromString(System.String)">
  307. <summary>
  308. Gets the assemblies from string.
  309. </summary>
  310. <param name="assemblyDef">The assembly def.</param>
  311. <returns></returns>
  312. </member>
  313. <member name="M:SuperSocket.Common.AssemblyUtil.GetAssembliesFromStrings(System.String[])">
  314. <summary>
  315. Gets the assemblies from strings.
  316. </summary>
  317. <param name="assemblies">The assemblies.</param>
  318. <returns></returns>
  319. </member>
  320. <member name="T:SuperSocket.Common.BinaryUtil">
  321. <summary>
  322. Binary util class
  323. </summary>
  324. </member>
  325. <member name="M:SuperSocket.Common.BinaryUtil.IndexOf``1(System.Collections.Generic.IList{``0},``0,System.Int32,System.Int32)">
  326. <summary>
  327. Search target from source.
  328. </summary>
  329. <typeparam name="T"></typeparam>
  330. <param name="source">The source.</param>
  331. <param name="target">The target.</param>
  332. <param name="pos">The pos.</param>
  333. <param name="length">The length.</param>
  334. <returns></returns>
  335. </member>
  336. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},``0[],System.Int32@)">
  337. <summary>
  338. Searches the mark from source.
  339. </summary>
  340. <typeparam name="T"></typeparam>
  341. <param name="source">The source.</param>
  342. <param name="mark">The mark.</param>
  343. <param name="parsedLength">Length of the parsed.</param>
  344. <returns></returns>
  345. </member>
  346. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},``0[])">
  347. <summary>
  348. Searches the mark from source.
  349. </summary>
  350. <typeparam name="T"></typeparam>
  351. <param name="source">The source.</param>
  352. <param name="mark">The mark.</param>
  353. <returns></returns>
  354. </member>
  355. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])">
  356. <summary>
  357. Searches the mark from source.
  358. </summary>
  359. <typeparam name="T"></typeparam>
  360. <param name="source">The source.</param>
  361. <param name="offset">The offset.</param>
  362. <param name="length">The length.</param>
  363. <param name="mark">The mark.</param>
  364. <returns></returns>
  365. </member>
  366. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32@)">
  367. <summary>
  368. Searches the mark from source.
  369. </summary>
  370. <typeparam name="T"></typeparam>
  371. <param name="source">The source.</param>
  372. <param name="offset">The offset.</param>
  373. <param name="length">The length.</param>
  374. <param name="mark">The mark.</param>
  375. <param name="parsedLength">Length of the parsed.</param>
  376. <returns></returns>
  377. </member>
  378. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32)">
  379. <summary>
  380. Searches the mark from source.
  381. </summary>
  382. <typeparam name="T"></typeparam>
  383. <param name="source">The source.</param>
  384. <param name="offset">The offset.</param>
  385. <param name="length">The length.</param>
  386. <param name="mark">The mark.</param>
  387. <param name="matched">The matched.</param>
  388. <returns></returns>
  389. </member>
  390. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32,System.Int32@)">
  391. <summary>
  392. Searches the mark from source.
  393. </summary>
  394. <typeparam name="T"></typeparam>
  395. <param name="source">The source.</param>
  396. <param name="offset">The offset.</param>
  397. <param name="length">The length.</param>
  398. <param name="mark">The mark.</param>
  399. <param name="matched">The matched.</param>
  400. <param name="parsedLength">Length of the parsed.</param>
  401. <returns></returns>
  402. </member>
  403. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,SuperSocket.Common.SearchMarkState{``0},System.Int32@)">
  404. <summary>
  405. Searches the mark from source.
  406. </summary>
  407. <typeparam name="T"></typeparam>
  408. <param name="source">The source.</param>
  409. <param name="offset">The offset.</param>
  410. <param name="length">The length.</param>
  411. <param name="searchState">State of the search.</param>
  412. <param name="parsedLength">Length of the parsed.</param>
  413. <returns></returns>
  414. </member>
  415. <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,SuperSocket.Common.SearchMarkState{``0})">
  416. <summary>
  417. Searches the mark from source.
  418. </summary>
  419. <typeparam name="T"></typeparam>
  420. <param name="source">The source.</param>
  421. <param name="offset">The offset.</param>
  422. <param name="length">The length.</param>
  423. <param name="searchState">State of the search.</param>
  424. <returns></returns>
  425. </member>
  426. <member name="M:SuperSocket.Common.BinaryUtil.StartsWith``1(System.Collections.Generic.IList{``0},``0[])">
  427. <summary>
  428. Startses the with.
  429. </summary>
  430. <typeparam name="T"></typeparam>
  431. <param name="source">The source.</param>
  432. <param name="mark">The mark.</param>
  433. <returns></returns>
  434. </member>
  435. <member name="M:SuperSocket.Common.BinaryUtil.StartsWith``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])">
  436. <summary>
  437. Startses the with.
  438. </summary>
  439. <typeparam name="T"></typeparam>
  440. <param name="source">The source.</param>
  441. <param name="offset">The offset.</param>
  442. <param name="length">The length.</param>
  443. <param name="mark">The mark.</param>
  444. <returns></returns>
  445. </member>
  446. <member name="M:SuperSocket.Common.BinaryUtil.EndsWith``1(System.Collections.Generic.IList{``0},``0[])">
  447. <summary>
  448. Endses the with.
  449. </summary>
  450. <typeparam name="T"></typeparam>
  451. <param name="source">The source.</param>
  452. <param name="mark">The mark.</param>
  453. <returns></returns>
  454. </member>
  455. <member name="M:SuperSocket.Common.BinaryUtil.EndsWith``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])">
  456. <summary>
  457. Endses the with.
  458. </summary>
  459. <typeparam name="T"></typeparam>
  460. <param name="source">The source.</param>
  461. <param name="offset">The offset.</param>
  462. <param name="length">The length.</param>
  463. <param name="mark">The mark.</param>
  464. <returns></returns>
  465. </member>
  466. <member name="M:SuperSocket.Common.BinaryUtil.CloneRange``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32)">
  467. <summary>
  468. Clones the elements in the specific range.
  469. </summary>
  470. <typeparam name="T"></typeparam>
  471. <param name="source">The source.</param>
  472. <param name="offset">The offset.</param>
  473. <param name="length">The length.</param>
  474. <returns></returns>
  475. </member>
  476. <member name="T:SuperSocket.Common.BufferManager">
  477. <summary>
  478. This class creates a single large buffer which can be divided up and assigned to SocketAsyncEventArgs objects for use
  479. with each socket I/O operation. This enables bufffers to be easily reused and gaurds against fragmenting heap memory.
  480. The operations exposed on the BufferManager class are not thread safe.
  481. </summary>
  482. </member>
  483. <member name="M:SuperSocket.Common.BufferManager.#ctor(System.Int32,System.Int32)">
  484. <summary>
  485. Initializes a new instance of the <see cref="T:SuperSocket.Common.BufferManager"/> class.
  486. </summary>
  487. <param name="totalBytes">The total bytes.</param>
  488. <param name="bufferSize">Size of the buffer.</param>
  489. </member>
  490. <member name="M:SuperSocket.Common.BufferManager.InitBuffer">
  491. <summary>
  492. Allocates buffer space used by the buffer pool
  493. </summary>
  494. </member>
  495. <member name="M:SuperSocket.Common.BufferManager.SetBuffer(System.Net.Sockets.SocketAsyncEventArgs)">
  496. <summary>
  497. Assigns a buffer from the buffer pool to the specified SocketAsyncEventArgs object
  498. </summary>
  499. <returns>true if the buffer was successfully set, else false</returns>
  500. </member>
  501. <member name="M:SuperSocket.Common.BufferManager.FreeBuffer(System.Net.Sockets.SocketAsyncEventArgs)">
  502. <summary>
  503. Removes the buffer from a SocketAsyncEventArg object. This frees the buffer back to the
  504. buffer pool
  505. </summary>
  506. </member>
  507. <member name="T:SuperSocket.Common.ConfigurationElementBase">
  508. <summary>
  509. ConfigurationElementBase
  510. </summary>
  511. </member>
  512. <member name="M:SuperSocket.Common.ConfigurationElementBase.#ctor">
  513. <summary>
  514. Initializes a new instance of the <see cref="T:SuperSocket.Common.ConfigurationElementBase"/> class.
  515. </summary>
  516. </member>
  517. <member name="M:SuperSocket.Common.ConfigurationElementBase.#ctor(System.Boolean)">
  518. <summary>
  519. Initializes a new instance of the <see cref="T:SuperSocket.Common.ConfigurationElementBase"/> class.
  520. </summary>
  521. <param name="nameRequired">if set to <c>true</c> [name required].</param>
  522. </member>
  523. <member name="P:SuperSocket.Common.ConfigurationElementBase.Name">
  524. <summary>
  525. Gets the name.
  526. </summary>
  527. </member>
  528. <member name="M:SuperSocket.Common.ConfigurationElementBase.DeserializeElement(System.Xml.XmlReader,System.Boolean)">
  529. <summary>
  530. Reads XML from the configuration file.
  531. </summary>
  532. <param name="reader">The <see cref="T:System.Xml.XmlReader"/> that reads from the configuration file.</param>
  533. <param name="serializeCollectionKey">true to serialize only the collection key properties; otherwise, false.</param>
  534. <exception cref="T:System.Configuration.ConfigurationErrorsException">The element to read is locked.- or -An attribute of the current node is not recognized.- or -The lock status of the current node cannot be determined. </exception>
  535. </member>
  536. <member name="P:SuperSocket.Common.ConfigurationElementBase.Options">
  537. <summary>
  538. Gets the options.
  539. </summary>
  540. </member>
  541. <member name="M:SuperSocket.Common.ConfigurationElementBase.OnDeserializeUnrecognizedAttribute(System.String,System.String)">
  542. <summary>
  543. Gets a value indicating whether an unknown attribute is encountered during deserialization.
  544. </summary>
  545. <param name="name">The name of the unrecognized attribute.</param>
  546. <param name="value">The value of the unrecognized attribute.</param>
  547. <returns>
  548. true when an unknown attribute is encountered while deserializing; otherwise, false.
  549. </returns>
  550. </member>
  551. <member name="M:SuperSocket.Common.ConfigurationElementBase.Unmerge(System.Configuration.ConfigurationElement,System.Configuration.ConfigurationElement,System.Configuration.ConfigurationSaveMode)">
  552. <summary>
  553. Modifies the <see cref="T:System.Configuration.ConfigurationElement" /> object to remove all values that should not be saved.
  554. </summary>
  555. <param name="sourceElement">A <see cref="T:System.Configuration.ConfigurationElement" /> at the current level containing a merged view of the properties.</param>
  556. <param name="parentElement">The parent <see cref="T:System.Configuration.ConfigurationElement" />, or null if this is the top level.</param>
  557. <param name="saveMode">A <see cref="T:System.Configuration.ConfigurationSaveMode" /> that determines which property values to include.</param>
  558. </member>
  559. <member name="M:SuperSocket.Common.ConfigurationElementBase.SerializeElement(System.Xml.XmlWriter,System.Boolean)">
  560. <summary>
  561. Writes the contents of this configuration element to the configuration file when implemented in a derived class.
  562. </summary>
  563. <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> that writes to the configuration file.</param>
  564. <param name="serializeCollectionKey">true to serialize only the collection key properties; otherwise, false.</param>
  565. <returns>
  566. true if any data was actually serialized; otherwise, false.
  567. </returns>
  568. </member>
  569. <member name="P:SuperSocket.Common.ConfigurationElementBase.OptionElements">
  570. <summary>
  571. Gets the option elements.
  572. </summary>
  573. </member>
  574. <member name="M:SuperSocket.Common.ConfigurationElementBase.OnDeserializeUnrecognizedElement(System.String,System.Xml.XmlReader)">
  575. <summary>
  576. Gets a value indicating whether an unknown element is encountered during deserialization.
  577. </summary>
  578. <param name="elementName">The name of the unknown subelement.</param>
  579. <param name="reader">The <see cref="T:System.Xml.XmlReader"/> being used for deserialization.</param>
  580. <returns>
  581. true when an unknown element is encountered while deserializing; otherwise, false.
  582. </returns>
  583. <exception cref="T:System.Configuration.ConfigurationErrorsException">The element identified by <paramref name="elementName"/> is locked.- or -One or more of the element's attributes is locked.- or -<paramref name="elementName"/> is unrecognized, or the element has an unrecognized attribute.- or -The element has a Boolean attribute with an invalid value.- or -An attempt was made to deserialize a property more than once.- or -An attempt was made to deserialize a property that is not a valid member of the element.- or -The element cannot contain a CDATA or text element.</exception>
  584. </member>
  585. <member name="T:SuperSocket.Common.ConfigurationExtension">
  586. <summary>
  587. Configuration extension class
  588. </summary>
  589. </member>
  590. <member name="M:SuperSocket.Common.ConfigurationExtension.GetValue(System.Collections.Specialized.NameValueCollection,System.String)">
  591. <summary>
  592. Gets the value from namevalue collection by key.
  593. </summary>
  594. <param name="collection">The collection.</param>
  595. <param name="key">The key.</param>
  596. <returns></returns>
  597. </member>
  598. <member name="M:SuperSocket.Common.ConfigurationExtension.GetValue(System.Collections.Specialized.NameValueCollection,System.String,System.String)">
  599. <summary>
  600. Gets the value from namevalue collection by key.
  601. </summary>
  602. <param name="collection">The collection.</param>
  603. <param name="key">The key.</param>
  604. <param name="defaultValue">The default value.</param>
  605. <returns></returns>
  606. </member>
  607. <member name="M:SuperSocket.Common.ConfigurationExtension.Deserialize``1(``0,System.Xml.XmlReader)">
  608. <summary>
  609. Deserializes the specified configuration section.
  610. </summary>
  611. <typeparam name="TElement">The type of the element.</typeparam>
  612. <param name="section">The section.</param>
  613. <param name="reader">The reader.</param>
  614. </member>
  615. <member name="M:SuperSocket.Common.ConfigurationExtension.DeserializeChildConfig``1(System.String)">
  616. <summary>
  617. Deserializes the child configuration.
  618. </summary>
  619. <typeparam name="TConfig">The type of the configuration.</typeparam>
  620. <param name="childConfig">The child configuration string.</param>
  621. <returns></returns>
  622. </member>
  623. <member name="M:SuperSocket.Common.ConfigurationExtension.GetChildConfig``1(System.Collections.Specialized.NameValueCollection,System.String)">
  624. <summary>
  625. Gets the child config.
  626. </summary>
  627. <typeparam name="TConfig">The type of the config.</typeparam>
  628. <param name="childElements">The child elements.</param>
  629. <param name="childConfigName">Name of the child config.</param>
  630. <returns></returns>
  631. </member>
  632. <member name="M:SuperSocket.Common.ConfigurationExtension.GetConfigSource(System.Configuration.ConfigurationElement)">
  633. <summary>
  634. Gets the config source path.
  635. </summary>
  636. <param name="config">The config.</param>
  637. <returns></returns>
  638. </member>
  639. <member name="M:SuperSocket.Common.ConfigurationExtension.LoadFrom(System.Configuration.ConfigurationElement,System.Object)">
  640. <summary>
  641. Loads configuration element's node information from a model.
  642. </summary>
  643. <param name="configElement">The config element.</param>
  644. <param name="source">The source.</param>
  645. <exception cref="T:System.Exception">Cannot find expected property 'Item' from the type 'ConfigurationElement'.</exception>
  646. </member>
  647. <member name="M:SuperSocket.Common.ConfigurationExtension.GetCurrentConfiguration(System.Configuration.ConfigurationElement)">
  648. <summary>
  649. Gets the current configuration of the configuration element.
  650. </summary>
  651. <returns>The current configuration.</returns>
  652. <param name="configElement">Configuration element.</param>
  653. </member>
  654. <member name="M:SuperSocket.Common.ConfigurationExtension.ResetConfiguration(System.AppDomain,System.String)">
  655. <summary>
  656. Reset application's configuration to a another config file
  657. </summary>
  658. <param name="appDomain">the assosiated AppDomain</param>
  659. <param name="configFilePath">the config file path want to reset to</param>
  660. </member>
  661. <member name="T:SuperSocket.Common.DictionaryExtension">
  662. <summary>
  663. Extension class for IDictionary
  664. </summary>
  665. </member>
  666. <member name="M:SuperSocket.Common.DictionaryExtension.GetValue``1(System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object)">
  667. <summary>
  668. Gets the value by key.
  669. </summary>
  670. <typeparam name="T"></typeparam>
  671. <param name="dictionary">The dictionary.</param>
  672. <param name="key">The key.</param>
  673. <returns></returns>
  674. </member>
  675. <member name="M:SuperSocket.Common.DictionaryExtension.GetValue``1(System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object,``0)">
  676. <summary>
  677. Gets the value by key and default value.
  678. </summary>
  679. <typeparam name="T"></typeparam>
  680. <param name="dictionary">The dictionary.</param>
  681. <param name="key">The key.</param>
  682. <param name="defaultValue">The default value.</param>
  683. <returns></returns>
  684. </member>
  685. <member name="T:SuperSocket.Common.ErrorEventArgs">
  686. <summary>
  687. EventArgs for error and exception
  688. </summary>
  689. </member>
  690. <member name="P:SuperSocket.Common.ErrorEventArgs.Exception">
  691. <summary>
  692. Gets the exception.
  693. </summary>
  694. </member>
  695. <member name="M:SuperSocket.Common.ErrorEventArgs.#ctor(System.String)">
  696. <summary>
  697. Initializes a new instance of the <see cref="T:SuperSocket.Common.ErrorEventArgs"/> class.
  698. </summary>
  699. <param name="message">The message.</param>
  700. </member>
  701. <member name="M:SuperSocket.Common.ErrorEventArgs.#ctor(System.Exception)">
  702. <summary>
  703. Initializes a new instance of the <see cref="T:SuperSocket.Common.ErrorEventArgs"/> class.
  704. </summary>
  705. <param name="exception">The exception.</param>
  706. </member>
  707. <member name="T:SuperSocket.Common.GenericConfigurationElementCollectionBase`2">
  708. <summary>
  709. GenericConfigurationElementCollectionBase
  710. </summary>
  711. <typeparam name="TConfigElement">The type of the config element.</typeparam>
  712. <typeparam name="TConfigInterface">The type of the config interface.</typeparam>
  713. </member>
  714. <member name="P:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.Item(System.Int32)">
  715. <summary>
  716. Gets or sets a property, attribute, or child element of this configuration element.
  717. </summary>
  718. <returns>The specified property, attribute, or child element</returns>
  719. </member>
  720. <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.CreateNewElement">
  721. <summary>
  722. When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>.
  723. </summary>
  724. <returns>
  725. A new <see cref="T:System.Configuration.ConfigurationElement"/>.
  726. </returns>
  727. </member>
  728. <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.GetElementKey(System.Configuration.ConfigurationElement)">
  729. <summary>
  730. Gets the element key for a specified configuration element when overridden in a derived class.
  731. </summary>
  732. <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param>
  733. <returns>
  734. An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>.
  735. </returns>
  736. </member>
  737. <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.GetEnumerator">
  738. <summary>
  739. Returns an enumerator that iterates through the collection.
  740. </summary>
  741. <returns>
  742. A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
  743. </returns>
  744. </member>
  745. <member name="T:SuperSocket.Common.GenericConfigurationElementCollection`2">
  746. <summary>
  747. GenericConfigurationElementCollection
  748. </summary>
  749. <typeparam name="TConfigElement">The type of the config element.</typeparam>
  750. <typeparam name="TConfigInterface">The type of the config interface.</typeparam>
  751. </member>
  752. <member name="M:SuperSocket.Common.GenericConfigurationElementCollection`2.GetElementKey(System.Configuration.ConfigurationElement)">
  753. <summary>
  754. Gets the element key.
  755. </summary>
  756. <param name="element">The element.</param>
  757. <returns></returns>
  758. </member>
  759. <member name="T:SuperSocket.Common.Platform">
  760. <summary>
  761. This class is designed for detect platform attribute in runtime
  762. </summary>
  763. </member>
  764. <member name="P:SuperSocket.Common.Platform.SupportSocketIOControlByCodeEnum">
  765. <summary>
  766. Gets a value indicating whether [support socket IO control by code enum].
  767. </summary>
  768. <value>
  769. <c>true</c> if [support socket IO control by code enum]; otherwise, <c>false</c>.
  770. </value>
  771. </member>
  772. <member name="P:SuperSocket.Common.Platform.IsMono">
  773. <summary>
  774. Gets a value indicating whether this instance is mono.
  775. </summary>
  776. <value>
  777. <c>true</c> if this instance is mono; otherwise, <c>false</c>.
  778. </value>
  779. </member>
  780. <member name="T:SuperSocket.Common.SearchMarkState`1">
  781. <summary>
  782. SearchMarkState
  783. </summary>
  784. <typeparam name="T"></typeparam>
  785. </member>
  786. <member name="M:SuperSocket.Common.SearchMarkState`1.#ctor(`0[])">
  787. <summary>
  788. Initializes a new instance of the <see cref="T:SuperSocket.Common.SearchMarkState`1"/> class.
  789. </summary>
  790. <param name="mark">The mark.</param>
  791. </member>
  792. <member name="P:SuperSocket.Common.SearchMarkState`1.Mark">
  793. <summary>
  794. Gets the mark.
  795. </summary>
  796. </member>
  797. <member name="P:SuperSocket.Common.SearchMarkState`1.Matched">
  798. <summary>
  799. Gets or sets whether matched already.
  800. </summary>
  801. <value>
  802. The matched.
  803. </value>
  804. </member>
  805. <member name="T:SuperSocket.Common.SendingQueue">
  806. <summary>
  807. SendingQueue
  808. </summary>
  809. </member>
  810. <member name="P:SuperSocket.Common.SendingQueue.TrackID">
  811. <summary>
  812. Gets the track ID.
  813. </summary>
  814. <value>
  815. The track ID.
  816. </value>
  817. </member>
  818. <member name="M:SuperSocket.Common.SendingQueue.#ctor(System.ArraySegment{System.Byte}[],System.Int32,System.Int32)">
  819. <summary>
  820. Initializes a new instance of the <see cref="T:SuperSocket.Common.SendingQueue" /> class.
  821. </summary>
  822. <param name="globalQueue">The global queue.</param>
  823. <param name="offset">The offset.</param>
  824. <param name="capacity">The capacity.</param>
  825. </member>
  826. <member name="M:SuperSocket.Common.SendingQueue.Enqueue(System.ArraySegment{System.Byte},System.UInt16)">
  827. <summary>
  828. Enqueues the specified item.
  829. </summary>
  830. <param name="item">The item.</param>
  831. <param name="trackID">The track ID.</param>
  832. <returns></returns>
  833. </member>
  834. <member name="M:SuperSocket.Common.SendingQueue.Enqueue(System.Collections.Generic.IList{System.ArraySegment{System.Byte}},System.UInt16)">
  835. <summary>
  836. Enqueues the specified items.
  837. </summary>
  838. <param name="items">The items.</param>
  839. <param name="trackID">The track ID.</param>
  840. <returns></returns>
  841. </member>
  842. <member name="M:SuperSocket.Common.SendingQueue.StopEnqueue">
  843. <summary>
  844. Stops the enqueue, and then wait all current excueting enqueu threads exit.
  845. </summary>
  846. </member>
  847. <member name="M:SuperSocket.Common.SendingQueue.StartEnqueue">
  848. <summary>
  849. Starts to allow enqueue.
  850. </summary>
  851. </member>
  852. <member name="P:SuperSocket.Common.SendingQueue.GlobalQueue">
  853. <summary>
  854. Gets the global queue.
  855. </summary>
  856. <value>
  857. The global queue.
  858. </value>
  859. </member>
  860. <member name="P:SuperSocket.Common.SendingQueue.Offset">
  861. <summary>
  862. Gets the offset.
  863. </summary>
  864. <value>
  865. The offset.
  866. </value>
  867. </member>
  868. <member name="P:SuperSocket.Common.SendingQueue.Capacity">
  869. <summary>
  870. Gets the capacity.
  871. </summary>
  872. <value>
  873. The capacity.
  874. </value>
  875. </member>
  876. <member name="P:SuperSocket.Common.SendingQueue.Count">
  877. <summary>
  878. Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.
  879. </summary>
  880. <returns>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
  881. </member>
  882. <member name="P:SuperSocket.Common.SendingQueue.Position">
  883. <summary>
  884. Gets or sets the position.
  885. </summary>
  886. <value>
  887. The position.
  888. </value>
  889. </member>
  890. <member name="M:SuperSocket.Common.SendingQueue.IndexOf(System.ArraySegment{System.Byte})">
  891. <summary>
  892. Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1" />.
  893. </summary>
  894. <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.</param>
  895. <returns>
  896. The index of <paramref name="item" /> if found in the list; otherwise, -1.
  897. </returns>
  898. <exception cref="T:System.NotSupportedException"></exception>
  899. </member>
  900. <member name="M:SuperSocket.Common.SendingQueue.Insert(System.Int32,System.ArraySegment{System.Byte})">
  901. <summary>
  902. Inserts an item to the <see cref="T:System.Collections.Generic.IList`1" /> at the specified index.
  903. </summary>
  904. <param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param>
  905. <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.</param>
  906. <exception cref="T:System.NotSupportedException"></exception>
  907. </member>
  908. <member name="M:SuperSocket.Common.SendingQueue.RemoveAt(System.Int32)">
  909. <summary>
  910. Removes the <see cref="T:System.Collections.Generic.IList`1" /> item at the specified index.
  911. </summary>
  912. <param name="index">The zero-based index of the item to remove.</param>
  913. <exception cref="T:System.NotSupportedException"></exception>
  914. </member>
  915. <member name="P:SuperSocket.Common.SendingQueue.Item(System.Int32)">
  916. <summary>
  917. Gets or sets the element at the specified index.
  918. </summary>
  919. <param name="index">The index.</param>
  920. <returns></returns>
  921. <exception cref="T:System.NotSupportedException"></exception>
  922. </member>
  923. <member name="M:SuperSocket.Common.SendingQueue.Add(System.ArraySegment{System.Byte})">
  924. <summary>
  925. Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.
  926. </summary>
  927. <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
  928. <exception cref="T:System.NotSupportedException"></exception>
  929. </member>
  930. <member name="M:SuperSocket.Common.SendingQueue.Clear">
  931. <summary>
  932. Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.
  933. </summary>
  934. <exception cref="T:System.NotSupportedException"></exception>
  935. </member>
  936. <member name="M:SuperSocket.Common.SendingQueue.Contains(System.ArraySegment{System.Byte})">
  937. <summary>
  938. Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.
  939. </summary>
  940. <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
  941. <returns>
  942. true if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, false.
  943. </returns>
  944. <exception cref="T:System.NotSupportedException"></exception>
  945. </member>
  946. <member name="M:SuperSocket.Common.SendingQueue.CopyTo(System.ArraySegment{System.Byte}[],System.Int32)">
  947. <summary>
  948. Copies to.
  949. </summary>
  950. <param name="array">The array.</param>
  951. <param name="arrayIndex">Index of the array.</param>
  952. </member>
  953. <member name="P:SuperSocket.Common.SendingQueue.IsReadOnly">
  954. <summary>
  955. Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.
  956. </summary>
  957. <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, false.</returns>
  958. </member>
  959. <member name="M:SuperSocket.Common.SendingQueue.Remove(System.ArraySegment{System.Byte})">
  960. <summary>
  961. Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.
  962. </summary>
  963. <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
  964. <returns>
  965. true if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, false. This method also returns false if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.
  966. </returns>
  967. <exception cref="T:System.NotSupportedException"></exception>
  968. </member>
  969. <member name="M:SuperSocket.Common.SendingQueue.GetEnumerator">
  970. <summary>
  971. Returns an enumerator that iterates through the collection.
  972. </summary>
  973. <returns>
  974. A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
  975. </returns>
  976. <exception cref="T:System.NotSupportedException"></exception>
  977. </member>
  978. <member name="M:SuperSocket.Common.SendingQueue.System#Collections#IEnumerable#GetEnumerator">
  979. <summary>
  980. Returns an enumerator that iterates through a collection.
  981. </summary>
  982. <returns>
  983. An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.
  984. </returns>
  985. <exception cref="T:System.NotSupportedException"></exception>
  986. </member>
  987. <member name="M:SuperSocket.Common.SendingQueue.InternalTrim(System.Int32)">
  988. <summary>
  989. Trim the internal segments at the begining by the binary data size.
  990. </summary>
  991. <param name="offset">The binary data size should be trimed at the begining.</param>
  992. </member>
  993. <member name="T:SuperSocket.Common.SendingQueueSourceCreator">
  994. <summary>
  995. SendingQueueSourceCreator
  996. </summary>
  997. </member>
  998. <member name="M:SuperSocket.Common.SendingQueueSourceCreator.#ctor(System.Int32)">
  999. <summary>
  1000. Initializes a new instance of the <see cref="T:SuperSocket.Common.SendingQueueSourceCreator" /> class.
  1001. </summary>
  1002. <param name="sendingQueueSize">Size of the sending queue.</param>
  1003. </member>
  1004. <member name="M:SuperSocket.Common.SendingQueueSourceCreator.Create(System.Int32,SuperSocket.Common.SendingQueue[]@)">
  1005. <summary>
  1006. Creates the specified size.
  1007. </summary>
  1008. <param name="size">The size.</param>
  1009. <param name="poolItems">The pool items.</param>
  1010. <returns></returns>
  1011. </member>
  1012. <member name="T:SuperSocket.Common.IPoolInfo">
  1013. <summary>
  1014. The pool information class
  1015. </summary>
  1016. </member>
  1017. <member name="P:SuperSocket.Common.IPoolInfo.MinPoolSize">
  1018. <summary>
  1019. Gets the min size of the pool.
  1020. </summary>
  1021. <value>
  1022. The min size of the pool.
  1023. </value>
  1024. </member>
  1025. <member name="P:SuperSocket.Common.IPoolInfo.MaxPoolSize">
  1026. <summary>
  1027. Gets the max size of the pool.
  1028. </summary>
  1029. <value>
  1030. The max size of the pool.
  1031. </value>
  1032. </member>
  1033. <member name="P:SuperSocket.Common.IPoolInfo.AvialableItemsCount">
  1034. <summary>
  1035. Gets the avialable items count.
  1036. </summary>
  1037. <value>
  1038. The avialable items count.
  1039. </value>
  1040. </member>
  1041. <member name="P:SuperSocket.Common.IPoolInfo.TotalItemsCount">
  1042. <summary>
  1043. Gets the total items count, include items in the pool and outside the pool.
  1044. </summary>
  1045. <value>
  1046. The total items count.
  1047. </value>
  1048. </member>
  1049. <member name="T:SuperSocket.Common.ISmartPool`1">
  1050. <summary>
  1051. The basic interface of smart pool
  1052. </summary>
  1053. <typeparam name="T"></typeparam>
  1054. </member>
  1055. <member name="M:SuperSocket.Common.ISmartPool`1.Initialize(System.Int32,System.Int32,SuperSocket.Common.ISmartPoolSourceCreator{`0})">
  1056. <summary>
  1057. Initializes the specified min pool size.
  1058. </summary>
  1059. <param name="minPoolSize">The min size of the pool.</param>
  1060. <param name="maxPoolSize">The max size of the pool.</param>
  1061. <param name="sourceCreator">The source creator.</param>
  1062. <returns></returns>
  1063. </member>
  1064. <member name="M:SuperSocket.Common.ISmartPool`1.Push(`0)">
  1065. <summary>
  1066. Pushes the specified item into the pool.
  1067. </summary>
  1068. <param name="item">The item.</param>
  1069. </member>
  1070. <member name="M:SuperSocket.Common.ISmartPool`1.TryGet(`0@)">
  1071. <summary>
  1072. Tries to get one item from the pool.
  1073. </summary>
  1074. <param name="item">The item.</param>
  1075. <returns></returns>
  1076. </member>
  1077. <member name="T:SuperSocket.Common.ISmartPoolSource">
  1078. <summary>
  1079. ISmartPoolSource
  1080. </summary>
  1081. </member>
  1082. <member name="P:SuperSocket.Common.ISmartPoolSource.Count">
  1083. <summary>
  1084. Gets the count.
  1085. </summary>
  1086. <value>
  1087. The count.
  1088. </value>
  1089. </member>
  1090. <member name="T:SuperSocket.Common.SmartPoolSource">
  1091. <summary>
  1092. SmartPoolSource
  1093. </summary>
  1094. </member>
  1095. <member name="M:SuperSocket.Common.SmartPoolSource.#ctor(System.Object,System.Int32)">
  1096. <summary>
  1097. Initializes a new instance of the <see cref="T:SuperSocket.Common.SmartPoolSource" /> class.
  1098. </summary>
  1099. <param name="source">The source.</param>
  1100. <param name="itemsCount">The items count.</param>
  1101. </member>
  1102. <member name="P:SuperSocket.Common.SmartPoolSource.Source">
  1103. <summary>
  1104. Gets the source.
  1105. </summary>
  1106. <value>
  1107. The source.
  1108. </value>
  1109. </member>
  1110. <member name="P:SuperSocket.Common.SmartPoolSource.Count">
  1111. <summary>
  1112. Gets the count.
  1113. </summary>
  1114. <value>
  1115. The count.
  1116. </value>
  1117. </member>
  1118. <member name="T:SuperSocket.Common.ISmartPoolSourceCreator`1">
  1119. <summary>
  1120. ISmartPoolSourceCreator
  1121. </summary>
  1122. <typeparam name="T"></typeparam>
  1123. </member>
  1124. <member name="M:SuperSocket.Common.ISmartPoolSourceCreator`1.Create(System.Int32,`0[]@)">
  1125. <summary>
  1126. Creates the specified size.
  1127. </summary>
  1128. <param name="size">The size.</param>
  1129. <param name="poolItems">The pool items.</param>
  1130. <returns></returns>
  1131. </member>
  1132. <member name="T:SuperSocket.Common.SmartPool`1">
  1133. <summary>
  1134. The smart pool
  1135. </summary>
  1136. <typeparam name="T"></typeparam>
  1137. </member>
  1138. <member name="P:SuperSocket.Common.SmartPool`1.MinPoolSize">
  1139. <summary>
  1140. Gets the size of the min pool.
  1141. </summary>
  1142. <value>
  1143. The size of the min pool.
  1144. </value>
  1145. </member>
  1146. <member name="P:SuperSocket.Common.SmartPool`1.MaxPoolSize">
  1147. <summary>
  1148. Gets the size of the max pool.
  1149. </summary>
  1150. <value>
  1151. The size of the max pool.
  1152. </value>
  1153. </member>
  1154. <member name="P:SuperSocket.Common.SmartPool`1.AvialableItemsCount">
  1155. <summary>
  1156. Gets the avialable items count.
  1157. </summary>
  1158. <value>
  1159. The avialable items count.
  1160. </value>
  1161. </member>
  1162. <member name="P:SuperSocket.Common.SmartPool`1.TotalItemsCount">
  1163. <summary>
  1164. Gets the total items count, include items in the pool and outside the pool.
  1165. </summary>
  1166. <value>
  1167. The total items count.
  1168. </value>
  1169. </member>
  1170. <member name="M:SuperSocket.Common.SmartPool`1.Initialize(System.Int32,System.Int32,SuperSocket.Common.ISmartPoolSourceCreator{`0})">
  1171. <summary>
  1172. Initializes the specified min and max pool size.
  1173. </summary>
  1174. <param name="minPoolSize">The min size of the pool.</param>
  1175. <param name="maxPoolSize">The max size of the pool.</param>
  1176. <param name="sourceCreator">The source creator.</param>
  1177. </member>
  1178. <member name="M:SuperSocket.Common.SmartPool`1.Push(`0)">
  1179. <summary>
  1180. Pushes the specified item into the pool.
  1181. </summary>
  1182. <param name="item">The item.</param>
  1183. </member>
  1184. <member name="M:SuperSocket.Common.SmartPool`1.TryGet(`0@)">
  1185. <summary>
  1186. Tries to get one item from the pool.
  1187. </summary>
  1188. <param name="item">The item.</param>
  1189. <returns></returns>
  1190. <exception cref="T:System.NotImplementedException"></exception>
  1191. </member>
  1192. <member name="T:SuperSocket.Common.SocketEx">
  1193. <summary>
  1194. Socket extension class
  1195. </summary>
  1196. </member>
  1197. <member name="M:SuperSocket.Common.SocketEx.SafeClose(System.Net.Sockets.Socket)">
  1198. <summary>
  1199. Close the socket safely.
  1200. </summary>
  1201. <param name="socket">The socket.</param>
  1202. </member>
  1203. <member name="M:SuperSocket.Common.SocketEx.SendData(System.Net.Sockets.Socket,System.Byte[])">
  1204. <summary>
  1205. Sends the data.
  1206. </summary>
  1207. <param name="client">The client.</param>
  1208. <param name="data">The data.</param>
  1209. </member>
  1210. <member name="M:SuperSocket.Common.SocketEx.SendData(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32)">
  1211. <summary>
  1212. Sends the data.
  1213. </summary>
  1214. <param name="client">The client.</param>
  1215. <param name="data">The data.</param>
  1216. <param name="offset">The offset.</param>
  1217. <param name="length">The length.</param>
  1218. </member>
  1219. <member name="T:SuperSocket.Common.StringExtension">
  1220. <summary>
  1221. String extension class
  1222. </summary>
  1223. <summary>
  1224. String extension
  1225. </summary>
  1226. </member>
  1227. <member name="M:SuperSocket.Common.StringExtension.ToInt32(System.String)">
  1228. <summary>
  1229. Convert string to int32.
  1230. </summary>
  1231. <param name="source">The source.</param>
  1232. <returns></returns>
  1233. </member>
  1234. <member name="M:SuperSocket.Common.StringExtension.ToInt32(System.String,System.Int32)">
  1235. <summary>
  1236. Convert string to int32.
  1237. </summary>
  1238. <param name="source">The source.</param>
  1239. <param name="defaultValue">The default value.</param>
  1240. <returns></returns>
  1241. </member>
  1242. <member name="M:SuperSocket.Common.StringExtension.ToLong(System.String)">
  1243. <summary>
  1244. Convert string to long.
  1245. </summary>
  1246. <param name="source">The source.</param>
  1247. <returns></returns>
  1248. </member>
  1249. <member name="M:SuperSocket.Common.StringExtension.ToLong(System.String,System.Int64)">
  1250. <summary>
  1251. Convert string to long.
  1252. </summary>
  1253. <param name="source">The source.</param>
  1254. <param name="defaultValue">The default value.</param>
  1255. <returns></returns>
  1256. </member>
  1257. <member name="M:SuperSocket.Common.StringExtension.ToShort(System.String)">
  1258. <summary>
  1259. Convert string to short.
  1260. </summary>
  1261. <param name="source">The source.</param>
  1262. <returns></returns>
  1263. </member>
  1264. <member name="M:SuperSocket.Common.StringExtension.ToShort(System.String,System.Int16)">
  1265. <summary>
  1266. Convert string to short.
  1267. </summary>
  1268. <param name="source">The source.</param>
  1269. <param name="defaultValue">The default value.</param>
  1270. <returns></returns>
  1271. </member>
  1272. <member name="M:SuperSocket.Common.StringExtension.ToDecimal(System.String)">
  1273. <summary>
  1274. Convert string to decimal.
  1275. </summary>
  1276. <param name="source">The source.</param>
  1277. <returns></returns>
  1278. </member>
  1279. <member name="M:SuperSocket.Common.StringExtension.ToDecimal(System.String,System.Decimal)">
  1280. <summary>
  1281. Convert string to decimal.
  1282. </summary>
  1283. <param name="source">The source.</param>
  1284. <param name="defaultValue">The default value.</param>
  1285. <returns></returns>
  1286. </member>
  1287. <member name="M:SuperSocket.Common.StringExtension.ToDateTime(System.String)">
  1288. <summary>
  1289. Convert string to date time.
  1290. </summary>
  1291. <param name="source">The source.</param>
  1292. <returns></returns>
  1293. </member>
  1294. <member name="M:SuperSocket.Common.StringExtension.ToDateTime(System.String,System.DateTime)">
  1295. <summary>
  1296. Convert string to date time.
  1297. </summary>
  1298. <param name="source">The source.</param>
  1299. <param name="defaultValue">The default value.</param>
  1300. <returns></returns>
  1301. </member>
  1302. <member name="M:SuperSocket.Common.StringExtension.ToBoolean(System.String)">
  1303. <summary>
  1304. Convert string to boolean.
  1305. </summary>
  1306. <param name="source">The source.</param>
  1307. <returns></returns>
  1308. </member>
  1309. <member name="M:SuperSocket.Common.StringExtension.ToBoolean(System.String,System.Boolean)">
  1310. <summary>
  1311. Convert string tp boolean.
  1312. </summary>
  1313. <param name="source">The source.</param>
  1314. <param name="defaultValue">if set to <c>true</c> [default value].</param>
  1315. <returns></returns>
  1316. </member>
  1317. <member name="M:SuperSocket.Common.StringExtension.TryParseEnum``1(System.String,System.Boolean,``0@)">
  1318. <summary>
  1319. Tries parse string to enum.
  1320. </summary>
  1321. <typeparam name="T">the enum type</typeparam>
  1322. <param name="value">The value.</param>
  1323. <param name="ignoreCase">if set to <c>true</c> [ignore case].</param>
  1324. <param name="enumValue">The enum value.</param>
  1325. <returns></returns>
  1326. </member>
  1327. <member name="T:SuperSocket.Common.TheadPoolEx">
  1328. <summary>
  1329. Thread pool extension class
  1330. </summary>
  1331. </member>
  1332. <member name="M:SuperSocket.Common.TheadPoolEx.ResetThreadPool(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})">
  1333. <summary>
  1334. Resets the thread pool.
  1335. </summary>
  1336. <param name="maxWorkingThreads">The max working threads.</param>
  1337. <param name="maxCompletionPortThreads">The max completion port threads.</param>
  1338. <param name="minWorkingThreads">The min working threads.</param>
  1339. <param name="minCompletionPortThreads">The min completion port threads.</param>
  1340. <returns></returns>
  1341. </member>
  1342. </members>
  1343. </doc>