Connection Class

.NET Framework 4.5

Provides client connections for SignalR services.

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 Connection : IConnection, 
	IDisposable

The Connection type exposes the following members.

  NameDescription
Public methodConnection(String)Initializes a new instance of the Connection class.
Public methodConnection(String, IDictionary<String, String>)Initializes a new instance of the Connection class.
Public methodConnection(String, String)Initializes a new instance of the Connection class.
Top

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

  NameDescription
Public methodAddClientCertificateAdds a client certificate to the request.
Public methodDispose()Stop the connection, equivalent to calling connection stop.
Protected methodDispose(Boolean)Stop the connection, equivalent to calling connection stop.
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
Protected methodOnMessageReceivedCalled when the Connection has received message from the server.
Public methodOnReconnecting
Protected methodOnSendingCalled when the Connection sends an alert or reminder notifications.
Public methodSend(Object)Sends an object that will be JSON serialized asynchronously over the connection.
Public methodSend(String)Sends data asynchronously over the connection.
Public methodStart()Starts the Connection.
Public methodStart(IClientTransport)Starts the Connection.
Public methodStart(IHttpClient)Starts the Connection.
Public methodStop()Stops the Connection and sends an abort message to the server.
Public methodStop(TimeSpan)Stops the Connection and sends an abort message to the server. <param name="timeout">The timeout</param>.
Public methodToString (Inherited from Object.)
Public methodTraceTraces a connection method that is specified by the parameters.
Top

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

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

No content here will be updated; please do not add material here.

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: