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