Packages

c

com.digitalasset.canton.config

CommunityAdminServerConfig

case class CommunityAdminServerConfig(address: String = defaultAddress, internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize) extends AdminServerConfig with CommunityServerConfig with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommunityAdminServerConfig
  2. CommunityServerConfig
  3. AdminServerConfig
  4. ServerConfig
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CommunityAdminServerConfig(address: String = defaultAddress, internalPort: Option[Port] = None, tls: Option[TlsServerConfig] = None, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize)

Value Members

  1. val address: String

    The address of the interface to be listening on

    The address of the interface to be listening on

    Definition Classes
    CommunityAdminServerConfigAdminServerConfigServerConfig
  2. def clientConfig: ClientConfig
    Definition Classes
    AdminServerConfig
  3. 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
    CommunityServerConfigServerConfig
  4. 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
    CommunityAdminServerConfigServerConfig
  5. val keepAliveServer: Option[KeepAliveServerConfig]

    server keep alive settings

    server keep alive settings

    Definition Classes
    CommunityAdminServerConfigServerConfig
  6. val 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
    CommunityAdminServerConfigServerConfig
  7. 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
  8. def productElementNames: Iterator[String]
    Definition Classes
    Product
  9. def 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
    AdminServerConfigServerConfig
  10. def 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
    AdminServerConfigServerConfig
  11. val tls: Option[TlsServerConfig]
  12. def toSequencerConnectionConfig: Grpc
    Definition Classes
    ServerConfig