IHubConnection Interface
.NET Framework 4.5
Represents a hub connection.
Namespace: Microsoft.AspNet.SignalR.Client.Hubs
Assembly: Microsoft.AspNet.SignalR.Client (in Microsoft.AspNet.SignalR.Client.dll)
Syntax
'Declaration
Public Interface IHubConnection _
Inherits IConnection
'Usage
Dim instance As IHubConnection
public interface IHubConnection : IConnection
public interface class IHubConnection : IConnection
type IHubConnection =
interface
interface IConnection
end
public interface IHubConnection extends IConnection
The IHubConnection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.jpeg "Public property") |
Certificates | Gets the certificates of X509CertificateCollection for the IConnection. (Inherited from IConnection.) |
|
ConnectionId | Gets the connection id for the IConnection. (Inherited from IConnection.) |
|
ConnectionToken | Gets or sets the connection token for the IConnection. (Inherited from IConnection.) |
|
CookieContainer | Gets or sets the cookies associated with the IConnection. (Inherited from IConnection.) |
|
Credentials | Gets or sets the authentication information for the IConnection. (Inherited from IConnection.) |
|
GroupsToken | Gets or sets the groups token for the IConnection. (Inherited from IConnection.) |
|
Headers | Gets the headers for the requests. (Inherited from IConnection.) |
|
Items | Gets a dictionary for storing state for the IConnection. (Inherited from IConnection.) |
|
JsonSerializer | Gets the serializer used by the IConnection. (Inherited from IConnection.) |
|
KeepAliveData | Gets or sets the object to keep alive data for the IConnection. (Inherited from IConnection.) |
|
MessageId | Gets or sets the last message id for the IConnection. (Inherited from IConnection.) |
|
Protocol | Gets or sets the protocol for the IConnection. (Inherited from IConnection.) |
|
Proxy | Gets or sets the proxy information for the IConnection. (Inherited from IConnection.) |
|
QueryString | Gets the query string specified in the constructor. (Inherited from IConnection.) |
|
State | Gets the current ConnectionState of the IConnection. (Inherited from IConnection.) |
|
Transport | Gets the client transport for the IConnection. (Inherited from IConnection.) |
|
TransportConnectTimeout | Gets or sets a TimeSpan representing the amount of time to transport connection before timing out. (Inherited from IConnection.) |
|
Url | Gets the url for the IConnection. (Inherited from IConnection.) |
Top
Methods
| Name | Description | |
|---|---|---|
.jpeg "Public method") |
ChangeState | Called when the IConnection to change state. (Inherited from IConnection.) |
|
Disconnect | Stops the IConnection without sending an abort message to the server. This function is called after we receive a disconnect message from the server. (Inherited from IConnection.) |
|
OnConnectionSlow | Called when the IConnection is about to timeout. (Inherited from IConnection.) |
|
OnError | Called when the IConnection has encountered an error. (Inherited from IConnection.) |
|
OnReceived | Called when the IConnection has received data from the server. (Inherited from IConnection.) |
|
OnReconnected | Called when the IConnection successfully reconnects after a timeout. (Inherited from IConnection.) |
|
OnReconnecting | Called when the IConnection starts reconnecting after and error. (Inherited from IConnection.) |
|
PrepareRequest | Prepares all request for the IConnection. (Inherited from IConnection.) |
|
RegisterCallback | Registers a callback function for the hub connection. |
|
RemoveCallback | |
|
Send | Sends data asynchronously over the IConnection. (Inherited from IConnection.) |
|
Stop | Stops IConnection and sends an abort message to the server. (Inherited from IConnection.) |
|
Trace | Traces an IConnection method that is specified by the parameters. (Inherited from IConnection.) |
|
UpdateLastKeepAlive | Updates the object to store the various keep alive timeout values. (Inherited from IConnection.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "Public Extension Method") |
EnsureReconnecting | (Defined by ConnectionExtensions.) |
|
GetValue<T> | (Defined by ConnectionExtensions.) |
|
JsonDeserializeObject<T> | (Defined by ConnectionExtensions.) |
|
JsonSerializeObject | (Defined by ConnectionExtensions.) |
Top