HubConnection Class

.NET Framework 4

A Connection for interacting with Hubs.

Inheritance Hierarchy

System.Object
  Microsoft.AspNet.SignalR.Client.Connection
    Microsoft.AspNet.SignalR.Client.Hubs.HubConnection

Namespace:  Microsoft.AspNet.SignalR.Client.Hubs
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
	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
	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.)
	Items	Gets a dictionary for storing state for the connection. (Inherited from Connection.)
	MessageId	Gets or sets the last message id for the connection. (Inherited from Connection.)
	Proxy	Gets of sets 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.)
	Transport	(Inherited from Connection.)
	Url	Gets the url for the connection. (Inherited from Connection.)

Top

Methods

	Name	Description
	CreateHubProxy	Creates an IHubProxy for the hub with the specified name.
	Disconnect	Stops the Connection without sending an abort message to the server. (Inherited from Connection.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	OnMessageReceived	(Overrides Connection.OnMessageReceived(JToken).)
	OnSending	(Overrides Connection.OnSending().)
	RegisterCallback
	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.)
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	Closed	Occurs when the Connection is stopped. (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
	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.)

Top

Explicit Interface Implementations

	Name	Description
	IConnection.ChangeState	(Inherited from Connection.)
	IConnection.OnError	(Inherited from Connection.)
	IConnection.OnReceived	(Inherited from Connection.)
	IConnection.OnReconnected	(Inherited from Connection.)
	IConnection.OnReconnecting	(Inherited from Connection.)
	IConnection.PrepareRequest	(Inherited from Connection.)

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.

See Also

Reference

Microsoft.AspNet.SignalR.Client.Hubs Namespace