Microsoft.AspNet.SignalR.Client.XML 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNet.SignalR.Client</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.AspNet.SignalR.Client.Connection">
  8. <summary>
  9. Provides client connections for SignalR services.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.AspNet.SignalR.Client.IConnection.Proxy">
  13. <summary>
  14. Gets of sets proxy information for the connection.
  15. </summary>
  16. </member>
  17. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.#ctor(System.String)">
  18. <summary>
  19. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> class.
  20. </summary>
  21. <param name="url">The url to connect to.</param>
  22. </member>
  23. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
  24. <summary>
  25. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> class.
  26. </summary>
  27. <param name="url">The url to connect to.</param>
  28. <param name="queryString">The query string data to pass to the server.</param>
  29. </member>
  30. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.#ctor(System.String,System.String)">
  31. <summary>
  32. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> class.
  33. </summary>
  34. <param name="url">The url to connect to.</param>
  35. <param name="queryString">The query string data to pass to the server.</param>
  36. </member>
  37. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Start">
  38. <summary>
  39. Starts the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/>.
  40. </summary>
  41. <returns>A task that represents when the connection has started.</returns>
  42. </member>
  43. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Start(Microsoft.AspNet.SignalR.Client.Http.IHttpClient)">
  44. <summary>
  45. Starts the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/>.
  46. </summary>
  47. <param name="httpClient">The http client</param>
  48. <returns>A task that represents when the connection has started.</returns>
  49. </member>
  50. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Start(Microsoft.AspNet.SignalR.Client.Transports.IClientTransport)">
  51. <summary>
  52. Starts the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/>.
  53. </summary>
  54. <param name="transport">The transport to use.</param>
  55. <returns>A task that represents when the connection has started.</returns>
  56. </member>
  57. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Stop">
  58. <summary>
  59. Stops the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> and sends an abort message to the server.
  60. </summary>
  61. </member>
  62. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Stop(System.Exception)">
  63. <summary>
  64. Stops the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> and sends an abort message to the server.
  65. <param name="error">The error due to which the connection is being stopped.</param>
  66. </summary>
  67. </member>
  68. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Stop(System.Exception,System.TimeSpan)">
  69. <summary>
  70. Stops the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> and sends an abort message to the server.
  71. <param name="error">The error due to which the connection is being stopped.</param>
  72. <param name="timeout">The timeout</param>
  73. </summary>
  74. </member>
  75. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Stop(System.TimeSpan)">
  76. <summary>
  77. Stops the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> and sends an abort message to the server.
  78. <param name="timeout">The timeout</param>
  79. </summary>
  80. </member>
  81. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#Disconnect">
  82. <summary>
  83. Stops the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> without sending an abort message to the server.
  84. This function is called after we receive a disconnect message from the server.
  85. </summary>
  86. </member>
  87. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Send(System.String)">
  88. <summary>
  89. Sends data asynchronously over the connection.
  90. </summary>
  91. <param name="data">The data to send.</param>
  92. <returns>A task that represents when the data has been sent.</returns>
  93. </member>
  94. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Send(System.Object)">
  95. <summary>
  96. Sends an object that will be JSON serialized asynchronously over the connection.
  97. </summary>
  98. <param name="value">The value to serialize.</param>
  99. <returns>A task that represents when the data has been sent.</returns>
  100. </member>
  101. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.AddClientCertificate(System.Security.Cryptography.X509Certificates.X509Certificate)">
  102. <summary>
  103. Adds a client certificate to the request
  104. </summary>
  105. <param name="certificate">Client Certificate</param>
  106. </member>
  107. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#MarkLastMessage">
  108. <summary>
  109. Sets LastMessageAt to the current time
  110. </summary>
  111. </member>
  112. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#MarkActive">
  113. <summary>
  114. Sets LastActiveAt to the current time
  115. </summary>
  116. </member>
  117. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Dispose">
  118. <summary>
  119. Stop the connection, equivalent to calling connection.stop
  120. </summary>
  121. </member>
  122. <member name="M:Microsoft.AspNet.SignalR.Client.Connection.Dispose(System.Boolean)">
  123. <summary>
  124. Stop the connection, equivalent to calling connection.stop
  125. </summary>
  126. <param name="disposing">Set this to true to perform the dispose, false to do nothing</param>
  127. </member>
  128. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.Received">
  129. <summary>
  130. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> has received data from the server.
  131. </summary>
  132. </member>
  133. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.Error">
  134. <summary>
  135. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> has encountered an error.
  136. </summary>
  137. </member>
  138. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.Closed">
  139. <summary>
  140. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> is stopped.
  141. </summary>
  142. </member>
  143. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.Reconnecting">
  144. <summary>
  145. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> starts reconnecting after an error.
  146. </summary>
  147. </member>
  148. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.Reconnected">
  149. <summary>
  150. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> successfully reconnects after a timeout.
  151. </summary>
  152. </member>
  153. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.StateChanged">
  154. <summary>
  155. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> state changes.
  156. </summary>
  157. </member>
  158. <member name="E:Microsoft.AspNet.SignalR.Client.Connection.ConnectionSlow">
  159. <summary>
  160. Occurs when the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> is about to timeout
  161. </summary>
  162. </member>
  163. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.TransportConnectTimeout">
  164. <summary>
  165. The amount of time a transport will wait (while connecting) before failing.
  166. This value is modified by adding the server's TransportConnectTimeout configuration value.
  167. </summary>
  168. </member>
  169. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.DeadlockErrorTimeout">
  170. <summary>
  171. Gets or sets the amount of time a callback registered with "HubProxy.On" or
  172. "Connection.Received" may run before <see cref="E:Microsoft.AspNet.SignalR.Client.Connection.Error"/> will be called
  173. warning that a possible deadlock has been detected.
  174. </summary>
  175. </member>
  176. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#TotalTransportConnectTimeout">
  177. <summary>
  178. The amount of time a transport will wait (while connecting) before failing.
  179. This is the total vaue obtained by adding the server's configuration value and the timeout specified by the user
  180. </summary>
  181. </member>
  182. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.LastError">
  183. <summary>
  184. Gets the last error encountered by the <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/>.
  185. </summary>
  186. </member>
  187. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#ReconnectWindow">
  188. <summary>
  189. The maximum amount of time a connection will allow to try and reconnect.
  190. This value is equivalent to the summation of the servers disconnect and keep alive timeout values.
  191. </summary>
  192. </member>
  193. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#KeepAliveData">
  194. <summary>
  195. Object to store the various keep alive timeout values
  196. </summary>
  197. </member>
  198. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Microsoft#AspNet#SignalR#Client#IConnection#LastMessageAt">
  199. <summary>
  200. The timestamp of the last message received by the connection.
  201. </summary>
  202. </member>
  203. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.JsonSerializer">
  204. <summary>
  205. Gets or sets the serializer used by the connection
  206. </summary>
  207. </member>
  208. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.CookieContainer">
  209. <summary>
  210. Gets or sets the cookies associated with the connection.
  211. </summary>
  212. </member>
  213. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Credentials">
  214. <summary>
  215. Gets or sets authentication information for the connection.
  216. </summary>
  217. </member>
  218. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Headers">
  219. <summary>
  220. Gets and sets headers for the requests
  221. </summary>
  222. </member>
  223. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Proxy">
  224. <summary>
  225. Gets of sets proxy information for the connection.
  226. </summary>
  227. </member>
  228. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Url">
  229. <summary>
  230. Gets the url for the connection.
  231. </summary>
  232. </member>
  233. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.MessageId">
  234. <summary>
  235. Gets or sets the last message id for the connection.
  236. </summary>
  237. </member>
  238. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.ConnectionId">
  239. <summary>
  240. Gets or sets the connection id for the connection.
  241. </summary>
  242. </member>
  243. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.ConnectionToken">
  244. <summary>
  245. Gets or sets the connection token for the connection.
  246. </summary>
  247. </member>
  248. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.GroupsToken">
  249. <summary>
  250. Gets or sets the groups token for the connection.
  251. </summary>
  252. </member>
  253. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.Items">
  254. <summary>
  255. Gets a dictionary for storing state for a the connection.
  256. </summary>
  257. </member>
  258. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.QueryString">
  259. <summary>
  260. Gets the querystring specified in the ctor.
  261. </summary>
  262. </member>
  263. <member name="P:Microsoft.AspNet.SignalR.Client.Connection.State">
  264. <summary>
  265. Gets the current <see cref="T:Microsoft.AspNet.SignalR.Client.ConnectionState"/> of the connection.
  266. </summary>
  267. </member>
  268. <member name="T:Microsoft.AspNet.SignalR.Client.Connection.DebugTextWriter">
  269. <summary>
  270. Default text writer
  271. </summary>
  272. </member>
  273. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.#ctor(Microsoft.AspNet.SignalR.Client.IConnection,System.Object,System.TimeSpan)">
  274. <summary>
  275. Initializes a new instance of the HeartBeatMonitor Class
  276. </summary>
  277. <param name="connection"></param>
  278. <param name="connectionStateLock"></param>
  279. <param name="beatInterval">How often to check connection status</param>
  280. </member>
  281. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.Start">
  282. <summary>
  283. Starts the timer that triggers heartbeats
  284. </summary>
  285. </member>
  286. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.Beat">
  287. <summary>
  288. Callback function for the timer which determines if we need to notify the user or attempt to reconnect
  289. </summary>
  290. </member>
  291. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.Beat(System.TimeSpan)">
  292. <summary>
  293. Logic to determine if we need to notify the user or attempt to reconnect
  294. </summary>
  295. <param name="timeElapsed"></param>
  296. </member>
  297. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.Dispose">
  298. <summary>
  299. Dispose off the timer
  300. </summary>
  301. </member>
  302. <member name="M:Microsoft.AspNet.SignalR.Client.HeartbeatMonitor.Dispose(System.Boolean)">
  303. <summary>
  304. Dispose off the timer
  305. </summary>
  306. <param name="disposing"></param>
  307. </member>
  308. <member name="T:Microsoft.AspNet.SignalR.Client.Http.DefaultHttpClient">
  309. <summary>
  310. The default <see cref="T:Microsoft.AspNet.SignalR.Client.Http.IHttpClient"/> implementation.
  311. </summary>
  312. </member>
  313. <member name="T:Microsoft.AspNet.SignalR.Client.Http.IHttpClient">
  314. <summary>
  315. A client that can make http request.
  316. </summary>
  317. </member>
  318. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IHttpClient.Initialize(Microsoft.AspNet.SignalR.Client.IConnection)">
  319. <summary>
  320. Initializes the Http Clients
  321. </summary>
  322. <param name="connection">Connection</param>
  323. </member>
  324. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IHttpClient.Get(System.String,System.Action{Microsoft.AspNet.SignalR.Client.Http.IRequest},System.Boolean)">
  325. <summary>
  326. Makes an asynchronous http GET request to the specified url.
  327. </summary>
  328. <param name="url">The url to send the request to.</param>
  329. <param name="prepareRequest">A callback that initializes the request with default values.</param>
  330. <param name="isLongRunning">Indicates whether it is a long running request</param>
  331. <returns>A <see cref="T:Task{IResponse}"/>.</returns>
  332. </member>
  333. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IHttpClient.Post(System.String,System.Action{Microsoft.AspNet.SignalR.Client.Http.IRequest},System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)">
  334. <summary>
  335. Makes an asynchronous http POST request to the specified url.
  336. </summary>
  337. <param name="url">The url to send the request to.</param>
  338. <param name="prepareRequest">A callback that initializes the request with default values.</param>
  339. <param name="postData">form url encoded data.</param>
  340. <param name="isLongRunning">Indicates whether it is a long running request</param>
  341. <returns>A <see cref="T:Task{IResponse}"/>.</returns>
  342. </member>
  343. <member name="M:Microsoft.AspNet.SignalR.Client.Http.DefaultHttpClient.Get(System.String,System.Action{Microsoft.AspNet.SignalR.Client.Http.IRequest},System.Boolean)">
  344. <summary>
  345. Makes an asynchronous http GET request to the specified url.
  346. </summary>
  347. <param name="url">The url to send the request to.</param>
  348. <param name="prepareRequest">A callback that initializes the request with default values.</param>
  349. <param name="isLongRunning">Indicates whether the request is long running</param>
  350. <returns>A <see cref="T:Task{IResponse}"/>.</returns>
  351. </member>
  352. <member name="M:Microsoft.AspNet.SignalR.Client.Http.DefaultHttpClient.Post(System.String,System.Action{Microsoft.AspNet.SignalR.Client.Http.IRequest},System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)">
  353. <summary>
  354. Makes an asynchronous http POST request to the specified url.
  355. </summary>
  356. <param name="url">The url to send the request to.</param>
  357. <param name="prepareRequest">A callback that initializes the request with default values.</param>
  358. <param name="postData">form url encoded data.</param>
  359. <param name="isLongRunning">Indicates whether the request is long running</param>
  360. <returns>A <see cref="T:Task{IResponse}"/>.</returns>
  361. </member>
  362. <member name="M:Microsoft.AspNet.SignalR.Client.Http.DefaultHttpClient.PrepareClientRequest(Microsoft.AspNet.SignalR.Client.Http.HttpWebRequestWrapper)">
  363. <summary>
  364. Adds certificates, credentials, proxies and cookies to the request
  365. </summary>
  366. <param name="req">Request object</param>
  367. </member>
  368. <member name="T:Microsoft.AspNet.SignalR.Client.Http.IRequest">
  369. <summary>
  370. The http request
  371. </summary>
  372. </member>
  373. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IRequest.Abort">
  374. <summary>
  375. Aborts the request.
  376. </summary>
  377. </member>
  378. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IRequest.SetRequestHeaders(System.Collections.Generic.IDictionary{System.String,System.String})">
  379. <summary>
  380. Set Request Headers
  381. </summary>
  382. <param name="headers">request headers</param>
  383. </member>
  384. <member name="P:Microsoft.AspNet.SignalR.Client.Http.IRequest.UserAgent">
  385. <summary>
  386. The user agent for this request.
  387. </summary>
  388. </member>
  389. <member name="P:Microsoft.AspNet.SignalR.Client.Http.IRequest.Accept">
  390. <summary>
  391. The accept header for this request.
  392. </summary>
  393. </member>
  394. <member name="T:Microsoft.AspNet.SignalR.Client.Http.IResponse">
  395. <summary>
  396. The http response.
  397. </summary>
  398. </member>
  399. <member name="M:Microsoft.AspNet.SignalR.Client.Http.IResponse.GetStream">
  400. <summary>
  401. Gets the steam that represents the response body.
  402. </summary>
  403. <returns></returns>
  404. </member>
  405. <member name="T:Microsoft.AspNet.SignalR.Client.HubConnection">
  406. <summary>
  407. A <see cref="T:Microsoft.AspNet.SignalR.Client.Connection"/> for interacting with Hubs.
  408. </summary>
  409. </member>
  410. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String)">
  411. <summary>
  412. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  413. </summary>
  414. <param name="url">The url to connect to.</param>
  415. </member>
  416. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String,System.Boolean)">
  417. <summary>
  418. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  419. </summary>
  420. <param name="url">The url to connect to.</param>
  421. <param name="useDefaultUrl">Determines if the default "/signalr" path should be appended to the specified url.</param>
  422. </member>
  423. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String,System.String)">
  424. <summary>
  425. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  426. </summary>
  427. <param name="url">The url to connect to.</param>
  428. <param name="queryString">The query string data to pass to the server.</param>
  429. </member>
  430. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String,System.String,System.Boolean)">
  431. <summary>
  432. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  433. </summary>
  434. <param name="url">The url to connect to.</param>
  435. <param name="queryString">The query string data to pass to the server.</param>
  436. <param name="useDefaultUrl">Determines if the default "/signalr" path should be appended to the specified url.</param>
  437. </member>
  438. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
  439. <summary>
  440. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  441. </summary>
  442. <param name="url">The url to connect to.</param>
  443. <param name="queryString">The query string data to pass to the server.</param>
  444. </member>
  445. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)">
  446. <summary>
  447. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.HubConnection"/> class.
  448. </summary>
  449. <param name="url">The url to connect to.</param>
  450. <param name="queryString">The query string data to pass to the server.</param>
  451. <param name="useDefaultUrl">Determines if the default "/signalr" path should be appended to the specified url.</param>
  452. </member>
  453. <member name="M:Microsoft.AspNet.SignalR.Client.HubConnection.CreateHubProxy(System.String)">
  454. <summary>
  455. Creates an <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/> for the hub with the specified name.
  456. </summary>
  457. <param name="hubName">The name of the hub.</param>
  458. <returns>A <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/></returns>
  459. </member>
  460. <member name="T:Microsoft.AspNet.SignalR.Client.HubProxyExtensions">
  461. <summary>
  462. Extensions to the <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.
  463. </summary>
  464. </member>
  465. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.GetValue``1(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String)">
  466. <summary>
  467. Gets the value of a state variable.
  468. </summary>
  469. <typeparam name="T">The type of the state variable</typeparam>
  470. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  471. <param name="name">The name of the state variable.</param>
  472. <returns>The value of the state variable.</returns>
  473. </member>
  474. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action)">
  475. <summary>
  476. Registers for an event with the specified name and callback
  477. </summary>
  478. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  479. <param name="eventName">The name of the event.</param>
  480. <param name="onData">The callback</param>
  481. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  482. </member>
  483. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``1(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0})">
  484. <summary>
  485. Registers for an event with the specified name and callback
  486. </summary>
  487. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  488. <param name="eventName">The name of the event.</param>
  489. <param name="onData">The callback</param>
  490. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  491. </member>
  492. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``2(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1})">
  493. <summary>
  494. Registers for an event with the specified name and callback
  495. </summary>
  496. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  497. <param name="eventName">The name of the event.</param>
  498. <param name="onData">The callback</param>
  499. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  500. </member>
  501. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``3(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1,``2})">
  502. <summary>
  503. Registers for an event with the specified name and callback
  504. </summary>
  505. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  506. <param name="eventName">The name of the event.</param>
  507. <param name="onData">The callback</param>
  508. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  509. </member>
  510. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``4(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1,``2,``3})">
  511. <summary>
  512. Registers for an event with the specified name and callback
  513. </summary>
  514. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  515. <param name="eventName">The name of the event.</param>
  516. <param name="onData">The callback</param>
  517. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  518. </member>
  519. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{System.Object})">
  520. <summary>
  521. Registers for an event with the specified name and callback
  522. </summary>
  523. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  524. <param name="eventName">The name of the event.</param>
  525. <param name="onData">The callback</param>
  526. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  527. </member>
  528. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``5(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1,``2,``3,``4})">
  529. <summary>
  530. Registers for an event with the specified name and callback
  531. </summary>
  532. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  533. <param name="eventName">The name of the event.</param>
  534. <param name="onData">The callback</param>
  535. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  536. </member>
  537. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``6(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1,``2,``3,``4,``5})">
  538. <summary>
  539. Registers for an event with the specified name and callback
  540. </summary>
  541. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  542. <param name="eventName">The name of the event.</param>
  543. <param name="onData">The callback</param>
  544. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  545. </member>
  546. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.On``7(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String,System.Action{``0,``1,``2,``3,``4,``5,``6})">
  547. <summary>
  548. Registers for an event with the specified name and callback
  549. </summary>
  550. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/>.</param>
  551. <param name="eventName">The name of the event.</param>
  552. <param name="onData">The callback</param>
  553. <returns>An <see cref="T:System.IDisposable"/> that represents this subscription.</returns>
  554. </member>
  555. <member name="M:Microsoft.AspNet.SignalR.Client.HubProxyExtensions.Observe(Microsoft.AspNet.SignalR.Client.IHubProxy,System.String)">
  556. <summary>
  557. Registers a <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/> event has an <see cref="T:IObservable{T}"/>.
  558. </summary>
  559. <param name="proxy">The <see cref="T:Microsoft.AspNet.SignalR.Client.IHubProxy"/></param>
  560. <param name="eventName">The name of the event.</param>
  561. <returns>An <see cref="T:IObservable{object[]}"/>.</returns>
  562. </member>
  563. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubProgressUpdate.Id">
  564. <summary>
  565. The callback identifier
  566. </summary>
  567. </member>
  568. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubProgressUpdate.Data">
  569. <summary>
  570. The progress value
  571. </summary>
  572. </member>
  573. <member name="T:Microsoft.AspNet.SignalR.Client.IHubProxy">
  574. <summary>
  575. A client side proxy for a server side hub.
  576. </summary>
  577. </member>
  578. <member name="M:Microsoft.AspNet.SignalR.Client.IHubProxy.Invoke(System.String,System.Object[])">
  579. <summary>
  580. Executes a method on the server side hub asynchronously.
  581. </summary>
  582. <param name="method">The name of the method.</param>
  583. <param name="args">The arguments</param>
  584. <returns>A task that represents when invocation returned.</returns>
  585. </member>
  586. <member name="M:Microsoft.AspNet.SignalR.Client.IHubProxy.Invoke``1(System.String,System.Object[])">
  587. <summary>
  588. Executes a method on the server side hub asynchronously.
  589. </summary>
  590. <typeparam name="T">The type of result returned from the hub.</typeparam>
  591. <param name="method">The name of the method.</param>
  592. <param name="args">The arguments</param>
  593. <returns>A task that represents when invocation returned.</returns>
  594. </member>
  595. <member name="M:Microsoft.AspNet.SignalR.Client.IHubProxy.Invoke``1(System.String,System.Action{``0},System.Object[])">
  596. <summary>
  597. Executes a method on the server side hub asynchronously with progress updates.
  598. </summary>
  599. <param name="method">The name of the method.</param>
  600. <param name="onProgress">The callback to invoke when progress updates are received.</param>
  601. <param name="args">The arguments</param>
  602. <returns>A task that represents when invocation returned.</returns>
  603. </member>
  604. <member name="M:Microsoft.AspNet.SignalR.Client.IHubProxy.Invoke``2(System.String,System.Action{``1},System.Object[])">
  605. <summary>
  606. Executes a method on the server side hub asynchronously with progress updates.
  607. </summary>
  608. <typeparam name="TResult">The type of result returned from the hub.</typeparam>
  609. <typeparam name="TProgress">The type of progress update value.</typeparam>
  610. <param name="method">The name of the method.</param>
  611. <param name="onProgress">The callback to invoke when progress updates are received.</param>
  612. <param name="args">The arguments</param>
  613. <returns>A task that represents when invocation returned.</returns>
  614. </member>
  615. <member name="M:Microsoft.AspNet.SignalR.Client.IHubProxy.Subscribe(System.String)">
  616. <summary>
  617. Registers an event for the hub.
  618. </summary>
  619. <param name="eventName">The name of the event</param>
  620. <returns>A <see cref="T:Microsoft.AspNet.SignalR.Client.Hubs.Subscription"/>.</returns>
  621. </member>
  622. <member name="P:Microsoft.AspNet.SignalR.Client.IHubProxy.Item(System.String)">
  623. <summary>
  624. Gets or sets state on the hub.
  625. </summary>
  626. <param name="name">The name of the field.</param>
  627. <returns>The value of the field</returns>
  628. </member>
  629. <member name="P:Microsoft.AspNet.SignalR.Client.IHubProxy.JsonSerializer">
  630. <summary>
  631. Gets the serializer used by the connection.
  632. </summary>
  633. </member>
  634. <member name="T:Microsoft.AspNet.SignalR.Client.Hubs.HubResult">
  635. <summary>
  636. Represents the result of a hub invocation.
  637. </summary>
  638. </member>
  639. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.Id">
  640. <summary>
  641. The callback identifier
  642. </summary>
  643. </member>
  644. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.ProgressUpdate">
  645. <summary>
  646. The progress update of the invocation
  647. </summary>
  648. </member>
  649. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.Result">
  650. <summary>
  651. The return value of the hub
  652. </summary>
  653. </member>
  654. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.IsHubException">
  655. <summary>
  656. Indicates whether the Error is a <see cref="T:Microsoft.AspNet.SignalR.Client.HubException"/>.
  657. </summary>
  658. </member>
  659. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.Error">
  660. <summary>
  661. The error message returned from the hub invocation.
  662. </summary>
  663. </member>
  664. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.ErrorData">
  665. <summary>
  666. Extra error data
  667. </summary>
  668. </member>
  669. <member name="P:Microsoft.AspNet.SignalR.Client.Hubs.HubResult.State">
  670. <summary>
  671. The caller state from this hub.
  672. </summary>
  673. </member>
  674. <member name="T:Microsoft.AspNet.SignalR.Client.Hubs.Hubservable">
  675. <summary>
  676. <see cref="T:System.IObservable{object[]}"/> implementation of a hub event.
  677. </summary>
  678. </member>
  679. <member name="T:Microsoft.AspNet.SignalR.Client.Hubs.Subscription">
  680. <summary>
  681. Represents a subscription to a hub method.
  682. </summary>
  683. </member>
  684. <member name="M:Microsoft.AspNet.SignalR.Client.ErrorExtensions.GetError(System.Exception)">
  685. <summary>
  686. Simplifies error recognition by unwrapping complex exceptions.
  687. </summary>
  688. <param name="ex">The thrown exception.</param>
  689. <returns>An unwrapped exception in the form of a SignalRError.</returns>
  690. </member>
  691. <member name="T:Microsoft.AspNet.SignalR.Client.SignalRError">
  692. <summary>
  693. Represents errors that are thrown by the SignalR client
  694. </summary>
  695. </member>
  696. <member name="M:Microsoft.AspNet.SignalR.Client.SignalRError.#ctor(System.Exception)">
  697. <summary>
  698. Create custom SignalR based error.
  699. </summary>
  700. <param name="exception">The exception to unwrap</param>
  701. </member>
  702. <member name="M:Microsoft.AspNet.SignalR.Client.SignalRError.ToString">
  703. <summary>
  704. Allow a SignalRError to be directly written to an output stream
  705. </summary>
  706. <returns>Exception error</returns>
  707. </member>
  708. <member name="M:Microsoft.AspNet.SignalR.Client.SignalRError.Dispose">
  709. <summary>
  710. Dispose of the response
  711. </summary>
  712. </member>
  713. <member name="P:Microsoft.AspNet.SignalR.Client.SignalRError.StatusCode">
  714. <summary>
  715. The status code of the error (if it was a WebException)
  716. </summary>
  717. </member>
  718. <member name="P:Microsoft.AspNet.SignalR.Client.SignalRError.ResponseBody">
  719. <summary>
  720. The response body of the error, if it was a WebException and the response is readable
  721. </summary>
  722. </member>
  723. <member name="P:Microsoft.AspNet.SignalR.Client.SignalRError.Exception">
  724. <summary>
  725. The unwrapped underlying exception
  726. </summary>
  727. </member>
  728. <member name="M:Microsoft.AspNet.SignalR.Client.Infrastructure.TaskQueueMonitor.Dispose">
  729. <summary>
  730. Dispose off the timer
  731. </summary>
  732. </member>
  733. <member name="T:Microsoft.AspNet.SignalR.Infrastructure.UrlEncoder">
  734. <summary>
  735. Helpers for encoding URI query components.
  736. </summary>
  737. </member>
  738. <member name="T:Microsoft.AspNet.SignalR.Client.KeepAliveData">
  739. <summary>
  740. Class to store all the Keep Alive properties
  741. </summary>
  742. </member>
  743. <member name="T:Microsoft.AspNet.SignalR.Client.Infrastructure.ThreadSafeInvoker">
  744. <summary>
  745. Allows for thread safe invocation of a delegate.
  746. </summary>
  747. </member>
  748. <member name="T:Microsoft.AspNet.SignalR.Client.Resources">
  749. <summary>
  750. A strongly-typed resource class, for looking up localized strings, etc.
  751. </summary>
  752. </member>
  753. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.ResourceManager">
  754. <summary>
  755. Returns the cached ResourceManager instance used by this class.
  756. </summary>
  757. </member>
  758. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Culture">
  759. <summary>
  760. Overrides the current thread's CurrentUICulture property for all
  761. resource lookups using this strongly typed resource class.
  762. </summary>
  763. </member>
  764. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_CertsCanOnlyBeAddedWhenDisconnected">
  765. <summary>
  766. Looks up a localized string similar to Client Certificates cannot be added after the connection has started..
  767. </summary>
  768. </member>
  769. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ClientCallbackArgumentTypeMismatch">
  770. <summary>
  771. Looks up a localized string similar to A client callback for event {0} with {1} argument(s) was found, however an error occurred because {2}.
  772. </summary>
  773. </member>
  774. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ClientCallbackInvalidNumberOfArguments">
  775. <summary>
  776. Looks up a localized string similar to A client callback for event {0} with {1} argument(s) could not be found.
  777. </summary>
  778. </member>
  779. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ConnectionCancelled">
  780. <summary>
  781. Looks up a localized string similar to The connection was stopped before it could be started..
  782. </summary>
  783. </member>
  784. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ConnectionHasNotBeenEstablished">
  785. <summary>
  786. Looks up a localized string similar to The connection has not been established..
  787. </summary>
  788. </member>
  789. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_DataCannotBeSentConnectionDisconnected">
  790. <summary>
  791. Looks up a localized string similar to Data cannot be sent because the connection is in the disconnected state. Call start before sending any data..
  792. </summary>
  793. </member>
  794. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_DataCannotBeSentDuringWebSocketReconnect">
  795. <summary>
  796. Looks up a localized string similar to Data cannot be sent because the WebSocket connection is reconnecting..
  797. </summary>
  798. </member>
  799. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_IncompatibleProtocolVersion">
  800. <summary>
  801. Looks up a localized string similar to You are using a version of the client that isn&apos;t compatible with the server. Client version {0}, server version {1}..
  802. </summary>
  803. </member>
  804. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_InvalidUriScheme">
  805. <summary>
  806. Looks up a localized string similar to Uri scheme &apos;{0}&apos; is not valid. The only valid uri schemes are &apos;http&apos; and &apos;https&apos;..
  807. </summary>
  808. </member>
  809. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_PossibleDeadlockDetected">
  810. <summary>
  811. Looks up a localized string similar to Possible deadlock detected. A callback registered with &quot;HubProxy.On&quot; or &quot;Connection.Received&quot; has been executing for at least {0} seconds..
  812. </summary>
  813. </member>
  814. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ProcessResponseBeforeStart">
  815. <summary>
  816. Looks up a localized string similar to The ProcessResponse method cannot be called before the transport is started..
  817. </summary>
  818. </member>
  819. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ProxiesCannotBeAddedConnectionStarted">
  820. <summary>
  821. Looks up a localized string similar to A HubProxy cannot be added after the connection has been started..
  822. </summary>
  823. </member>
  824. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ReconnectTimeout">
  825. <summary>
  826. Looks up a localized string similar to Couldn&apos;t reconnect within the configured timeout of {0}, disconnecting..
  827. </summary>
  828. </member>
  829. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ReconnectWindowTimeout">
  830. <summary>
  831. Looks up a localized string similar to The client has been inactive since {0} and it has exceeded the inactivity timeout of {1}. Stopping the connection..
  832. </summary>
  833. </member>
  834. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_ServerNegotiationFailed">
  835. <summary>
  836. Looks up a localized string similar to Server negotiation failed..
  837. </summary>
  838. </member>
  839. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_StartFailed">
  840. <summary>
  841. Looks up a localized string similar to Error during start request. Stopping the connection..
  842. </summary>
  843. </member>
  844. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_TaskCancelledException">
  845. <summary>
  846. Looks up a localized string similar to Request failed - task cancelled..
  847. </summary>
  848. </member>
  849. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_TransportCannotBeReused">
  850. <summary>
  851. Looks up a localized string similar to The transport instance passed to the Negotiate method has already been used. Use a new transport instance each time you start a new connection..
  852. </summary>
  853. </member>
  854. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_TransportFailedToConnect">
  855. <summary>
  856. Looks up a localized string similar to Transport failed trying to connect..
  857. </summary>
  858. </member>
  859. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_TransportTimedOutTryingToConnect">
  860. <summary>
  861. Looks up a localized string similar to Transport timed out trying to connect.
  862. </summary>
  863. </member>
  864. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Error_UrlCantContainQueryStringDirectly">
  865. <summary>
  866. Looks up a localized string similar to Url cannot contain query string directly. Pass query string values in using available overload..
  867. </summary>
  868. </member>
  869. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Message_ConnectionClosed">
  870. <summary>
  871. Looks up a localized string similar to Connection was disconnected before invocation result was received..
  872. </summary>
  873. </member>
  874. <member name="P:Microsoft.AspNet.SignalR.Client.Resources.Message_Reconnecting">
  875. <summary>
  876. Looks up a localized string similar to Connection started reconnecting before invocation result was received..
  877. </summary>
  878. </member>
  879. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.#ctor(System.IO.Stream)">
  880. <summary>
  881. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader"/> class.
  882. </summary>
  883. <param name="stream">The stream to read asynchronously payloads from.</param>
  884. </member>
  885. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.Start">
  886. <summary>
  887. Starts the reader.
  888. </summary>
  889. </member>
  890. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.Close">
  891. <summary>
  892. Closes the connection and the underlying stream.
  893. </summary>
  894. </member>
  895. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.Opened">
  896. <summary>
  897. Invoked when the stream is open.
  898. </summary>
  899. </member>
  900. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.Closed">
  901. <summary>
  902. Invoked when the reader is closed while in the Processing state.
  903. </summary>
  904. </member>
  905. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.AsyncStreamReader.Data">
  906. <summary>
  907. Invoked when there's a message if received in the stream.
  908. </summary>
  909. </member>
  910. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.ClientTransportBase.Name">
  911. <summary>
  912. Gets transport name.
  913. </summary>
  914. </member>
  915. <member name="T:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEvents.EventSourceStreamReader">
  916. <summary>
  917. Event source implementation for .NET. This isn't to the spec but it's enough to support SignalR's
  918. server.
  919. </summary>
  920. </member>
  921. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEvents.EventSourceStreamReader.#ctor(Microsoft.AspNet.SignalR.Client.IConnection,System.IO.Stream)">
  922. <summary>
  923. Initializes a new instance of the <see cref="T:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEvents.EventSourceStreamReader"/> class.
  924. </summary>
  925. <param name="connection">The connection associated with this event source</param>
  926. <param name="stream">The stream to read event source payloads from.</param>
  927. </member>
  928. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEvents.EventSourceStreamReader.Message">
  929. <summary>
  930. Invoked when there's a message if received in the stream.
  931. </summary>
  932. </member>
  933. <member name="T:Microsoft.AspNet.SignalR.Client.StateChange">
  934. <summary>
  935. Represents a change in the connection state.
  936. </summary>
  937. </member>
  938. <member name="M:Microsoft.AspNet.SignalR.Client.StateChange.#ctor(Microsoft.AspNet.SignalR.Client.ConnectionState,Microsoft.AspNet.SignalR.Client.ConnectionState)">
  939. <summary>
  940. Creates a new stance of <see cref="T:Microsoft.AspNet.SignalR.Client.StateChange"/>.
  941. </summary>
  942. <param name="oldState">The old state of the connection.</param>
  943. <param name="newState">The new state of the connection.</param>
  944. </member>
  945. <member name="P:Microsoft.AspNet.SignalR.Client.StateChange.OldState">
  946. <summary>
  947. Gets the old state of the connection.
  948. </summary>
  949. </member>
  950. <member name="P:Microsoft.AspNet.SignalR.Client.StateChange.NewState">
  951. <summary>
  952. Gets the new state of the connection.
  953. </summary>
  954. </member>
  955. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.AutoTransport.SupportsKeepAlive">
  956. <summary>
  957. Indicates whether or not the active transport supports keep alive
  958. </summary>
  959. </member>
  960. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.StartPolling(Microsoft.AspNet.SignalR.Client.IConnection,System.String)">
  961. <summary>
  962. Starts the polling loop.
  963. </summary>
  964. </member>
  965. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.StopPolling">
  966. <summary>
  967. Fully stops the polling loop.
  968. </summary>
  969. </member>
  970. <member name="M:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.LostConnection(Microsoft.AspNet.SignalR.Client.IConnection)">
  971. <summary>
  972. Aborts the currently active polling request thereby forcing a reconnect.
  973. </summary>
  974. </member>
  975. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.ReconnectDelay">
  976. <summary>
  977. The time to wait after a connection drops to try reconnecting.
  978. </summary>
  979. </member>
  980. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.ErrorDelay">
  981. <summary>
  982. The time to wait after an error happens to continue polling.
  983. </summary>
  984. </member>
  985. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.LongPollingTransport.SupportsKeepAlive">
  986. <summary>
  987. Indicates whether or not the transport supports keep alive
  988. </summary>
  989. </member>
  990. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEventsTransport.SupportsKeepAlive">
  991. <summary>
  992. Indicates whether or not the transport supports keep alive
  993. </summary>
  994. </member>
  995. <member name="P:Microsoft.AspNet.SignalR.Client.Transports.ServerSentEventsTransport.ReconnectDelay">
  996. <summary>
  997. The time to wait after a connection drops to try reconnecting.
  998. </summary>
  999. </member>
  1000. </members>
  1001. </doc>