package mediator
- Alphabetic
- Public
- Protected
Type Members
- class DefaultMediatorEventDeduplicator extends MediatorEventDeduplicator with NamedLogging
- final case class EnterpriseMediatorConfig(pruning: MediatorPruningConfig = MediatorPruningConfig()) extends Product with Serializable
Configuration for the mediator in enterprise.
Configuration for the mediator in enterprise.
- pruning
mediator pruning configuration
- class EnterpriseMediatorRuntime extends MediatorRuntime with NamedLogging
- class EnterpriseMediatorRuntimeFactory extends MediatorRuntimeFactory
- final case class FinalizedResponse(requestId: RequestId, request: MediatorRequest, version: CantonTimestamp, verdict: Verdict)(requestTraceContext: TraceContext) extends ResponseAggregator with Product with Serializable
- class GrpcEnterpriseMediatorAdministrationService extends EnterpriseMediatorAdministrationService with GrpcPruningScheduler with HasPruningScheduler with NamedLogging
- class MediatorNode extends MediatorNodeCommon
- class MediatorNodeBootstrap extends CantonNodeBootstrapBase[MediatorNode, MediatorNodeConfig, MediatorNodeParameters, MediatorNodeMetrics] with MediatorNodeBootstrapCommon[MediatorNode, MediatorNodeConfig]
- trait MediatorNodeBootstrapCommon[T <: CantonNode, NC <: LocalNodeConfig with MediatorNodeConfigCommon] extends AnyRef
- class MediatorNodeBootstrapX extends CantonNodeBootstrapX[MediatorNodeX, MediatorNodeXConfig, MediatorNodeParameters, MediatorNodeMetrics] with MediatorNodeBootstrapCommon[MediatorNodeX, MediatorNodeXConfig]
- class MediatorNodeCommon extends CantonNode with NamedLogging with HasUptime
- final case class MediatorNodeConfig(adminApi: EnterpriseAdminServerConfig = EnterpriseAdminServerConfig(), storage: EnterpriseStorageConfig = EnterpriseStorageConfig.Memory(), crypto: EnterpriseCryptoConfig = EnterpriseCryptoConfig(), init: InitConfig = InitConfig(identity = None), replication: ReplicationConfig = ReplicationConfig(), timeTracker: DomainTimeTrackerConfig = DomainTimeTrackerConfig(), sequencerClient: SequencerClientConfig = SequencerClientConfig(), caching: CachingConfigs = CachingConfigs(), parameters: MediatorNodeParameterConfig = MediatorNodeParameterConfig(), mediator: EnterpriseMediatorConfig = EnterpriseMediatorConfig(), monitoring: NodeMonitoringConfig = NodeMonitoringConfig(), topologyX: TopologyXConfig = TopologyXConfig.NotUsed) extends MediatorNodeConfigCommon with ConfigDefaults[DefaultPorts, MediatorNodeConfig] with Product with Serializable
Mediator Node configuration
Mediator Node configuration
- init
all nodes must provided a init config however the mediator cannot auto initialize itself so defaults
autoInit
tofalse
- timeTracker
configuration for how time is tracked on the connected domain using the sequencer
- abstract class MediatorNodeConfigCommon extends EnterpriseLocalNodeConfig
- final case class MediatorNodeParameterConfig(devVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false, initialProtocolVersion: ProtocolVersion = ProtocolVersion.latest, batching: BatchingConfig = BatchingConfig()) extends ProtocolConfig with LocalNodeParametersConfig with Product with Serializable
Various parameters for non-standard mediator settings
Various parameters for non-standard mediator settings
- dontWarnOnDeprecatedPV
if true, then this mediator will not emit a warning when connecting to a sequencer using a deprecated protocol version.
- final case class MediatorNodeParameters(general: General, protocol: Protocol) extends CantonNodeParameters with HasGeneralCantonNodeParameters with HasProtocolCantonNodeParameters with Product with Serializable
- class MediatorNodeX extends MediatorNodeCommon
- final case class MediatorNodeXConfig(adminApi: EnterpriseAdminServerConfig = EnterpriseAdminServerConfig(), storage: EnterpriseStorageConfig = EnterpriseStorageConfig.Memory(), crypto: EnterpriseCryptoConfig = EnterpriseCryptoConfig(), init: InitConfig = InitConfig(identity = Some(InitConfigBase.Identity())), replication: ReplicationConfig = ReplicationConfig(), timeTracker: DomainTimeTrackerConfig = DomainTimeTrackerConfig(), sequencerClient: SequencerClientConfig = SequencerClientConfig(), caching: CachingConfigs = CachingConfigs(), parameters: MediatorNodeParameterConfig = MediatorNodeParameterConfig(), mediator: EnterpriseMediatorConfig = EnterpriseMediatorConfig(), monitoring: NodeMonitoringConfig = NodeMonitoringConfig(), topologyX: TopologyXConfig = TopologyXConfig()) extends MediatorNodeConfigCommon with ConfigDefaults[DefaultPorts, MediatorNodeXConfig] with Product with Serializable
Mediator Node X configuration that defaults to auto-init
- final case class MediatorPruningConfig(maxPruningBatchSize: PositiveInt = PositiveInt.tryCreate(50000), pruningMetricUpdateInterval: Option[PositiveDurationSeconds] = config.PositiveDurationSeconds.ofHours(1L).some) extends Product with Serializable
Configuration for enterprise sequencer pruning
Configuration for enterprise sequencer pruning
- maxPruningBatchSize
maximum number of events to prune from a mediator at a time, used to break up batches internally
- pruningMetricUpdateInterval
How frequently to update the
max-event-age
pruning progress metric in the background. A setting of None disables background metric updating.
- class MediatorPruningScheduler extends EnterpriseScheduler with HasCloseContext with PruningScheduler with HasPruningSchedulerStore with UpdatePruningMetric
- class MediatorReplicaManager extends ReplicaManager
Manages replicas of a single Mediator instance.
Manages replicas of a single Mediator instance. Passive instances are currently entirely passive and have no components running at runtime. When becoming active a MediatorRuntime is started and connected to the admin services. When becoming passive the running MediatorRuntime is shutdown and the admin services are disconnected.
If the admin services are called while passive every method will return an unavailable response.
- class MediatorReplicaManagerException extends RuntimeException
An unexpected error occurred while transitioning between replica states
- trait MediatorRuntime extends FlagCloseable
Mediator component and its supporting services
- trait MediatorRuntimeFactory extends AnyRef
- sealed trait MediatorVerdict extends Product with Serializable with PrettyPrinting
- final case class RemoteMediatorConfig(adminApi: ClientConfig) extends NodeConfig with Product with Serializable
- final case class ResponseAggregation[VKEY](requestId: RequestId, request: MediatorRequest, version: CantonTimestamp, state: Either[MediatorVerdict, Map[VKEY, ViewState]])(requestTraceContext: TraceContext)(implicit viewKeyOps: ViewKey[VKEY]) extends ResponseAggregator with PrettyPrinting with Product with Serializable
Aggregates the responses for a request that the mediator has processed so far.
Aggregates the responses for a request that the mediator has processed so far.
- state
If the com.digitalasset.canton.protocol.messages.MediatorRequest has been finalized, this will be a
Left
otherwise aRight
which shows which transaction view hashes are not confirmed yet.- requestTraceContext
We retain the original trace context from the initial confirmation request for raising timeouts to help with debugging. this ideally would be the same trace context throughout all responses could not be in a distributed setup so this is not validated anywhere. Intentionally supplied in a separate parameter list to avoid being included in equality checks.
- trait ResponseAggregator extends HasLoggerName with Product with Serializable
- trait ViewKey[VKEY] extends Pretty[VKEY] with Product with Serializable
Value Members
- object CommunityMediatorRuntimeFactory extends MediatorRuntimeFactory
- object MediatorNodeBootstrap
- object MediatorNodeBootstrapX
- object MediatorVerdict extends Serializable
- object ResponseAggregation extends Serializable
- object ViewKey extends Serializable