signalr_core library
An ASP.NET Core SignalR Dart Client
ASP.NET Core SignalR is an open-source library that simplifies adding real-time web functionality to apps. Real-time web functionality enables server-side code to push content to clients instantly.
Classes
- AvailableTransport
- CancelInvocationMessage
- A hub message sent to request that a streaming invocation be canceled.
- CloseMessage
- A hub message indicating that the sender is closing the connection.
- CompletionMessage
- A hub message representing the result of an invocation.
- Connection
- DefaultReconnectPolicy
- HandshakeProtocol
- HandshakeRequestMessage
- HandshakeResponseMessage
- HttpConnection
- HttpConnectionOptions
- Options provided to the 'withUrl' factory constructor on HubConnection to configure options for the HTTP-based transports.
- HubConnection
- Represents a connection to a SignalR Hub.
- HubConnectionBuilder
- A builder for configuring HubConnection instances.
- HubInvocationMessage
- Defines properties common to all Hub messages relating to a specific invocation.
- HubMessage
- Defines properties common to all Hub messages.
- HubProtocol
- A protocol abstraction for communicating with SignalR Hubs.
- InvocationMessage
- A hub message representing a non-streaming invocation.
- JsonHubProtocol
- Implements the JSON Hub Protocol.
- NegotiateResponse
- PingMessage
- A hub message indicating that the sender is still active.
- RetryContext
- RetryPolicy
- An abstraction that controls when the client attempts to reconnect and how many attempts to do so.
- StreamInvocationMessage
- A hub message representing a streaming invocation.
- StreamItemMessage
- A hub message representing a single item produced as part of a result stream.
- Transport
- An abstraction over the behavior of transports.
- TransportSendQueue
Enums
- ConnectionState
- HttpTransportType
- Specifies a specific HTTP transport type.
- HubConnectionState
- Describes the current state of the HubConnection to the server.
- LogLevel
-
Log Levels are ordered in increasing severity. So
Debugis more severe thanTrace, etc. - MessageType
- Defines the type of a Hub Message.
- TransferFormat
- Specifies the transfer format for a connection.
Mixins
Extensions
- AvailableTransportExtensions on AvailableTransport
- CancelInvocationMessageExtensions on CancelInvocationMessage
- CloseMessageExtensions on CloseMessage
- CompletionMessageExtensions on CompletionMessage
- HandshakeResponseMessageExtensions on HandshakeResponseMessage
- HttpTransportTypeExtensions on HttpTransportType
- InvocationMessageExtensions on InvocationMessage
- MessageTypeExtensions on MessageType?
- NegotiateResponseExtensions on NegotiateResponse
- PingMessageExtensions on PingMessage
- StreamInvocationMessageExtensions on StreamInvocationMessage
- StreamItemMessageExtensions on StreamItemMessage
- TransferFormatExtensions on TransferFormat
Constants
- DEFAULT_PING_INTERVAL_IN_MS → const int
- DEFAULT_TIMEOUT_IN_MS → const int
-
DefaultRetryDelaysInMilliseconds
→ const List<
int?> - jsonHubProtocolName → const String
- maxRedirects → const int
- version → const String
Functions
-
formatByteBuffer(
ByteBuffer data) → String -
getDataDetail(
dynamic data, bool? includeContent) → String -
getOsName(
) → String -
getRuntime(
) → String -
getRuntimeVersion(
) → String -
getUserAgentHeader(
) → Tuple2< String, String> -
sendMessage(
Logging? log, String transportName, BaseClient? client, String? url, AccessTokenFactory? accessTokenFactory, dynamic content, bool? logMessageContent, bool? withCredentials) → Future< void>
Typedefs
-
AccessTokenFactory
= Future<
String?> Function() - ClosedCallback = void Function(Exception? exception)
- InvocationEventCallback = void Function(HubMessage? invocationEvent, Exception? exception)
- Logging = void Function(LogLevel level, String message)
- MethodInvocationFunc = void Function(List? arguments)
- OnClose = void Function(Exception? error)
- OnReceive = void Function(dynamic data)
- ReconnectedCallback = void Function(String? connectionId)
- ReconnectingCallback = void Function(Exception? exception)