ServerDomain class
The server domain contains API's related to the execution of the server.
Constructors
- ServerDomain(AnalysisServer server)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
finalinherited
-
onConnected
→ Stream<
ServerConnected> -
Reports that the server is running. This notification is issued once after
the server has started running but before any requests are processed to
let the client know that it started correctly.
no setter
-
onError
→ Stream<
ServerError> -
Reports that an unexpected error has occurred while executing the server.
This notification is not used for problems with specific requests (which
are returned as part of the response) but is used for exceptions that
occur while performing other tasks, such as analysis or preparing
notifications.
no setter
-
onLog
→ Stream<
ServerLog> -
The stream of entries describing events happened in the server.
no setter
-
onStatus
→ Stream<
ServerStatus> -
Reports the current status of the server. Parameters are omitted if there
has been no change in the status represented by that parameter.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- server → AnalysisServer
-
finalinherited
Methods
-
cancelRequest(
String id) → Future - Requests cancellation of a request sent by the client by id. This is provided on a best-effort basis and there is no guarantee the server will be able to cancel any specific request. The server will still always produce a response to the request even in the case of cancellation, but clients should discard any results of any cancelled request because they may be incomplete or inaccurate. This request always completes without error regardless of whether the request is successfully cancelled.
-
getVersion(
) → Future< VersionResult> - Return the version number of the analysis server.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setSubscriptions(
List< String> subscriptions) → Future - Subscribe for services. All previous subscriptions are replaced by the given set of services.
-
shutdown(
) → Future - Cleanly shutdown the analysis server. Requests that are received after this request will not be processed. Requests that were received before this request, but for which a response has not yet been sent, will not be responded to. No further responses or notifications will be sent after the response to this request has been sent.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited