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.

state

If the com.digitalasset.canton.protocol.messages.MediatorRequest has been finalized, this will be a Left otherwise a Right 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.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResponseAggregation
  2. PrettyPrinting
  3. PrettyUtil
  4. ShowUtil
  5. ShowSyntax
  6. ToShowOps
  7. ResponseAggregator
  8. Serializable
  9. Product
  10. Equals
  11. HasLoggerName
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ResponseAggregation(requestId: RequestId, request: MediatorRequest, version: CantonTimestamp, state: Either[MediatorVerdict, Map[VKEY, ViewState]])(requestTraceContext: TraceContext)(implicit viewKeyOps: ViewKey[VKEY])

    state

    If the com.digitalasset.canton.protocol.messages.MediatorRequest has been finalized, this will be a Left otherwise a Right 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.

Type Members

  1. type VKey = VKEY

    Type used to uniquely identify a view.

    Type used to uniquely identify a view.

    Definition Classes
    ResponseAggregationResponseAggregator
  2. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  3. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  6. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  7. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  8. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  9. 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
  10. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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. 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
  5. def asFinalized(protocolVersion: ProtocolVersion): Option[FinalizedResponse]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def copy(requestId: RequestId = requestId, request: MediatorRequest = request, version: CantonTimestamp = version, state: Either[MediatorVerdict, Map[VKEY, ViewState]] = state): ResponseAggregation[VKEY]
  9. 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
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. 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
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. 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
  14. def isFinalized: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. implicit def loggerNameFromThisClass: LoggerNameFromClass
    Attributes
    protected
    Definition Classes
    HasLoggerName
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. 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
  21. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  22. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  23. 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
  24. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  25. 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
  26. def pretty: Pretty[ResponseAggregation.this.type]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    ResponseAggregationPrettyPrinting
  27. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. def progressView(statesOfViews: Map[VKEY, ViewState], viewKeyAndParties: (VKEY, Set[LfPartyId]), sender: ParticipantId, localVerdict: LocalVerdict)(implicit loggingContext: NamedLoggingContext): Either[MediatorVerdict, Map[VKEY, ViewState]]
    Attributes
    protected
  35. val request: MediatorRequest
  36. val requestId: RequestId

    The request id of the com.digitalasset.canton.protocol.messages.InformeeMessage

  37. val requestTraceContext: TraceContext
  38. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  39. def showMergedState: Shown
  40. 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
  41. val state: Either[MediatorVerdict, Map[VKEY, ViewState]]
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def timeout(version: CantonTimestamp)(implicit loggingContext: NamedLoggingContext): ResponseAggregation[VKEY]
  44. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  45. 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. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  46. 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
  47. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  48. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  49. def validateAndProgress(responseTimestamp: CantonTimestamp, response: MediatorResponse, topologySnapshot: TopologySnapshot)(implicit loggingContext: NamedLoggingContext, ec: ExecutionContext): Future[Option[ResponseAggregation[VKEY]]]

    Record the additional confirmation response received.

    Record the additional confirmation response received.

    Definition Classes
    ResponseAggregationResponseAggregator
  50. def validateResponse[VKEY](viewKeyO: Option[VKEY], rootHashO: Option[RootHash], responseTimestamp: CantonTimestamp, sender: ParticipantId, localVerdict: LocalVerdict, topologySnapshot: TopologySnapshot, confirmingParties: Set[LfPartyId])(implicit arg0: ViewKey[VKEY], ec: ExecutionContext, loggingContext: NamedLoggingContext): OptionT[Future, List[(VKEY, Set[LfPartyId])]]
    Attributes
    protected
    Definition Classes
    ResponseAggregator
  51. 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
    ResponseAggregationResponseAggregator
  52. implicit val viewKeyOps: ViewKey[VKEY]
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. def withVersion(version: CantonTimestamp): ResponseAggregation[VKEY]

Deprecated Value Members

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

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from ResponseAggregator

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasLoggerName

Inherited from AnyRef

Inherited from Any

Ungrouped