HeartbeatService
A Tapir service for responding to heartbeat messages using a WebSocket.
Responds to every incoming WebSocket message with "ok".
Type parameters
- F
-
The effect type (e.g.
FutureorIO).
Value parameters
- path
-
The URL path at which the endpoint is mounted.
Attributes
- Graph
-
- Supertypes
-
trait TapirService[WebSockets & Fs2Streams[F], F]class HeartbeatApiclass Objecttrait Matchableclass Any
Members list
Type members
Inherited types
The upper bound on the type of all API endpoints in this service.
The upper bound on the type of all API endpoints in this service.
Attributes
- Inherited from:
- TapirService
Value members
Concrete methods
A list of all endpoints implemented in this service.
A list of all endpoints implemented in this service.
Attributes
- Definition Classes
-
TapirService
A server endpoint that replies "ok" to every incoming WebSocket message.
A server endpoint that replies "ok" to every incoming WebSocket message.
Attributes
- Returns
-
A server endpoint requiring WebSockets and Fs2Streams capabilities.
Inherited methods
The public endpoint definition.
The public endpoint definition.
Value parameters
- stream
-
The streams capability to use for the WebSocket body.
Attributes
- Returns
-
An endpoint that accepts and produces plain-text WebSocket messages.
- Inherited from:
- HeartbeatApi
Inherited fields
All endpoints combined from api, docs, and metrics.
All endpoints combined from api, docs, and metrics.
Attributes
- Inherited from:
- TapirService
Swagger documentation for this service.
Attributes
- Inherited from:
- HeartbeatApi
Prometheus metrics for this service.