Packages

final case class GrpcHealthServerConfig(address: String = "0.0.0.0", internalPort: Option[Port] = None, keepAliveServer: Option[BasicKeepAliveServerConfig] = Some( BasicKeepAliveServerConfig() ), jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, parallelism: Int = 4) extends ServerConfig with UniformCantonConfigValidation with Product with Serializable

Configuration of the gRPC health server for a canton node.

parallelism

number of threads to be used in the gRPC server

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcHealthServerConfig
  2. UniformCantonConfigValidation
  3. CustomCantonConfigValidation
  4. CantonConfigValidation
  5. ServerConfig
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GrpcHealthServerConfig(address: String = "0.0.0.0", internalPort: Option[Port] = None, keepAliveServer: Option[BasicKeepAliveServerConfig] = Some( BasicKeepAliveServerConfig() ), jwtTimestampLeeway: Option[JwtTimestampLeeway] = None, parallelism: Int = 4)

    parallelism

    number of threads to be used in the gRPC server

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val address: String

    The address of the interface to be listening on

    The address of the interface to be listening on

    Definition Classes
    GrpcHealthServerConfigServerConfig
  5. def adminTokenConfig: AdminTokenConfig

    The configuration of the admin-token based authorization that will be supported when accessing this node through the given address and port.

    The configuration of the admin-token based authorization that will be supported when accessing this node through the given address and port.

    Definition Classes
    GrpcHealthServerConfigServerConfig
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def authServices: Seq[AuthServiceConfig]

    If any defined, enforces token based authorization when accessing this node through the given address and port.

    If any defined, enforces token based authorization when accessing this node through the given address and port.

    Definition Classes
    GrpcHealthServerConfigServerConfig
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    UniformCantonConfigValidationCustomCantonConfigValidation
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics, authServices: Seq[AuthServiceConfig], adminTokenDispenser: Option[CantonAdminTokenDispenser], jwtTimestampLeeway: Option[JwtTimestampLeeway], adminTokenConfig: AdminTokenConfig, jwksCacheConfig: JwksCacheConfig, telemetry: Telemetry, additionalInterceptors: Seq[ServerInterceptor] = Seq.empty): CantonServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

    Definition Classes
    ServerConfig
  13. val internalPort: Option[Port]

    Port to be listening on (must be greater than 0).

    Port to be listening on (must be greater than 0). If the port is None, a default port will be assigned on startup.

    NOTE: If you rename this field, adapt the corresponding product hint for config reading. In the configuration the field is still called port for usability reasons.

    Definition Classes
    GrpcHealthServerConfigServerConfig
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val jwksCacheConfig: JwksCacheConfig

    settings for the jwks cache

    settings for the jwks cache

    Definition Classes
    GrpcHealthServerConfigServerConfig
  16. val jwtTimestampLeeway: Option[JwtTimestampLeeway]

    Leeway parameters for the jwt processing algorithms used in the authorization services

    Leeway parameters for the jwt processing algorithms used in the authorization services

    Definition Classes
    GrpcHealthServerConfigServerConfig
  17. val keepAliveServer: Option[BasicKeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    GrpcHealthServerConfigServerConfig
  18. def maxInboundMessageSize: NonNegativeInt

    maximum inbound message size in bytes on the ledger api and the admin api

    maximum inbound message size in bytes on the ledger api and the admin api

    Definition Classes
    GrpcHealthServerConfigServerConfig
  19. val maxTokenLifetime: NonNegativeDuration

    maximum expiration time accepted for tokens

    maximum expiration time accepted for tokens

    Definition Classes
    GrpcHealthServerConfigServerConfig
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. val parallelism: Int
  24. def port: Port

    Returns the configured or the default port that must be assigned after config loading and before config usage.

    Returns the configured or the default port that must be assigned after config loading and before config usage.

    We split between port and internalPort to offer a clean API to users of the config in the form of port, which must always return a configured or default port, and the internal representation that may be None before being assigned a default port.

    Definition Classes
    ServerConfig
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val serverCertChainFile: Option[PemFileOrString]

    server cert chain file if TLS is defined

    server cert chain file if TLS is defined

    Used for synchronizer internal GRPC sequencer connections

    Definition Classes
    GrpcHealthServerConfigServerConfig
  27. val sslContext: Option[SslContext]

    If defined, dictates to use TLS when connecting to this node through the given address and port.

    If defined, dictates to use TLS when connecting to this node through the given address and port. Server authentication is always enabled. Subclasses may decide whether to support client authentication.

    Definition Classes
    GrpcHealthServerConfigServerConfig
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toRemoteConfig: FullClientConfig
  30. final def validate[T >: GrpcHealthServerConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CantonConfigValidation

Inherited from ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped