Connection Class

.NET Framework 4

Provides client connections for SignalR services.

Inheritance Hierarchy

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

Namespace:  Microsoft.AspNet.SignalR.Client
Assembly:  Microsoft.AspNet.SignalR.Client (in Microsoft.AspNet.SignalR.Client.dll)

Syntax

'Declaration
Public Class Connection _
    Implements IConnection
'Usage
Dim instance As Connection

public class Connection : IConnection

public ref class Connection : IConnection

type Connection =  
    class 
        interface IConnection 
    end

public class Connection implements IConnection

The Connection type exposes the following members.

Constructors

	Name	Description
	Connection(String)	Initializes a new instance of the Connection class.
	Connection(String, IDictionary<String, String>)	Initializes a new instance of the Connection class.
	Connection(String, String)	Initializes a new instance of the Connection class.

Top

Properties

	Name	Description
	ConnectionId	Gets or sets the connection id for the connection.
	ConnectionToken	Gets or sets the connection token for the connection.
	CookieContainer	Gets or sets the cookies associated with the connection.
	Credentials	Gets or sets authentication information for the connection.
	GroupsToken	Gets or sets the groups token for the connection.
	Items	Gets a dictionary for storing state for the connection.
	MessageId	Gets or sets the last message id for the connection.
	Proxy	Gets of sets proxy information for the connection.
	QueryString	Gets the query string specified in the constructor.
	State	Gets the current ConnectionState of the connection.
	Transport
	Url	Gets the url for the connection.

Top

Methods

	Name	Description
	Disconnect	Stops the Connection without sending an abort message to the server.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	OnMessageReceived
	OnSending
	Send(Object)	Sends an object that will be JSON serialized asynchronously over the connection.
	Send(String)	Sends data asynchronously over the connection.
	Start()	Starts the Connection.
	Start(IClientTransport)	Starts the Connection.
	Start(IHttpClient)	Starts the Connection.
	Stop	Stops the Connection and sends an abort message to the server.
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	Closed	Occurs when the Connection is stopped.
	Error	Occurs when the Connection has encountered an error.
	Received	Occurs when the Connection has received data from the server.
	Reconnected	Occurs when the Connection successfully reconnects after a timeout.
	Reconnecting	Occurs when the Connection starts reconnecting after an error.
	StateChanged	Occurs when the Connection state changes.

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
	IConnection.OnError
	IConnection.OnReceived
	IConnection.OnReconnected
	IConnection.OnReconnecting
	IConnection.PrepareRequest

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 Namespace