HubConnection Class

.NET Framework 4.5

A Connection for interacting with Hubs.

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)

public ref class HubConnection : public Connection, 
	IHubConnection, IConnection

The HubConnection type exposes the following members.

  NameDescription
Public methodHubConnection(String)Initializes a new instance of the HubConnection class.
Public methodHubConnection(String, Boolean)Initializes a new instance of the HubConnection class.
Public methodHubConnection(String, IDictionary<String, String>)Initializes a new instance of the HubConnection class.
Public methodHubConnection(String, String)Initializes a new instance of the HubConnection class.
Public methodHubConnection(String, IDictionary<String, String>, Boolean)Initializes a new instance of the HubConnection class.
Public methodHubConnection(String, String, Boolean)Initializes a new instance of the HubConnection class.
Top

  NameDescription
Public propertyConnectionIdGets or sets the connection id for the connection. (Inherited from Connection.)
Public propertyConnectionTokenGets or sets the connection token for the connection. (Inherited from Connection.)
Public propertyCookieContainerGets or sets the cookies associated with the connection. (Inherited from Connection.)
Public propertyCredentialsGets or sets authentication information for the connection. (Inherited from Connection.)
Public propertyGroupsTokenGets or sets the groups token for the connection. (Inherited from Connection.)
Public propertyHeadersGets or sets the headers for the requests (Inherited from Connection.)
Public propertyItemsGets a dictionary for storing state for the connection. (Inherited from Connection.)
Public propertyJsonSerializerGets or sets the serializer used by the connection. (Inherited from Connection.)
Public propertyMessageIdGets or sets the last message id for the connection. (Inherited from Connection.)
Public propertyProtocolGets or sets the protocol for the connection. (Inherited from Connection.)
Public propertyProxyGets or sets the proxy information for the connection. (Inherited from Connection.)
Public propertyQueryStringGets the query string specified in the constructor. (Inherited from Connection.)
Public propertyStateGets the current ConnectionState of the connection. (Inherited from Connection.)
Public propertyTraceLevelGets or sets the trace level for the connection. (Inherited from Connection.)
Public propertyTraceWriterGets or sets the text writer to trace the connection. (Inherited from Connection.)
Public propertyTransportGets or sets the client transport for the connection. (Inherited from Connection.)
Public propertyTransportConnectTimeoutGets or sets a TimeSpan representing the amount of time to transport connection before timing out. (Inherited from Connection.)
Public propertyUrlGets or sets the url for the connection. (Inherited from Connection.)
Top

  NameDescription
Public methodAddClientCertificateAdds a client certificate to the request. (Inherited from Connection.)
Public methodCreateHubProxyCreates an IHubProxy for the hub with the specified name.
Public methodDispose()Stop the connection, equivalent to calling connection stop. (Inherited from Connection.)
Protected methodDispose(Boolean)Stop the connection, equivalent to calling connection stop. (Inherited from Connection.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnClosed (Overrides Connection::OnClosed().)
Protected methodOnMessageReceived (Overrides Connection::OnMessageReceived(JToken).)
Public methodOnReconnecting (Overrides Connection::OnReconnecting().)
Protected methodOnSending (Overrides Connection::OnSending().)
Public methodSend(Object)Sends an object that will be JSON serialized asynchronously over the connection. (Inherited from Connection.)
Public methodSend(String)Sends data asynchronously over the connection. (Inherited from Connection.)
Public methodStart()Starts the Connection. (Inherited from Connection.)
Public methodStart(IClientTransport)Starts the Connection. (Inherited from Connection.)
Public methodStart(IHttpClient)Starts the Connection. (Inherited from Connection.)
Public methodStop()Stops the Connection and sends an abort message to the server. (Inherited from Connection.)
Public methodStop(TimeSpan)Stops the Connection and sends an abort message to the server. <param name="timeout">The timeout</param>. (Inherited from Connection.)
Public methodToString (Inherited from Object.)
Public methodTraceTraces a connection method that is specified by the parameters. (Inherited from Connection.)
Top

  NameDescription
Public eventClosedOccurs when connection is stopped. (Inherited from Connection.)
Public eventConnectionSlowOccurs when the Connection is about to timeout. (Inherited from Connection.)
Public eventErrorOccurs when the Connection has encountered an error. (Inherited from Connection.)
Public eventReceivedOccurs when the Connection has received data from the server. (Inherited from Connection.)
Public eventReconnectedOccurs when the Connection successfully reconnects after a timeout. (Inherited from Connection.)
Public eventReconnectingOccurs when the Connection starts reconnecting after an error. (Inherited from Connection.)
Public eventStateChangedOccurs when the Connection state changes. (Inherited from Connection.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIConnection::CertificatesGets a collection that stores X509Certificate objects. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::ChangeStateCalled when the connection to change state. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::DisconnectStops 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.)
Explicit interface implemetationPrivate propertyIConnection::KeepAliveDataGets or sets an object to store the various keep alive timeout values. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::OnConnectionSlowCalled when the Connection is about to timeout. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::OnErrorCalled when the Connection has encountered an error. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::OnReceivedCalled when the Connection has received data from the server. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::OnReconnectedCalled when the Connection successfully reconnects after a timeout. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::PrepareRequestPrepares all request for the Connection. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIConnection::UpdateLastKeepAliveSets LastKeepAlive to the current time. (Inherited from Connection.)
Explicit interface implemetationPrivate methodIHubConnection::RegisterCallback
Explicit interface implemetationPrivate methodIHubConnection::RemoveCallback
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: