SuperSocket.SocketEngine.xml 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperSocket.SocketEngine</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperSocket.SocketEngine.AppDomainAppServer">
  8. <summary>
  9. AppDomainAppServer
  10. </summary>
  11. </member>
  12. <member name="M:SuperSocket.SocketEngine.AppDomainAppServer.#ctor(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])">
  13. <summary>
  14. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainAppServer" /> class.
  15. </summary>
  16. <param name="serverTypeName">Name of the server type.</param>
  17. <param name="serverStatusMetadata">The server status metadata.</param>
  18. </member>
  19. <member name="M:SuperSocket.SocketEngine.AppDomainAppServer.Start">
  20. <summary>
  21. Starts this server instance.
  22. </summary>
  23. <returns>
  24. return true if start successfull, else false
  25. </returns>
  26. </member>
  27. <member name="T:SuperSocket.SocketEngine.AppDomainBootstrap">
  28. <summary>
  29. AppDomainBootstrap
  30. </summary>
  31. </member>
  32. <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.AppServers">
  33. <summary>
  34. Gets all the app servers running in this bootstrap
  35. </summary>
  36. </member>
  37. <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.Config">
  38. <summary>
  39. Gets the config.
  40. </summary>
  41. </member>
  42. <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.SuperSocket#SocketBase#ILoggerProvider#Logger">
  43. <summary>
  44. Gets the bootstrap logger.
  45. </summary>
  46. </member>
  47. <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.StartupConfigFile">
  48. <summary>
  49. Gets the startup config file.
  50. </summary>
  51. </member>
  52. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)">
  53. <summary>
  54. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainBootstrap"/> class.
  55. </summary>
  56. </member>
  57. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize">
  58. <summary>
  59. Initializes the bootstrap with the configuration
  60. </summary>
  61. <returns></returns>
  62. </member>
  63. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})">
  64. <summary>
  65. Initializes the bootstrap with the configuration and config resolver.
  66. </summary>
  67. <param name="serverConfigResolver">The server config resolver.</param>
  68. <returns></returns>
  69. </member>
  70. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)">
  71. <summary>
  72. Initializes the bootstrap with the configuration and config resolver.
  73. </summary>
  74. <param name="logFactory">The log factory.</param>
  75. <returns></returns>
  76. </member>
  77. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})">
  78. <summary>
  79. Initializes the bootstrap with a listen endpoint replacement dictionary
  80. </summary>
  81. <param name="listenEndPointReplacement">The listen end point replacement.</param>
  82. <returns></returns>
  83. </member>
  84. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)">
  85. <summary>
  86. Initializes the bootstrap with the configuration
  87. </summary>
  88. <param name="serverConfigResolver">The server config resolver.</param>
  89. <param name="logFactory">The log factory.</param>
  90. <returns></returns>
  91. </member>
  92. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Start">
  93. <summary>
  94. Starts this bootstrap.
  95. </summary>
  96. <returns></returns>
  97. </member>
  98. <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Stop">
  99. <summary>
  100. Stops this bootstrap.
  101. </summary>
  102. </member>
  103. <member name="T:SuperSocket.SocketEngine.AssemblyImport">
  104. <summary>
  105. AssemblyImport, used for importing assembly to the current AppDomain
  106. </summary>
  107. </member>
  108. <member name="M:SuperSocket.SocketEngine.AssemblyImport.#ctor(System.String)">
  109. <summary>
  110. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AssemblyImport"/> class.
  111. </summary>
  112. </member>
  113. <member name="T:SuperSocket.SocketEngine.BootstrapFactory">
  114. <summary>
  115. Bootstrap Factory
  116. </summary>
  117. </member>
  118. <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap(SuperSocket.SocketBase.Config.IConfigurationSource)">
  119. <summary>
  120. Creates the bootstrap.
  121. </summary>
  122. <param name="config">The config.</param>
  123. <returns></returns>
  124. </member>
  125. <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap">
  126. <summary>
  127. Creates the bootstrap from app configuration's socketServer section.
  128. </summary>
  129. <returns></returns>
  130. </member>
  131. <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap(System.String)">
  132. <summary>
  133. Creates the bootstrap.
  134. </summary>
  135. <param name="configSectionName">Name of the config section.</param>
  136. <returns></returns>
  137. </member>
  138. <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrapFromConfigFile(System.String)">
  139. <summary>
  140. Creates the bootstrap from configuration file.
  141. </summary>
  142. <param name="configFile">The configuration file.</param>
  143. <returns></returns>
  144. </member>
  145. <member name="T:SuperSocket.SocketEngine.ConfigurationWatcher">
  146. <summary>
  147. The configuration file watcher, it is used for hot configuration updating
  148. </summary>
  149. </member>
  150. <member name="M:SuperSocket.SocketEngine.ConfigurationWatcher.Watch(System.Configuration.ConfigurationSection,SuperSocket.SocketBase.IBootstrap)">
  151. <summary>
  152. Watches the specified configuration section.
  153. </summary>
  154. <param name="configSection">The configuration section.</param>
  155. <param name="bootstrap">The bootstrap.</param>
  156. </member>
  157. <member name="T:SuperSocket.SocketEngine.Configuration.CommandAssembly">
  158. <summary>
  159. Command assembly configuration element
  160. </summary>
  161. </member>
  162. <member name="P:SuperSocket.SocketEngine.Configuration.CommandAssembly.Assembly">
  163. <summary>
  164. Gets the assembly name.
  165. </summary>
  166. <value>
  167. The assembly.
  168. </value>
  169. </member>
  170. <member name="T:SuperSocket.SocketEngine.Configuration.CommandAssemblyCollection">
  171. <summary>
  172. Command assembly configuation collection
  173. </summary>
  174. </member>
  175. <member name="T:SuperSocket.SocketEngine.Configuration.Server">
  176. <summary>
  177. Server, the port which is compatible with .Net 4.5 or higher
  178. </summary>
  179. <summary>
  180. Server configuration
  181. </summary>
  182. </member>
  183. <member name="P:SuperSocket.SocketEngine.Configuration.Server.DefaultCulture">
  184. <summary>
  185. Gets/sets the default culture for this server.
  186. </summary>
  187. <value>
  188. The default culture.
  189. </value>
  190. </member>
  191. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ServerTypeName">
  192. <summary>
  193. Gets the name of the server type this appServer want to use.
  194. </summary>
  195. <value>
  196. The name of the server type.
  197. </value>
  198. </member>
  199. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ServerType">
  200. <summary>
  201. Gets the type definition of the appserver.
  202. </summary>
  203. <value>
  204. The type of the server.
  205. </value>
  206. </member>
  207. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ReceiveFilterFactory">
  208. <summary>
  209. Gets the Receive filter factory.
  210. </summary>
  211. </member>
  212. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Ip">
  213. <summary>
  214. Gets the ip.
  215. </summary>
  216. </member>
  217. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Port">
  218. <summary>
  219. Gets the port.
  220. </summary>
  221. </member>
  222. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Mode">
  223. <summary>
  224. Gets the mode.
  225. </summary>
  226. </member>
  227. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Disabled">
  228. <summary>
  229. Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled.
  230. </summary>
  231. <value>
  232. <c>true</c> if disabled; otherwise, <c>false</c>.
  233. </value>
  234. </member>
  235. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendTimeOut">
  236. <summary>
  237. Gets the send time out.
  238. </summary>
  239. </member>
  240. <member name="P:SuperSocket.SocketEngine.Configuration.Server.MaxConnectionNumber">
  241. <summary>
  242. Gets the max connection number.
  243. </summary>
  244. </member>
  245. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ReceiveBufferSize">
  246. <summary>
  247. Gets the size of the receive buffer.
  248. </summary>
  249. <value>
  250. The size of the receive buffer.
  251. </value>
  252. </member>
  253. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendBufferSize">
  254. <summary>
  255. Gets the size of the send buffer.
  256. </summary>
  257. <value>
  258. The size of the send buffer.
  259. </value>
  260. </member>
  261. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SyncSend">
  262. <summary>
  263. Gets a value indicating whether sending is in synchronous mode.
  264. </summary>
  265. <value>
  266. <c>true</c> if [sync send]; otherwise, <c>false</c>.
  267. </value>
  268. </member>
  269. <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogCommand">
  270. <summary>
  271. Gets a value indicating whether log command in log file.
  272. </summary>
  273. <value><c>true</c> if log command; otherwise, <c>false</c>.</value>
  274. </member>
  275. <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogBasicSessionActivity">
  276. <summary>
  277. Gets a value indicating whether [log basic session activity like connected and disconnected].
  278. </summary>
  279. <value>
  280. <c>true</c> if [log basic session activity]; otherwise, <c>false</c>.
  281. </value>
  282. </member>
  283. <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogAllSocketException">
  284. <summary>
  285. Gets a value indicating whether [log all socket exception].
  286. </summary>
  287. <value>
  288. <c>true</c> if [log all socket exception]; otherwise, <c>false</c>.
  289. </value>
  290. </member>
  291. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ClearIdleSession">
  292. <summary>
  293. Gets a value indicating whether clear idle session.
  294. </summary>
  295. <value><c>true</c> if clear idle session; otherwise, <c>false</c>.</value>
  296. </member>
  297. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ClearIdleSessionInterval">
  298. <summary>
  299. Gets the clear idle session interval, in seconds.
  300. </summary>
  301. <value>The clear idle session interval.</value>
  302. </member>
  303. <member name="P:SuperSocket.SocketEngine.Configuration.Server.IdleSessionTimeOut">
  304. <summary>
  305. Gets the idle session timeout time length, in seconds.
  306. </summary>
  307. <value>The idle session time out.</value>
  308. </member>
  309. <member name="P:SuperSocket.SocketEngine.Configuration.Server.CertificateConfig">
  310. <summary>
  311. Gets the certificate config.
  312. </summary>
  313. <value>The certificate config.</value>
  314. </member>
  315. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Certificate">
  316. <summary>
  317. Gets X509Certificate configuration.
  318. </summary>
  319. <value>
  320. X509Certificate configuration.
  321. </value>
  322. </member>
  323. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Security">
  324. <summary>
  325. Gets the security protocol, X509 certificate.
  326. </summary>
  327. </member>
  328. <member name="P:SuperSocket.SocketEngine.Configuration.Server.MaxRequestLength">
  329. <summary>
  330. Gets the max allowed length of request.
  331. </summary>
  332. <value>
  333. The max allowed length of request.
  334. </value>
  335. </member>
  336. <member name="P:SuperSocket.SocketEngine.Configuration.Server.DisableSessionSnapshot">
  337. <summary>
  338. Gets a value indicating whether [disable session snapshot]
  339. </summary>
  340. </member>
  341. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SessionSnapshotInterval">
  342. <summary>
  343. Gets the interval to taking snapshot for all live sessions.
  344. </summary>
  345. </member>
  346. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ConnectionFilter">
  347. <summary>
  348. Gets the connection filters used by this server instance.
  349. </summary>
  350. <value>
  351. The connection filters's name list, seperated by comma
  352. </value>
  353. </member>
  354. <member name="P:SuperSocket.SocketEngine.Configuration.Server.CommandLoader">
  355. <summary>
  356. Gets the command loader, multiple values should be separated by comma.
  357. </summary>
  358. </member>
  359. <member name="P:SuperSocket.SocketEngine.Configuration.Server.KeepAliveTime">
  360. <summary>
  361. Gets the start keep alive time, in seconds
  362. </summary>
  363. </member>
  364. <member name="P:SuperSocket.SocketEngine.Configuration.Server.KeepAliveInterval">
  365. <summary>
  366. Gets the keep alive interval, in seconds.
  367. </summary>
  368. </member>
  369. <member name="P:SuperSocket.SocketEngine.Configuration.Server.ListenBacklog">
  370. <summary>
  371. Gets the backlog size of socket listening.
  372. </summary>
  373. </member>
  374. <member name="P:SuperSocket.SocketEngine.Configuration.Server.StartupOrder">
  375. <summary>
  376. Gets the startup order of the server instance.
  377. </summary>
  378. </member>
  379. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendingQueueSize">
  380. <summary>
  381. Gets/sets the size of the sending queue.
  382. </summary>
  383. <value>
  384. The size of the sending queue.
  385. </value>
  386. </member>
  387. <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogFactory">
  388. <summary>
  389. Gets the logfactory name of the server instance.
  390. </summary>
  391. </member>
  392. <member name="P:SuperSocket.SocketEngine.Configuration.Server.TextEncoding">
  393. <summary>
  394. Gets the default text encoding.
  395. </summary>
  396. <value>
  397. The text encoding.
  398. </value>
  399. </member>
  400. <member name="P:SuperSocket.SocketEngine.Configuration.Server.Listeners">
  401. <summary>
  402. Gets the listeners' configuration.
  403. </summary>
  404. </member>
  405. <member name="P:SuperSocket.SocketEngine.Configuration.Server.SuperSocket#SocketBase#Config#IServerConfig#Listeners">
  406. <summary>
  407. Gets the listeners' configuration.
  408. </summary>
  409. </member>
  410. <member name="P:SuperSocket.SocketEngine.Configuration.Server.CommandAssemblies">
  411. <summary>
  412. Gets the command assemblies configuration.
  413. </summary>
  414. <value>
  415. The command assemblies.
  416. </value>
  417. </member>
  418. <member name="M:SuperSocket.SocketEngine.Configuration.Server.GetChildConfig``1(System.String)">
  419. <summary>
  420. Gets the child config.
  421. </summary>
  422. <typeparam name="TConfig">The type of the config.</typeparam>
  423. <param name="childConfigName">Name of the child config.</param>
  424. <returns></returns>
  425. </member>
  426. <member name="M:SuperSocket.SocketEngine.Configuration.Server.OnDeserializeUnrecognizedAttribute(System.String,System.String)">
  427. <summary>
  428. Gets a value indicating whether an unknown attribute is encountered during deserialization.
  429. To keep compatible with old configuration
  430. </summary>
  431. <param name="name">The name of the unrecognized attribute.</param>
  432. <param name="value">The value of the unrecognized attribute.</param>
  433. <returns>
  434. true when an unknown attribute is encountered while deserializing; otherwise, false.
  435. </returns>
  436. </member>
  437. <member name="T:SuperSocket.SocketEngine.Configuration.SocketServiceConfig">
  438. <summary>
  439. SocketServiceConfig, the part which is compatible with .Net 4.5 or higher
  440. </summary>
  441. <summary>
  442. SuperSocket's root configuration node
  443. </summary>
  444. </member>
  445. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.DefaultCulture">
  446. <summary>
  447. Gets/sets the default culture for all server instances.
  448. </summary>
  449. <value>
  450. The default culture.
  451. </value>
  452. </member>
  453. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.Servers">
  454. <summary>
  455. Gets all the server configurations
  456. </summary>
  457. </member>
  458. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ServerTypes">
  459. <summary>
  460. Gets the service configurations
  461. </summary>
  462. </member>
  463. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ConnectionFilters">
  464. <summary>
  465. Gets all the connection filter configurations.
  466. </summary>
  467. </member>
  468. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.LogFactories">
  469. <summary>
  470. Gets the defined log factory types.
  471. </summary>
  472. </member>
  473. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ReceiveFilterFactories">
  474. <summary>
  475. Gets the logfactory name of the bootstrap.
  476. </summary>
  477. </member>
  478. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.CommandLoaders">
  479. <summary>
  480. Gets the command loaders definition.
  481. </summary>
  482. </member>
  483. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MaxWorkingThreads">
  484. <summary>
  485. Gets the max working threads.
  486. </summary>
  487. </member>
  488. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MinWorkingThreads">
  489. <summary>
  490. Gets the min working threads.
  491. </summary>
  492. </member>
  493. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MaxCompletionPortThreads">
  494. <summary>
  495. Gets the max completion port threads.
  496. </summary>
  497. </member>
  498. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MinCompletionPortThreads">
  499. <summary>
  500. Gets the min completion port threads.
  501. </summary>
  502. </member>
  503. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.PerformanceDataCollectInterval">
  504. <summary>
  505. Gets the performance data collect interval, in seconds.
  506. </summary>
  507. </member>
  508. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.DisablePerformanceDataCollector">
  509. <summary>
  510. Gets a value indicating whether [disable performance data collector].
  511. </summary>
  512. <value>
  513. <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>.
  514. </value>
  515. </member>
  516. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.Isolation">
  517. <summary>
  518. Gets the isolation mode.
  519. </summary>
  520. </member>
  521. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.LogFactory">
  522. <summary>
  523. Gets the logfactory name of the bootstrap.
  524. </summary>
  525. </member>
  526. <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OptionElements">
  527. <summary>
  528. Gets the option elements.
  529. </summary>
  530. </member>
  531. <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OnDeserializeUnrecognizedElement(System.String,System.Xml.XmlReader)">
  532. <summary>
  533. Gets a value indicating whether an unknown element is encountered during deserialization.
  534. To keep compatible with old configuration
  535. </summary>
  536. <param name="elementName">The name of the unknown subelement.</param>
  537. <param name="reader">The <see cref="T:System.Xml.XmlReader"/> being used for deserialization.</param>
  538. <returns>
  539. true when an unknown element is encountered while deserializing; otherwise, false.
  540. </returns>
  541. <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>
  542. </member>
  543. <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OnDeserializeUnrecognizedAttribute(System.String,System.String)">
  544. <summary>
  545. Gets a value indicating whether an unknown attribute is encountered during deserialization.
  546. </summary>
  547. <param name="name">The name of the unrecognized attribute.</param>
  548. <param name="value">The value of the unrecognized attribute.</param>
  549. <returns>
  550. true when an unknown attribute is encountered while deserializing; otherwise, false.
  551. </returns>
  552. </member>
  553. <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.GetChildConfig``1(System.String)">
  554. <summary>
  555. Gets the child config.
  556. </summary>
  557. <typeparam name="TConfig">The type of the config.</typeparam>
  558. <param name="childConfigName">Name of the child config.</param>
  559. <returns></returns>
  560. </member>
  561. <member name="T:SuperSocket.SocketEngine.Configuration.CertificateConfig">
  562. <summary>
  563. Certificate configuration
  564. </summary>
  565. </member>
  566. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.FilePath">
  567. <summary>
  568. Gets the certificate file path.
  569. </summary>
  570. </member>
  571. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.Password">
  572. <summary>
  573. Gets the password.
  574. </summary>
  575. </member>
  576. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.StoreName">
  577. <summary>
  578. Gets the the store where certificate locates.
  579. </summary>
  580. <value>
  581. The name of the store.
  582. </value>
  583. </member>
  584. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.StoreLocation">
  585. <summary>
  586. Gets the store location of the certificate.
  587. </summary>
  588. <value>
  589. The store location.
  590. </value>
  591. </member>
  592. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.Thumbprint">
  593. <summary>
  594. Gets the thumbprint.
  595. </summary>
  596. </member>
  597. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.ClientCertificateRequired">
  598. <summary>
  599. Gets a value indicating whether [client certificate required].
  600. </summary>
  601. <value>
  602. <c>true</c> if [client certificate required]; otherwise, <c>false</c>.
  603. </value>
  604. </member>
  605. <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.KeyStorageFlags">
  606. <summary>
  607. Gets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager
  608. </summary>
  609. </member>
  610. <member name="T:SuperSocket.SocketEngine.Configuration.Listener">
  611. <summary>
  612. Listener configuration
  613. </summary>
  614. </member>
  615. <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Ip">
  616. <summary>
  617. Gets the ip of listener
  618. </summary>
  619. </member>
  620. <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Port">
  621. <summary>
  622. Gets the port of listener
  623. </summary>
  624. </member>
  625. <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Backlog">
  626. <summary>
  627. Gets the backlog.
  628. </summary>
  629. </member>
  630. <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Security">
  631. <summary>
  632. Gets the security option, None/Default/Tls/Ssl/...
  633. </summary>
  634. </member>
  635. <member name="T:SuperSocket.SocketEngine.Configuration.ListenerConfigCollection">
  636. <summary>
  637. Listener configuration collection
  638. </summary>
  639. </member>
  640. <member name="T:SuperSocket.SocketEngine.Configuration.ServerCollection">
  641. <summary>
  642. Server configuration collection
  643. </summary>
  644. </member>
  645. <member name="M:SuperSocket.SocketEngine.Configuration.ServerCollection.AddNew(SuperSocket.SocketEngine.Configuration.Server)">
  646. <summary>
  647. Adds the new server element.
  648. </summary>
  649. <param name="newServer">The new server.</param>
  650. </member>
  651. <member name="M:SuperSocket.SocketEngine.Configuration.ServerCollection.Remove(System.String)">
  652. <summary>
  653. Removes the specified server from the configuration.
  654. </summary>
  655. <param name="name">The name.</param>
  656. </member>
  657. <member name="T:SuperSocket.SocketEngine.DefaultBootstrap">
  658. <summary>
  659. SuperSocket default bootstrap
  660. </summary>
  661. </member>
  662. <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_Initialized">
  663. <summary>
  664. Indicates whether the bootstrap is initialized
  665. </summary>
  666. </member>
  667. <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_Config">
  668. <summary>
  669. Global configuration
  670. </summary>
  671. </member>
  672. <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_GlobalLog">
  673. <summary>
  674. Global log
  675. </summary>
  676. </member>
  677. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.SuperSocket#SocketBase#ILoggerProvider#Logger">
  678. <summary>
  679. Gets the bootstrap logger.
  680. </summary>
  681. </member>
  682. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.LogFactory">
  683. <summary>
  684. Gets the log factory.
  685. </summary>
  686. </member>
  687. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.AppServers">
  688. <summary>
  689. Gets all the app servers running in this bootstrap
  690. </summary>
  691. </member>
  692. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.Config">
  693. <summary>
  694. Gets the config.
  695. </summary>
  696. </member>
  697. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.StartupConfigFile">
  698. <summary>
  699. Gets the startup config file.
  700. </summary>
  701. </member>
  702. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.PerfMonitor">
  703. <summary>
  704. Gets the <see cref="T:SuperSocket.SocketEngine.PerformanceMonitor"/> class.
  705. </summary>
  706. </member>
  707. <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.BaseDirectory">
  708. <summary>
  709. Gets the base directory.
  710. </summary>
  711. <value>
  712. The base directory.
  713. </value>
  714. </member>
  715. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem})">
  716. <summary>
  717. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class.
  718. </summary>
  719. <param name="appServers">The app servers.</param>
  720. </member>
  721. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IRootConfig,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem})">
  722. <summary>
  723. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class.
  724. </summary>
  725. <param name="rootConfig">The root config.</param>
  726. <param name="appServers">The app servers.</param>
  727. </member>
  728. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IRootConfig,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem},SuperSocket.SocketBase.Logging.ILogFactory)">
  729. <summary>
  730. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class.
  731. </summary>
  732. <param name="rootConfig">The root config.</param>
  733. <param name="appServers">The app servers.</param>
  734. <param name="logFactory">The log factory.</param>
  735. </member>
  736. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)">
  737. <summary>
  738. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class.
  739. </summary>
  740. <param name="config">The config.</param>
  741. </member>
  742. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource,System.String)">
  743. <summary>
  744. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class.
  745. </summary>
  746. <param name="config">The config.</param>
  747. <param name="startupConfigFile">The startup config file.</param>
  748. </member>
  749. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.CreateWorkItemInstance(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])">
  750. <summary>
  751. Creates the work item instance.
  752. </summary>
  753. <param name="serviceTypeName">Name of the service type.</param>
  754. <param name="serverStatusMetadata">The server status metadata.</param>
  755. <returns></returns>
  756. </member>
  757. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.GetWorkItemFactoryInfoLoader(SuperSocket.SocketBase.Config.IConfigurationSource,SuperSocket.SocketBase.Logging.ILogFactory)">
  758. <summary>
  759. Gets the work item factory info loader.
  760. </summary>
  761. <param name="config">The config.</param>
  762. <param name="logFactory">The log factory.</param>
  763. <returns></returns>
  764. </member>
  765. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})">
  766. <summary>
  767. Initializes the bootstrap with a listen endpoint replacement dictionary
  768. </summary>
  769. <param name="listenEndPointReplacement">The listen end point replacement.</param>
  770. <returns></returns>
  771. </member>
  772. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)">
  773. <summary>
  774. Initializes the bootstrap with the configuration, config resolver and log factory.
  775. </summary>
  776. <param name="serverConfigResolver">The server config resolver.</param>
  777. <param name="logFactory">The log factory.</param>
  778. <returns></returns>
  779. </member>
  780. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})">
  781. <summary>
  782. Initializes the bootstrap with the configuration and config resolver.
  783. </summary>
  784. <param name="serverConfigResolver">The server config resolver.</param>
  785. <returns></returns>
  786. </member>
  787. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)">
  788. <summary>
  789. Initializes the bootstrap with the configuration
  790. </summary>
  791. <param name="logFactory">The log factory.</param>
  792. <returns></returns>
  793. </member>
  794. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize">
  795. <summary>
  796. Initializes the bootstrap with the configuration
  797. </summary>
  798. <returns></returns>
  799. </member>
  800. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Start">
  801. <summary>
  802. Starts this bootstrap.
  803. </summary>
  804. <returns></returns>
  805. </member>
  806. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Stop">
  807. <summary>
  808. Stops this bootstrap.
  809. </summary>
  810. </member>
  811. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.RegisterRemotingService">
  812. <summary>
  813. Registers the bootstrap remoting access service.
  814. </summary>
  815. </member>
  816. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Dispose(System.Boolean)">
  817. <summary>
  818. Releases unmanaged and - optionally - managed resources.
  819. </summary>
  820. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  821. </member>
  822. <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Dispose">
  823. <summary>
  824. Releases unmanaged and - optionally - managed resources.
  825. </summary>
  826. </member>
  827. <member name="T:SuperSocket.SocketEngine.IPerformanceMonitor">
  828. <summary>
  829. Interface of IPerformanceMonitor
  830. </summary>
  831. </member>
  832. <member name="M:SuperSocket.SocketEngine.IPerformanceMonitor.Start">
  833. <summary>
  834. Start PerformanceMonitor.
  835. </summary>
  836. </member>
  837. <member name="M:SuperSocket.SocketEngine.IPerformanceMonitor.Stop">
  838. <summary>
  839. Stop PerformanceMonitor.
  840. </summary>
  841. </member>
  842. <member name="E:SuperSocket.SocketEngine.IPerformanceMonitor.OnStatusUpdate">
  843. <summary>
  844. Invokes when status update.
  845. </summary>
  846. </member>
  847. <member name="P:SuperSocket.SocketEngine.IPerformanceMonitor.StatusUpdateInterval">
  848. <summary>
  849. Get or Set status update time in seconds.
  850. </summary>
  851. </member>
  852. <member name="T:SuperSocket.SocketEngine.IProcessServer">
  853. <summary>
  854. the interface for server instance which works as a process
  855. </summary>
  856. </member>
  857. <member name="P:SuperSocket.SocketEngine.IProcessServer.ProcessId">
  858. <summary>
  859. Gets the process id.
  860. </summary>
  861. <value>
  862. The process id. If the process id is zero, the server instance is not running
  863. </value>
  864. </member>
  865. <member name="T:SuperSocket.SocketEngine.IRemoteWorkItem">
  866. <summary>
  867. IRemoteWorkItem
  868. </summary>
  869. </member>
  870. <member name="M:SuperSocket.SocketEngine.IRemoteWorkItem.Setup(System.String,System.String,System.String,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[],System.String)">
  871. <summary>
  872. Setups the specified config.
  873. </summary>
  874. <param name="serverType">Type of the server.</param>
  875. <param name="bootstrapUri">The bootstrap URI.</param>
  876. <param name="assemblyImportRoot">The assembly import root.</param>
  877. <param name="config">The config.</param>
  878. <param name="factories">The factories.</param>
  879. <param name="startupConfigFile">The startup configuration file path</param>
  880. <returns></returns>
  881. </member>
  882. <member name="P:SuperSocket.SocketEngine.IsolationAppServer.StatusMetadataExtended">
  883. <summary>
  884. Gets a value indicating whether [status metadata extended].
  885. </summary>
  886. <value>
  887. <c>true</c> if [status metadata extended]; otherwise, <c>false</c>.
  888. </value>
  889. </member>
  890. <member name="M:SuperSocket.SocketEngine.IsolationAppServer.InitializeLifetimeService">
  891. <summary>
  892. Obtains a lifetime service object to control the lifetime policy for this instance.
  893. Return null, never expired
  894. </summary>
  895. <returns>
  896. An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease" /> used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the <see cref="P:System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime" /> property.
  897. </returns>
  898. <PermissionSet>
  899. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="RemotingConfiguration, Infrastructure" />
  900. </PermissionSet>
  901. </member>
  902. <member name="M:SuperSocket.SocketEngine.ProcessAppServer.#ctor(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])">
  903. <summary>
  904. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.ProcessAppServer" /> class.
  905. </summary>
  906. <param name="serverTypeName">Name of the server type.</param>
  907. <param name="serverStatusMetadata">The server status metadata.</param>
  908. </member>
  909. <member name="P:SuperSocket.SocketEngine.ProcessAppServer.ProcessId">
  910. <summary>
  911. Gets the process id.
  912. </summary>
  913. <value>
  914. The process id. If the process id is zero, the server instance is not running
  915. </value>
  916. </member>
  917. <member name="M:SuperSocket.SocketEngine.ProcessBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)">
  918. <summary>
  919. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.ProcessBootstrap" /> class.
  920. </summary>
  921. <param name="config">The config.</param>
  922. </member>
  923. <member name="T:SuperSocket.SocketEngine.SocketSession">
  924. <summary>
  925. Socket Session, all application session should base on this class
  926. </summary>
  927. </member>
  928. <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.Exception,System.String,System.String,System.Int32)">
  929. <summary>
  930. Logs the error, skip the ignored exception
  931. </summary>
  932. <param name="exception">The exception.</param>
  933. <param name="caller">The caller.</param>
  934. <param name="callerFilePath">The caller file path.</param>
  935. <param name="callerLineNumber">The caller line number.</param>
  936. </member>
  937. <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.String,System.Exception,System.String,System.String,System.Int32)">
  938. <summary>
  939. Logs the error, skip the ignored exception
  940. </summary>
  941. <param name="message">The message.</param>
  942. <param name="exception">The exception.</param>
  943. <param name="caller">The caller.</param>
  944. <param name="callerFilePath">The caller file path.</param>
  945. <param name="callerLineNumber">The caller line number.</param>
  946. </member>
  947. <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.Int32,System.String,System.String,System.Int32)">
  948. <summary>
  949. Logs the socket error, skip the ignored error
  950. </summary>
  951. <param name="socketErrorCode">The socket error code.</param>
  952. <param name="caller">The caller.</param>
  953. <param name="callerFilePath">The caller file path.</param>
  954. <param name="callerLineNumber">The caller line number.</param>
  955. </member>
  956. <member name="P:SuperSocket.SocketEngine.SocketSession.SessionID">
  957. <summary>
  958. Gets or sets the session ID.
  959. </summary>
  960. <value>The session ID.</value>
  961. </member>
  962. <member name="P:SuperSocket.SocketEngine.SocketSession.Config">
  963. <summary>
  964. Gets or sets the config.
  965. </summary>
  966. <value>
  967. The config.
  968. </value>
  969. </member>
  970. <member name="M:SuperSocket.SocketEngine.SocketSession.Start">
  971. <summary>
  972. Starts this session.
  973. </summary>
  974. </member>
  975. <member name="M:SuperSocket.SocketEngine.SocketSession.StartSession">
  976. <summary>
  977. Says the welcome information when a client connectted.
  978. </summary>
  979. </member>
  980. <member name="M:SuperSocket.SocketEngine.SocketSession.OnClosed(SuperSocket.SocketBase.CloseReason)">
  981. <summary>
  982. Called when [close].
  983. </summary>
  984. </member>
  985. <member name="P:SuperSocket.SocketEngine.SocketSession.Closed">
  986. <summary>
  987. Occurs when [closed].
  988. </summary>
  989. </member>
  990. <member name="M:SuperSocket.SocketEngine.SocketSession.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})">
  991. <summary>
  992. Tries to send array segment.
  993. </summary>
  994. <param name="segments">The segments.</param>
  995. <returns></returns>
  996. </member>
  997. <member name="M:SuperSocket.SocketEngine.SocketSession.TrySend(System.ArraySegment{System.Byte})">
  998. <summary>
  999. Tries to send array segment.
  1000. </summary>
  1001. <param name="segment">The segment.</param>
  1002. <returns></returns>
  1003. </member>
  1004. <member name="M:SuperSocket.SocketEngine.SocketSession.SendAsync(SuperSocket.Common.SendingQueue)">
  1005. <summary>
  1006. Sends in async mode.
  1007. </summary>
  1008. <param name="queue">The queue.</param>
  1009. </member>
  1010. <member name="M:SuperSocket.SocketEngine.SocketSession.SendSync(SuperSocket.Common.SendingQueue)">
  1011. <summary>
  1012. Sends in sync mode.
  1013. </summary>
  1014. <param name="queue">The queue.</param>
  1015. </member>
  1016. <member name="P:SuperSocket.SocketEngine.SocketSession.Client">
  1017. <summary>
  1018. Gets or sets the client.
  1019. </summary>
  1020. <value>The client.</value>
  1021. </member>
  1022. <member name="P:SuperSocket.SocketEngine.SocketSession.LocalEndPoint">
  1023. <summary>
  1024. Gets the local end point.
  1025. </summary>
  1026. <value>The local end point.</value>
  1027. </member>
  1028. <member name="P:SuperSocket.SocketEngine.SocketSession.RemoteEndPoint">
  1029. <summary>
  1030. Gets the remote end point.
  1031. </summary>
  1032. <value>The remote end point.</value>
  1033. </member>
  1034. <member name="P:SuperSocket.SocketEngine.SocketSession.SecureProtocol">
  1035. <summary>
  1036. Gets or sets the secure protocol.
  1037. </summary>
  1038. <value>The secure protocol.</value>
  1039. </member>
  1040. <member name="M:SuperSocket.SocketEngine.SocketSession.ValidateNotInSendingReceiving">
  1041. <summary>
  1042. Validates the socket is not in the sending or receiving operation.
  1043. </summary>
  1044. <returns></returns>
  1045. </member>
  1046. <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.ValidateProviderType(System.String)">
  1047. <summary>
  1048. Validates the type of the provider, needn't validate in default mode, because it will be validate later when initializing.
  1049. </summary>
  1050. <param name="typeName">Name of the type.</param>
  1051. <returns></returns>
  1052. </member>
  1053. <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.GetServerTypeMetadata(System.String)">
  1054. <summary>
  1055. Gets the app server type's metadata, the return value is not required in this mode.
  1056. </summary>
  1057. <param name="typeName">Name of the type.</param>
  1058. <returns></returns>
  1059. </member>
  1060. <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.Dispose">
  1061. <summary>
  1062. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1063. </summary>
  1064. </member>
  1065. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.#ctor(System.String)">
  1066. <summary>
  1067. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainAppServer"/> class.
  1068. </summary>
  1069. <param name="serviceTypeName">Name of the service type.</param>
  1070. </member>
  1071. <member name="P:SuperSocket.SocketEngine.MarshalAppServer.Name">
  1072. <summary>
  1073. Gets the name of the server instance.
  1074. </summary>
  1075. </member>
  1076. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])">
  1077. <summary>
  1078. Setups the specified root config.
  1079. </summary>
  1080. <param name="bootstrap">The bootstrap.</param>
  1081. <param name="config">The socket server instance config.</param>
  1082. <param name="factories">The providers.</param>
  1083. <returns></returns>
  1084. </member>
  1085. <member name="P:SuperSocket.SocketEngine.MarshalAppServer.Config">
  1086. <summary>
  1087. Gets the server's config.
  1088. </summary>
  1089. <value>
  1090. The server's config.
  1091. </value>
  1092. </member>
  1093. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.ReportPotentialConfigChange(SuperSocket.SocketBase.Config.IServerConfig)">
  1094. <summary>
  1095. Reports the potential configuration change.
  1096. </summary>
  1097. <param name="config">The server config which may be changed.</param>
  1098. <exception cref="T:System.NotImplementedException"></exception>
  1099. </member>
  1100. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Start">
  1101. <summary>
  1102. Starts this server instance.
  1103. </summary>
  1104. <returns>
  1105. return true if start successfull, else false
  1106. </returns>
  1107. </member>
  1108. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Stop">
  1109. <summary>
  1110. Stops this server instance.
  1111. </summary>
  1112. </member>
  1113. <member name="P:SuperSocket.SocketEngine.MarshalAppServer.State">
  1114. <summary>
  1115. Gets the current state of the work item.
  1116. </summary>
  1117. <value>
  1118. The state.
  1119. </value>
  1120. </member>
  1121. <member name="P:SuperSocket.SocketEngine.MarshalAppServer.SessionCount">
  1122. <summary>
  1123. Gets the total session count.
  1124. </summary>
  1125. </member>
  1126. <member name="M:SuperSocket.SocketEngine.MarshalAppServer.InitializeLifetimeService">
  1127. <summary>
  1128. Obtains a lifetime service object to control the lifetime policy for this instance.
  1129. </summary>
  1130. <returns>
  1131. An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease" /> used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the <see cref="P:System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime" /> property.
  1132. </returns>
  1133. <PermissionSet>
  1134. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="RemotingConfiguration, Infrastructure" />
  1135. </PermissionSet>
  1136. </member>
  1137. <member name="M:SuperSocket.SocketEngine.SocketListenerBase.Start(SuperSocket.SocketBase.Config.IServerConfig)">
  1138. <summary>
  1139. Starts to listen
  1140. </summary>
  1141. <param name="config">The server config.</param>
  1142. <returns></returns>
  1143. </member>
  1144. <member name="E:SuperSocket.SocketEngine.SocketListenerBase.Stopped">
  1145. <summary>
  1146. Occurs when [stopped].
  1147. </summary>
  1148. </member>
  1149. <member name="T:SuperSocket.SocketEngine.TcpAsyncSocketListener">
  1150. <summary>
  1151. Tcp socket listener in async mode
  1152. </summary>
  1153. </member>
  1154. <member name="M:SuperSocket.SocketEngine.TcpAsyncSocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)">
  1155. <summary>
  1156. Starts to listen
  1157. </summary>
  1158. <param name="config">The server config.</param>
  1159. <returns></returns>
  1160. </member>
  1161. <member name="T:SuperSocket.SocketEngine.INegotiateSocketSession">
  1162. <summary>
  1163. The interface for socket session which requires negotiation before communication
  1164. </summary>
  1165. </member>
  1166. <member name="M:SuperSocket.SocketEngine.INegotiateSocketSession.Negotiate">
  1167. <summary>
  1168. Start negotiates
  1169. </summary>
  1170. </member>
  1171. <member name="P:SuperSocket.SocketEngine.INegotiateSocketSession.Result">
  1172. <summary>
  1173. Gets a value indicating whether this <see cref="T:SuperSocket.SocketEngine.INegotiateSocketSession" /> is result.
  1174. </summary>
  1175. <value>
  1176. <c>true</c> if result; otherwise, <c>false</c>.
  1177. </value>
  1178. </member>
  1179. <member name="P:SuperSocket.SocketEngine.INegotiateSocketSession.AppSession">
  1180. <summary>
  1181. Gets the app session.
  1182. </summary>
  1183. <value>
  1184. The app session.
  1185. </value>
  1186. </member>
  1187. <member name="E:SuperSocket.SocketEngine.INegotiateSocketSession.NegotiateCompleted">
  1188. <summary>
  1189. Occurs when [negotiate completed].
  1190. </summary>
  1191. </member>
  1192. <member name="M:SuperSocket.SocketEngine.AsyncStreamSocketSession.Start">
  1193. <summary>
  1194. Starts this session communication.
  1195. </summary>
  1196. </member>
  1197. <member name="T:SuperSocket.SocketEngine.ISocketListener">
  1198. <summary>
  1199. The interface for socket listener
  1200. </summary>
  1201. </member>
  1202. <member name="P:SuperSocket.SocketEngine.ISocketListener.Info">
  1203. <summary>
  1204. Gets the info of listener
  1205. </summary>
  1206. </member>
  1207. <member name="P:SuperSocket.SocketEngine.ISocketListener.EndPoint">
  1208. <summary>
  1209. Gets the end point the listener is working on
  1210. </summary>
  1211. </member>
  1212. <member name="M:SuperSocket.SocketEngine.ISocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)">
  1213. <summary>
  1214. Starts to listen
  1215. </summary>
  1216. <param name="config">The server config.</param>
  1217. <returns></returns>
  1218. </member>
  1219. <member name="M:SuperSocket.SocketEngine.ISocketListener.Stop">
  1220. <summary>
  1221. Stops listening
  1222. </summary>
  1223. </member>
  1224. <member name="E:SuperSocket.SocketEngine.ISocketListener.NewClientAccepted">
  1225. <summary>
  1226. Occurs when new client accepted.
  1227. </summary>
  1228. </member>
  1229. <member name="E:SuperSocket.SocketEngine.ISocketListener.Error">
  1230. <summary>
  1231. Occurs when error got.
  1232. </summary>
  1233. </member>
  1234. <member name="E:SuperSocket.SocketEngine.ISocketListener.Stopped">
  1235. <summary>
  1236. Occurs when [stopped].
  1237. </summary>
  1238. </member>
  1239. <member name="T:SuperSocket.SocketEngine.SocketServerFactory">
  1240. <summary>
  1241. Default socket server factory
  1242. </summary>
  1243. </member>
  1244. <member name="M:SuperSocket.SocketEngine.SocketServerFactory.CreateSocketServer``1(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[],SuperSocket.SocketBase.Config.IServerConfig)">
  1245. <summary>
  1246. Creates the socket server.
  1247. </summary>
  1248. <typeparam name="TRequestInfo">The type of the request info.</typeparam>
  1249. <param name="appServer">The app server.</param>
  1250. <param name="listeners">The listeners.</param>
  1251. <param name="config">The config.</param>
  1252. <returns></returns>
  1253. </member>
  1254. <member name="P:SuperSocket.SocketEngine.SocketServerBase.SendingQueuePool">
  1255. <summary>
  1256. Gets the sending queue manager.
  1257. </summary>
  1258. <value>
  1259. The sending queue manager.
  1260. </value>
  1261. </member>
  1262. <member name="M:SuperSocket.SocketEngine.UdpSocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)">
  1263. <summary>
  1264. Starts to listen
  1265. </summary>
  1266. <param name="config">The server config.</param>
  1267. <returns></returns>
  1268. </member>
  1269. <member name="M:SuperSocket.SocketEngine.UdpSocketServer`1.#ctor(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[])">
  1270. <summary>
  1271. Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.UdpSocketServer`1"/> class.
  1272. </summary>
  1273. <param name="appServer">The app server.</param>
  1274. <param name="listeners">The listeners.</param>
  1275. </member>
  1276. <member name="M:SuperSocket.SocketEngine.UdpSocketServer`1.OnNewClientAccepted(SuperSocket.SocketEngine.ISocketListener,System.Net.Sockets.Socket,System.Object)">
  1277. <summary>
  1278. Called when [new client accepted].
  1279. </summary>
  1280. <param name="listener">The listener.</param>
  1281. <param name="client">The client.</param>
  1282. <param name="state">The state.</param>
  1283. </member>
  1284. <member name="M:SuperSocket.SocketEngine.UdpSocketSession.UpdateRemoteEndPoint(System.Net.IPEndPoint)">
  1285. <summary>
  1286. Updates the remote end point of the client.
  1287. </summary>
  1288. <param name="remoteEndPoint">The remote end point.</param>
  1289. </member>
  1290. </members>
  1291. </doc>