HubConnection Class
.NET Framework 4.5
A Connection for interacting with Hubs.
Inheritance Hierarchy
System.Object
Microsoft.AspNet.SignalR.Client.Connection
Microsoft.AspNet.SignalR.Client.HubConnection
Namespace: Microsoft.AspNet.SignalR.Client
Assembly: Microsoft.AspNet.SignalR.Client (in Microsoft.AspNet.SignalR.Client.dll)
Syntax
'Declaration
Public Class HubConnection _
Inherits Connection _
Implements IHubConnection, IConnection
'Usage
Dim instance As HubConnection
public class HubConnection : Connection,
IHubConnection, IConnection
public ref class HubConnection : public Connection,
IHubConnection, IConnection
type HubConnection =
class
inherit Connection
interface IHubConnection
interface IConnection
end
public class HubConnection extends Connection implements IHubConnection, IConnection
The HubConnection type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.jpeg "Public method") |
HubConnection(String) | Initializes a new instance of the HubConnection class. |
|
HubConnection(String, Boolean) | Initializes a new instance of the HubConnection class. |
|
HubConnection(String, IDictionary<String, String>) | Initializes a new instance of the HubConnection class. |
|
HubConnection(String, String) | Initializes a new instance of the HubConnection class. |
|
HubConnection(String, IDictionary<String, String>, Boolean) | Initializes a new instance of the HubConnection class. |
|
HubConnection(String, String, Boolean) | Initializes a new instance of the HubConnection class. |
Top
Properties
| Name | Description | |
|---|---|---|
.jpeg "Public property") |
ConnectionId | Gets or sets the connection id for the connection. (Inherited from Connection.) |
|
ConnectionToken | Gets or sets the connection token for the connection. (Inherited from Connection.) |
|
CookieContainer | Gets or sets the cookies associated with the connection. (Inherited from Connection.) |
|
Credentials | Gets or sets authentication information for the connection. (Inherited from Connection.) |
|
GroupsToken | Gets or sets the groups token for the connection. (Inherited from Connection.) |
|
Headers | Gets or sets the headers for the requests (Inherited from Connection.) |
|
Items | Gets a dictionary for storing state for the connection. (Inherited from Connection.) |
|
JsonSerializer | Gets or sets the serializer used by the connection. (Inherited from Connection.) |
|
MessageId | Gets or sets the last message id for the connection. (Inherited from Connection.) |
|
Protocol | Gets or sets the protocol for the connection. (Inherited from Connection.) |
|
Proxy | Gets or sets the proxy information for the connection. (Inherited from Connection.) |
|
QueryString | Gets the query string specified in the constructor. (Inherited from Connection.) |
|
State | Gets the current ConnectionState of the connection. (Inherited from Connection.) |
|
TraceLevel | Gets or sets the trace level for the connection. (Inherited from Connection.) |
|
TraceWriter | Gets or sets the text writer to trace the connection. (Inherited from Connection.) |
|
Transport | Gets or sets the client transport for the connection. (Inherited from Connection.) |
|
TransportConnectTimeout | Gets or sets a TimeSpan representing the amount of time to transport connection before timing out. (Inherited from Connection.) |
|
Url | Gets or sets the url for the connection. (Inherited from Connection.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddClientCertificate | Adds a client certificate to the request. (Inherited from Connection.) |
|
CreateHubProxy | Creates an IHubProxy for the hub with the specified name. |
|
Dispose() | Stop the connection, equivalent to calling connection stop. (Inherited from Connection.) |
.jpeg "Protected method") |
Dispose(Boolean) | Stop the connection, equivalent to calling connection stop. (Inherited from Connection.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnClosed | (Overrides Connection.OnClosed().) |
|
OnMessageReceived | (Overrides Connection.OnMessageReceived(JToken).) |
|
OnReconnecting | (Overrides Connection.OnReconnecting().) |
|
OnSending | (Overrides Connection.OnSending().) |
|
Send(Object) | Sends an object that will be JSON serialized asynchronously over the connection. (Inherited from Connection.) |
|
Send(String) | Sends data asynchronously over the connection. (Inherited from Connection.) |
|
Start() | Starts the Connection. (Inherited from Connection.) |
|
Start(IClientTransport) | Starts the Connection. (Inherited from Connection.) |
|
Start(IHttpClient) | Starts the Connection. (Inherited from Connection.) |
|
Stop() | Stops the Connection and sends an abort message to the server. (Inherited from Connection.) |
|
Stop(TimeSpan) | Stops the Connection and sends an abort message to the server. <param name="timeout">The timeout</param>. (Inherited from Connection.) |
|
ToString | (Inherited from Object.) |
|
Trace | Traces a connection method that is specified by the parameters. (Inherited from Connection.) |
Top
Events
| Name | Description | |
|---|---|---|
.jpeg "Public event") |
Closed | Occurs when connection is stopped. (Inherited from Connection.) |
|
ConnectionSlow | Occurs when the Connection is about to timeout. (Inherited from Connection.) |
|
Error | Occurs when the Connection has encountered an error. (Inherited from Connection.) |
|
Received | Occurs when the Connection has received data from the server. (Inherited from Connection.) |
|
Reconnected | Occurs when the Connection successfully reconnects after a timeout. (Inherited from Connection.) |
|
Reconnecting | Occurs when the Connection starts reconnecting after an error. (Inherited from Connection.) |
|
StateChanged | Occurs when the Connection state changes. (Inherited from Connection.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "Public Extension Method") |
AsObservable() | Overloaded. (Defined by ConnectionExtensions.) |
|
AsObservable<T>() | Overloaded. (Defined by ConnectionExtensions.) |
|
AsObservable<T>(Func<String, T>) | Overloaded. (Defined by ConnectionExtensions.) |
|
EnsureReconnecting | (Defined by ConnectionExtensions.) |
|
GetValue<T> | (Defined by ConnectionExtensions.) |
|
JsonDeserializeObject<T> | (Defined by ConnectionExtensions.) |
|
JsonSerializeObject | (Defined by ConnectionExtensions.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.jpeg "Explicit interface implemetation") .gif "Private property") |
IConnection.Certificates | Gets a collection that stores X509Certificate objects. (Inherited from Connection.) |
.jpeg "Private method") |
IConnection.ChangeState | Called when the connection to change state. (Inherited from Connection.) |
|
IConnection.Disconnect | Stops the Connection without sending an abort message to the server. This function is called after we receive a disconnect message from the server. (Inherited from Connection.) |
|
IConnection.KeepAliveData | Gets or sets an object to store the various keep alive timeout values. (Inherited from Connection.) |
|
IConnection.OnConnectionSlow | Called when the Connection is about to timeout. (Inherited from Connection.) |
|
IConnection.OnError | Called when the Connection has encountered an error. (Inherited from Connection.) |
|
IConnection.OnReceived | Called when the Connection has received data from the server. (Inherited from Connection.) |
|
IConnection.OnReconnected | Called when the Connection successfully reconnects after a timeout. (Inherited from Connection.) |
|
IConnection.PrepareRequest | Prepares all request for the Connection. (Inherited from Connection.) |
|
IConnection.UpdateLastKeepAlive | Sets LastKeepAlive to the current time. (Inherited from Connection.) |
|
IHubConnection.RegisterCallback | |
|
IHubConnection.RemoveCallback |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.