SuperSocket.SocketEngine.xml 56 KB

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