What a build contains

What a build of an application with spring_boot_starter_websocket contains, and when something is not in it. A module that follows a key reads it when build_runner runs, from application.yml or application.properties without a profile (see Modules left out of the build). The modules of the packages it depends on come with it: for spring_boot_dart, see Auto-configuration.

Always in

No build: and no platform:: in every build of an application that depends on the starter.

Module What it holds
springBootStarterWebsocketAutoConfiguration The beans behind @WebSocketClient interfaces (the transport and the client factory), behind @PhoenixChannel interfaces (the socket factory and the channel factory) and behind server endpoints (the handshake mapping and the registry of open sessions).

By platform

platform:: the module is only in the build of that platform; no property is read.

Module Platform What it holds
springBootStarterWebsocketServerAutoConfiguration native The server side: the open sessions and the mapping of the endpoints' handshakes, which the web starter's dispatcher asks.

native: builds where dart:io exists (a server, an AOT executable, a Flutter app on a phone or a desktop), not a browser build. server: native without Flutter, never a Flutter app. -DSPRING_ALL_PLATFORMS=true keeps every module.

What the generator writes for it

A part of the generator (see Starter parts) runs only when the application reaches its package.

Part or builder What it does
WebSocket part (spring_boot_starter_websocket) Writes nothing: says what an endpoint's handlers do with their values, and which classes the build describes for sendJson(value) and broadcast(pattern, value).
Through its dependencies The web part, since the starter depends on spring_web_dart.

Good to know

See also