object ProtocolVersion extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProtocolVersion
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class InvalidProtocolVersion(description: String) extends FailureReason with Product with Serializable
  2. type ProtocolVersionWithStatus[S <: Status] = ProtocolVersion { type Status = S }

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 alpha: NonEmpty[List[ProtocolVersionWithStatus[Alpha]]]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val beta: List[ProtocolVersionWithStatus[Beta]]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def create(rawVersion: String, allowDeleted: Boolean = false): Either[String, ProtocolVersion]

    Creates a ProtocolVersion from the given raw version value and ensures that it is a supported version.

    Creates a ProtocolVersion from the given raw version value and ensures that it is a supported version.

    rawVersion

    String to be parsed.

    allowDeleted

    If true, don't fail if rawVersion corresponds to a deleted protocol version. This should only be used when parsing a version that does not correspond to the one running on the synchronizer. One such example is the minimum supported protocol version from a participant.

  9. lazy val dev: ProtocolVersionWithStatus[Alpha]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. val forSynchronizer: ProtocolVersion

    The protocol version used to bootstrap a synchronizer.

    The protocol version used to bootstrap a synchronizer.

    Uses the latest protocol version as default, but allow overriding it with an environment variable CANTON_PROTOCOL_VERSION.

    Exceptions thrown

    java.lang.RuntimeException if the environment variable's value cannot be parsed to a protocol version

  13. def fromProtoPrimitive(rawVersion: Int, allowDeleted: Boolean = false): ParsingResult[ProtocolVersion]

    Like create ensures a supported protocol version; tailored to (de-)serialization purposes.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. implicit val getResultProtocolVersion: GetResult[ProtocolVersion]
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val latest: ProtocolVersion
  19. lazy val minimum: ProtocolVersion
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. def parseUnchecked(rawVersion: Int): Either[String, ProtocolVersion]

    Same as above when parsing a raw version value

  24. def parseUncheckedS(rawVersion: String): Either[String, ProtocolVersion]

    Parse a given raw version string into a ProtocolVersion without any further validation, i.e.

    Parse a given raw version string into a ProtocolVersion without any further validation, i.e. it allows to create invalid and unsupported ProtocolVersion!

    ONLY use this method when

    • implementing functionality for the ProtocolVersion itself
    • additional validation is being applied on the resulting ProtocolVersion afterwards as a exception
    • testing and having a need for an invalid or unsupported ProtocolVersion

    Otherwise, use one of the other factory methods.

  25. implicit val protocolVersionEncoder: Encoder[ProtocolVersion]
  26. implicit lazy val protocolVersionReader: ConfigReader[ProtocolVersion]
  27. implicit val protocolVersionWriter: ConfigWriter[ProtocolVersion]
  28. implicit val setParameterProtocolVersion: SetParameter[ProtocolVersion]
  29. val stable: NonEmpty[List[ProtocolVersion]]
  30. val supported: NonEmpty[List[ProtocolVersion]]
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. def tryCreate(rawVersion: String): ProtocolVersion

    Like create ensures a supported protocol version; but throws a runtime exception for errors.

  34. lazy val v33: ProtocolVersionWithStatus[Stable]
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped