root
API
Generated with
root/org.sigilaris/org.sigilaris.node/org.sigilaris.node.jvm/org.sigilaris.node.jvm.transport.armeria

org.sigilaris.node.jvm.transport.armeria

package org.sigilaris.node.jvm.transport.armeria

Members list

Packages

package org.sigilaris.node.jvm.transport.armeria.gossip
package org.sigilaris.node.jvm.transport.armeria.txpipeline

Type members

Classlikes

object ArmeriaServer

Factory for building and managing Armeria HTTP servers backed by Tapir endpoints.

Factory for building and managing Armeria HTTP servers backed by Tapir endpoints.

Attributes

Source
ArmeriaServer.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ArmeriaServerConfig(port: Int, maxRequestLength: Long, requestTimeout: Duration)

Configuration for an Armeria HTTP server instance.

Configuration for an Armeria HTTP server instance.

Value parameters

maxRequestLength

maximum allowed request body size in bytes (default 128 MiB)

port

the TCP port to listen on

requestTimeout

global maximum duration to wait for a request to complete (default 10 minutes). Do not set this to zero for a mixed finite/streaming production assembly; long-lived streams need a route-specific timeout override so finite endpoints keep their generic timeout guard.

Attributes

Source
ArmeriaServer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class OpenApiExportConfig(output: Path, format: OpenApiFormat, title: String, version: String)

Configuration for exporting an OpenAPI specification document.

Configuration for exporting an OpenAPI specification document.

Value parameters

format

output format (YAML or JSON)

output

file path where the specification will be written

title

API title included in the specification

version

API version string included in the specification

Attributes

Source
TapirOpenApiExporter.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum OpenApiFormat

Supported output formats for OpenAPI specification documents.

Supported output formats for OpenAPI specification documents.

Attributes

Source
TapirOpenApiExporter.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TapirOpenApiExporter

Generates and writes OpenAPI specification documents from Tapir endpoint definitions.

Generates and writes OpenAPI specification documents from Tapir endpoint definitions.

Attributes

Source
TapirOpenApiExporter.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with