BaseWebSocketClient class Null safety

An Angel client that operates across WebSockets.

Inheritance
Implementers

Constructors

BaseWebSocketClient(BaseClient client, dynamic baseUrl, {bool reconnectOnClose = true, Duration? reconnectInterval})

Properties

authToken String?
A mutable member. When this is set, it holds a JSON Web Token that is automatically attached to every request sent. [...]
read / write, inherited
basePath String
Prefer to use baseUrl instead.
read-only, inherited
baseUrl Uri
The root URL at which the target server.
final, inherited
client BaseClient
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
on WebSocketExtraneousEventHandler
Use this to handle events that are not standard.
final
onAllEvents Stream<WebSocketEvent>
Fired on all events.
read-only
onAuthenticated Stream<AngelAuthResult>
Fired whenever a WebSocket is successfully authenticated.
read-only, override
onData Stream
A broadcast stream of data coming from the socket. [...]
read-only
onError Stream<AngelHttpException>
Fired on errors.
read-only
onServiceEvent Stream<Map<String, WebSocketEvent>>
Fired whenever an event is fired by a service.
read-only
onWebSocketChannelException Stream<WebSocketChannelException>
Fired on WebSocketChannelExceptions.
read-only
reconnectInterval Duration?
The amount of time to wait between reconnect attempts. Default: 10 seconds.
read-only
reconnectOnClose bool
If true (default), then the client will automatically try to reconnect to the server if the socket closes.
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
socket WebSocketChannel?
The WebSocketChannel underneath this instance.
read-only
websocketUri Uri
The Uri to which a websocket should point.
read-only

Methods

authenticate({String? type, dynamic credentials, String authEndpoint = '/auth', String reviveEndpoint = '/auth/token'}) Future<AngelAuthResult>
Authenticates against the server. [...]
inherited
authenticateViaJwt(String? jwt) → void
Attempts to authenticate a WebSocket, using a valid JWT.
authenticateViaPopup(String url, {String eventName = 'token'}) Stream<String>
Opens the url in a new window, and returns a Stream that will fire a JWT on successful authentication.
inherited
close() Future
Disposes of any outstanding resources.
override
configure(AngelConfigurer configurer) Future<void>
Applies an AngelConfigurer to this instance.
inherited
connect({Duration? timeout}) Future<WebSocketChannel?>
Connects the WebSocket. timeout is optional.
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL. [...]
inherited
get(Uri url, {Map<String, String>? headers}) Future<Response>
Sends an HTTP GET request with the given headers to the given URL. [...]
inherited
getConnectedWebSocket() Future<WebSocketChannel>
Returns a new WebSocketChannel, ready to be listened on. [...]
Sends an HTTP HEAD request with the given headers to the given URL. [...]
inherited
listen() → void
Starts listening for data.
logout() Future<void>
Logs the current user out of the application.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
patch(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL. [...]
inherited
post(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL. [...]
inherited
put(Uri url, {Object? body, Map<String, String>? headers, Encoding? encoding}) Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL. [...]
inherited
read(Uri url, {Map<String, String>? headers}) Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String. [...]
inherited
readBytes(Uri url, {Map<String, String>? headers}) Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes. [...]
inherited
reviveJwt(String token, {String authEndpoint = '/auth'}) Future<AngelAuthResult>
Shorthand for authenticating via a JWT string.
inherited
send(BaseRequest request) Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response. [...]
inherited
sendAction(WebSocketAction action) → void
Sends the given action on the socket.
sendUnstreamed(String method, dynamic url, Map<String, String>? headers, [dynamic body, Encoding? encoding]) Future<Response>
Sends a non-streaming Request and returns a non-streaming Response.
inherited
serialize(dynamic x) → dynamic
Serializes data to JSON.
service<Id, Data>(String path, {Type? type, AngelDeserializer<Data>? deserializer}) Service<Id, Data>
Creates a Service instance that queries a given path on the server. [...]
override
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited