Packages

c

com.digitalasset.canton.config

GrpcHealthServerConfig

final case class GrpcHealthServerConfig(address: String = "0.0.0.0", internalPort: Option[Port] = None, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), parallelism: Int = 4) extends ServerConfig 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

Linear Supertypes
ServerConfig, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcHealthServerConfig
  2. ServerConfig
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), 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
    GrpcHealthServerConfig → ServerConfig
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def instantiateServerInterceptors(tracingConfig: TracingConfig, apiLoggingConfig: ApiLoggingConfig, metricsPrefix: MetricName, metrics: MetricsFactory, loggerFactory: NamedLoggerFactory, grpcMetrics: GrpcServerMetrics): CantonServerInterceptors

    Use the configuration to instantiate the interceptors for this server

    Use the configuration to instantiate the interceptors for this server

    Definition Classes
    GrpcHealthServerConfig → ServerConfig
  10. 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
    GrpcHealthServerConfig → ServerConfig
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val keepAliveServer: Option[KeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    GrpcHealthServerConfig → ServerConfig
  13. 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
    GrpcHealthServerConfig → ServerConfig
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val parallelism: Int
  18. 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
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val serverCertChainFile: Option[ExistingFile]

    server cert chain file if TLS is defined

    server cert chain file if TLS is defined

    Used for domain internal GRPC sequencer connections

    Definition Classes
    GrpcHealthServerConfig → ServerConfig
  21. 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
    GrpcHealthServerConfig → ServerConfig
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toRemoteConfig: ClientConfig
  24. def toSequencerConnectionConfig: Grpc
    Definition Classes
    ServerConfig
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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

Inherited from ServerConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped