Page Loader
API
Generated with
Page Loader/com.alecdorrington.pageloader/com.alecdorrington.pageloader.tapir/HeartbeatApi

HeartbeatApi

com.alecdorrington.pageloader.tapir.HeartbeatApi
class HeartbeatApi(path: EndpointInput[Unit] = ...)

A Tapir endpoint definition for responding to heartbeat messages using a WebSocket.

This is the cross-platform base for HeartbearService, which adds the server-side logic on JVM.

Value parameters

path

The URL path at which the endpoint is mounted.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HeartbeatService[F]

Members list

Value members

Concrete methods

def publicEndpoint[S <: Streams[S]](stream: S): Endpoint[Unit, Unit, Unit, stream.Pipe[String, String], S & WebSockets]

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.

Concrete fields

val index: Endpoint[Unit, Unit, Unit, String, Any]
Generated with