SuperSocket.SocketEngine.XML 58 KB

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