com.digitalasset.canton.synchronizer.mediator
ResponseAggregation
Companion object ResponseAggregation
final case class ResponseAggregation[VKEY](requestId: RequestId, request: MediatorConfirmationRequest, timeout: CantonTimestamp, decisionTime: CantonTimestamp, version: CantonTimestamp, state: Either[MediatorVerdict, Map[VKEY, ViewState]])(requestTraceContext: TraceContext, participantResponseDeadlineTick: Option[TickRequest])(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.
- state
If the com.digitalasset.canton.protocol.messages.MediatorConfirmationRequest has been finalized, this will be a
Leftotherwise aRightwhich shows which transaction view hashes are not confirmed yet.- requestTraceContext
We retain the original trace context from the initial transaction 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.
- Alphabetic
- By Inheritance
- ResponseAggregation
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- ResponseAggregator
- Serializable
- Product
- Equals
- HasLoggerName
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ResponseAggregation(requestId: RequestId, request: MediatorConfirmationRequest, timeout: CantonTimestamp, decisionTime: CantonTimestamp, version: CantonTimestamp, state: Either[MediatorVerdict, Map[VKEY, ViewState]])(requestTraceContext: TraceContext, participantResponseDeadlineTick: Option[TickRequest])(implicit viewKeyOps: ViewKey[VKEY])
- state
If the com.digitalasset.canton.protocol.messages.MediatorConfirmationRequest has been finalized, this will be a
Leftotherwise aRightwhich shows which transaction view hashes are not confirmed yet.- requestTraceContext
We retain the original trace context from the initial transaction 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.
Type Members
- type VKey = VKEY
Type used to uniquely identify a view.
Type used to uniquely identify a view.
- Definition Classes
- ResponseAggregation → ResponseAggregator
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}".Enables the syntax
show"${myEither.showMerged}".- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowTraversableSyntax[T] extends AnyRef
Enables syntax like
show"Found several elements: ${myCollection.mkShow()}".Enables syntax like
show"Found several elements: ${myCollection.mkShow()}".- Definition Classes
- ShowUtil
- abstract class StringOperators extends AnyRef
Enables syntax like:
Enables syntax like:
show"This is a string: ${myString.doubleQuoted}"and:
show"This is a hash: ${myHash.readableHash}"- Definition Classes
- ShowUtil
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]
Use this as a temporary solution, to make the code compile during an ongoing migration.
Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:
- Instances of
Pretty[T]are ignored. - No parameter names
- Definition Classes
- PrettyUtil
- Instances of
- def asFinalized(protocolVersion: ProtocolVersion): Option[FinalizedResponse]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def copy(requestId: RequestId = requestId, request: MediatorConfirmationRequest = request, timeout: CantonTimestamp = timeout, decisionTime: CantonTimestamp = decisionTime, version: CantonTimestamp = version, state: Either[MediatorVerdict, Map[VKEY, ViewState]] = state): ResponseAggregation[VKEY]
- def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]
Use this if you need a custom representation of a parameter.
Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.
- Definition Classes
- PrettyUtil
- val decisionTime: CantonTimestamp
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- implicit def errorLoggingContextFromNamedLoggingContext(implicit loggingContext: NamedLoggingContext): ErrorLoggingContext
Convert a com.digitalasset.canton.logging.NamedLoggingContext into an com.digitalasset.canton.logging.ErrorLoggingContext to fix the logger name to the current class name.
Convert a com.digitalasset.canton.logging.NamedLoggingContext into an com.digitalasset.canton.logging.ErrorLoggingContext to fix the logger name to the current class name.
- Attributes
- protected
- Definition Classes
- HasLoggerName
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def indicateOmittedFields[T]: (T) => Option[Tree]
Use this to indicate that you've omitted fields from pretty printing
Use this to indicate that you've omitted fields from pretty printing
- Definition Classes
- PrettyUtil
- def isFinalized: Boolean
- Definition Classes
- ResponseAggregation → ResponseAggregator
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit def loggerNameFromThisClass: LoggerNameFromClass
- Attributes
- protected
- Definition Classes
- HasLoggerName
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree representing both parameter name and value.
A tree representing both parameter name and value.
- Definition Classes
- PrettyUtil
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree only written if not matching the default value
A tree only written if not matching the default value
- Definition Classes
- PrettyUtil
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]
A tree representing a parameter name without a parameter value.
A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.
- Definition Classes
- PrettyUtil
- val participantResponseDeadlineTick: Option[TickRequest]
- def pretty: Pretty[ResponseAggregation.this.type]
Indicates how to pretty print this instance.
Indicates how to pretty print this instance. See
PrettyPrintingTestfor examples on how to implement this method.- Attributes
- protected
- Definition Classes
- ResponseAggregation → PrettyPrinting
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]
A tree consisting of a labelled node with the given children.
A tree consisting of a labelled node with the given children.
- Definition Classes
- PrettyUtil
- def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]
A tree representing the type name and parameter trees.
A tree representing the type name and parameter trees.
- Definition Classes
- PrettyUtil
- def prettyOfClassWithName[T](name: String)(getParamTrees: (T) => Option[Tree]*): Pretty[T]
Like prettyOfClass, except takes an explicit name for the class.
Like prettyOfClass, except takes an explicit name for the class.
- Definition Classes
- PrettyUtil
- def prettyOfObject[T <: Product]: Pretty[T]
A tree presenting the type name only.
A tree presenting the type name only. (E.g., for case objects.)
- Definition Classes
- PrettyUtil
- def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]
Use this to give a class with a singleton parameter the same pretty representation as the parameter.
Use this to give a class with a singleton parameter the same pretty representation as the parameter.
- Definition Classes
- PrettyUtil
- def prettyOfString[T](toString: (T) => String): Pretty[T]
Creates a pretty instance from a string function.
Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.
- Definition Classes
- PrettyUtil
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val request: MediatorConfirmationRequest
- Definition Classes
- ResponseAggregation → ResponseAggregator
- val requestId: RequestId
The request id of the com.digitalasset.canton.protocol.messages.InformeeMessage
The request id of the com.digitalasset.canton.protocol.messages.InformeeMessage
- Definition Classes
- ResponseAggregation → ResponseAggregator
- val requestTraceContext: TraceContext
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- def showMergedState: Shown
- implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]
Enables the syntax
show"This object is pretty: $myPrettyType".Enables the syntax
show"This object is pretty: $myPrettyType".- Definition Classes
- ShowUtil
- val state: Either[MediatorVerdict, Map[VKEY, ViewState]]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeout(version: CantonTimestamp)(implicit loggingContext: NamedLoggingContext): ResponseAggregation[VKEY]
- val timeout: CantonTimestamp
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- final def toString(): String
Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.
Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.
Finalto avoid accidental overwriting.- Definition Classes
- PrettyPrinting → AnyRef → Any
- def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree representing a parameter value without a parameter name.
A tree representing a parameter value without a parameter name.
- Definition Classes
- PrettyUtil
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def validateAndProgress(responseTimestamp: CantonTimestamp, confirmationResponses: ConfirmationResponses, topologySnapshot: TopologySnapshot)(implicit loggingContext: NamedLoggingContext, ec: ExecutionContext): FutureUnlessShutdown[Option[ResponseAggregation[VKey]]]
Validate the additional confirmation response received and record unless already finalized.
Validate the additional confirmation response received and record unless already finalized.
- Definition Classes
- ResponseAggregator
- def validateAndProgressInternal(responseTimestamp: CantonTimestamp, response: ConfirmationResponse, rootHash: RootHash, sender: ParticipantId, topologySnapshot: TopologySnapshot)(implicit loggingContext: NamedLoggingContext, ec: ExecutionContext): FutureUnlessShutdown[Option[ResponseAggregation[VKEY]]]
Record the additional confirmation response received.
Record the additional confirmation response received.
- Attributes
- protected[synchronizer]
- Definition Classes
- ResponseAggregation → ResponseAggregator
- def validateResponse[VKEY](viewKeyO: Option[VKEY], rootHash: RootHash, responseTimestamp: CantonTimestamp, sender: ParticipantId, localVerdict: LocalVerdict, topologySnapshot: TopologySnapshot, confirmingParties: Set[LfPartyId])(implicit arg0: ViewKey[VKEY], ec: ExecutionContext, loggingContext: NamedLoggingContext): OptionT[FutureUnlessShutdown, List[(VKEY, Set[LfPartyId])]]
- Attributes
- protected
- Definition Classes
- ResponseAggregator
- val version: CantonTimestamp
The sequencer timestamp of the most recent message that affected this ResponseAggregator
The sequencer timestamp of the most recent message that affected this ResponseAggregator
- Definition Classes
- ResponseAggregation → ResponseAggregator
- implicit val viewKeyOps: ViewKey[VKEY]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withVersion(version: CantonTimestamp): ResponseAggregation[VKEY]