Peer object allows easily interacting with connected clients.
- Implemented types
- Available extensions
Properties
- app → Spry
-
Available on Event, provided by the EventApp extension
Returns the Spry instance for the request event.no setter - extensions → String
-
Returns the websocket cliend-side request extensions.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- headers → Headers
-
Available on Event, provided by the EventHeaders extension
Access to the normalized request Headers.no setter - locals → Locals
-
Returns current request event locals.
no setterinherited
- method → String
-
Available on Event, provided by the EventMethod extension
Access to the normalized (uppercase) request method.no setter - params → Params
-
Available on Event, provided by the EventParams extension
Returns the Params of dynamic routing.no setter - protocol → String?
-
Returns the websocket selected protocol.
no setter
- readyState → ReadyState
-
Returns websocket ReadyState.
no setter
- request → Request
-
Return the request object for the request event.
no setterinherited
- route → Route?
-
Available on Event, provided by the EventRoute extension
Return Route, when the route has not yet started matching or has not been matched to return null, usually this situation is when the route is registered and has entered the fallback processor.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uri → Uri
-
Available on Event, provided by the EventURI extension
The requested URI for the request event.no setter
Methods
-
close(
[int? code, String? reason]) → Future - Close websocket connect.
-
getClientAddress(
) → String -
Available on Event, provided by the EventGetClientAddress extension
Returns client address. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
send(
Uint8List message) → void -
Send a bytes
messageto the connected client -
sendText(
String message) → void - Send a String message to the connected client.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited