Annotation Interface SocketEndpoint

@Documented
@Target(TYPE)
@Retention(RUNTIME)
@Inherited
public @interface SocketEndpoint

Declares a WebSocket endpoint that represents a single active client session.

This annotation is used on handler classes with annotations like HandleSocketMessage that manage WebSocket communication and lifecycle events (e.g. handshake, open, message, close).

Fluxzero creates a new endpoint instance per WebSocket session. Non-socket handlers on the same endpoint, such as @HandleEvent, may also use Association to target only endpoint instances whose state matches the incoming message instead of invoking every active session. In Spring applications, endpoint types become active when they fall within the application's component-scan scope, but they are not exposed as regular injectable Spring beans. Type-level conditional annotations are still respected, including ConditionalOnProperty and ConditionalOnMissingProperty.

See Also:

• HandleSocketOpen
• HandleSocketMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	SocketEndpoint.AliveCheck	Controls periodic keep-alive pings to detect inactive sessions.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
SocketEndpoint.AliveCheck	aliveCheck	Configures the WebSocket session keep-alive mechanism (ping/pong).

Element Details

aliveCheck

SocketEndpoint.AliveCheck aliveCheck

Configures the WebSocket session keep-alive mechanism (ping/pong).

Default:

@io.fluxzero.sdk.web.SocketEndpoint.AliveCheck