ServerInterface class abstract
- Implemented types
- Implementers
Constructors
- ServerInterface({required AutonomyInterface collection, bool quiet = false})
Properties
- collection → AutonomyInterface
-
final
- destination ↔ SocketInfo?
-
The destination port to send to.
getter/setter pairinherited
- device → Device
-
The rover device this socket represents.
finalinherited
- didReceivedHeartbeat ↔ bool
-
Whether this socket received a heartbeat since the last call to checkHeartbeats.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- heartbeatInterval → Duration
-
How often to check for heartbeats.
no setterinherited
- heartbeatTimer ↔ Timer?
-
A timer to call checkHeartbeats every heartbeatInterval.
getter/setter pairinherited
- isConnected → bool
-
Whether the socket is connected to the intended device(s).
no setterinherited
- logger → BurtLogger
-
A logger to capture important events during operation.
finalinherited
- port ↔ int?
-
The port this socket is listening on. See RawDatagramSocket.bind.
getter/setter pairinherited
- quiet → bool
-
Whether to silence "normal" output, like opening/closing and resetting sockets.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
checkHeartbeats(
) → Future< void> -
Checks if a heartbeat has been received. If not, calls onDisconnect.
inherited
-
dispose(
) → Future< void> -
Closes the socket.
inherited
-
init(
) → Future< bool> -
Initializes the connection to the device.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onConnect(
SocketInfo source) → void -
Sets destination to the incoming
source.inherited -
onData(
Datagram packet) → void -
Override this function to process incoming data, along with the source address and port.
inherited
-
onDisconnect(
) → Future< void> -
Sends a
Disconnectmessage to the dashboard and sets destination tonull. -
onHeartbeat(
Connect heartbeat, SocketInfo source) → void -
Handles incoming heartbeats.
inherited
-
onMessage(
WrappedMessage wrapper) → void - Handles a non-heartbeat message, usually containing data or commands.
-
onShutdown(
) → Future< void> - Shuts down the program by disposing the collection.
-
onWrapper(
WrappedMessage wrapper, SocketInfo source) → void -
A callback for when messages are received.
inherited
-
restart(
) → Future< void> - Restarts this program, usually by disposing and re-initializing the collection.
-
sendCommand(
Message message) → void -
sendData(
List< int> data, {SocketInfo? destinationOverride}) → void -
Sends data to the given destination.
inherited
-
sendHeartbeatResponse(
) → void -
Responds to an incoming heartbeat.
inherited
-
sendLog(
BurtLog log) → void -
Sends a log message or saves it until a Dashboard is connected.
inherited
-
sendMessage(
Message message, {SocketInfo? destinationOverride}) → void -
Wraps a message and sends it with sendWrapper.
inherited
-
sendWrapper(
WrappedMessage wrapper, {SocketInfo? destinationOverride}) → void -
Sends an already-wrapped
WrappedMessageto the destination, or the givendestinationOverride.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
updateSettings(
UpdateSetting settings) → Future< void> -
Handles an
UpdateSettingcommand and updates the appropriate setting.inherited -
waitForConnection(
) → Future< void>
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- subsystemsDestination ↔ SocketInfo
-
getter/setter pair