microsoft.aspnet.signalr.client.transport

Interface ClientTransport

All Known Implementing Classes:

AutomaticTransport, HttpClientTransport, LongPollingTransport, ServerSentEventsTransport, WebsocketTransport

public interface ClientTransport

Represents a client implementation of a network transport

Method Summary

Modifier and Type	Method and Description
SignalRFuture<Void>	abort(ConnectionBase connection) Aborts the transport
String	getName() Transport name
SignalRFuture<NegotiationResponse>	negotiate(ConnectionBase connection) Begins the negotiation with the server
SignalRFuture<Void>	send(ConnectionBase connection, String data, DataResultCallback callback) Sends data using the transport
SignalRFuture<Void>	start(ConnectionBase connection, ConnectionType connectionType, DataResultCallback callback) Starts the transport
boolean	supportKeepAlive() True if the transport supports keepalive messages

Method Detail

getName

String getName()

Transport name

Returns:

String

supportKeepAlive

boolean supportKeepAlive()

True if the transport supports keepalive messages

Returns:

boolean

negotiate

SignalRFuture<NegotiationResponse> negotiate(ConnectionBase connection)

Begins the negotiation with the server

Parameters:

connection - Connection information to do the negotiation

Returns:

A Future for the operation

start

SignalRFuture<Void> start(ConnectionBase connection,
                          ConnectionType connectionType,
                          DataResultCallback callback)

Starts the transport

Parameters:

connection - Connection information to start the transport

connectionType - Connection type

callback - Callback to invoke when there is new data

Returns:

A Future for the operation

send

SignalRFuture<Void> send(ConnectionBase connection,
                         String data,
                         DataResultCallback callback)

Sends data using the transport

Parameters:

connection - Connection information to send data

data - data to send

callback - Callback to invoke when data is returned

Returns:

A Future for the operation

abort

SignalRFuture<Void> abort(ConnectionBase connection)

Aborts the transport

Parameters:

connection - Connection information to abort

Returns:

A Future for the operation