final case class ConnectToSequencerChannelRequest(request: Request, traceContext: Option[TraceContext]) extends GeneratedMessage with Updatable[ConnectToSequencerChannelRequest] with Product with Serializable

The sequencer channel service protocol consists of several messages which are sent as a request or a response (that is as a ConnectToSequencerChannelRequest or a ConnectToSequencerChannelResponse).

The protocol transitions through several stages. - To bootstrap the channel, initialization messages between the sequencer channel client and service need to be exchanged, that are SequencerChannelMetadata and SequencerChannelConnectedToAllEndpoints messages. - To secure the channel, sequencer channel client member endpoints setup a session key with the SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages. - To transfer data through the channel, members use opaque (encrypted) payload messages which the sequencer channel service forwards between channel member endpoints.

Using payload messages channel client users can implement their own application protocol such as the Online Party Replication.

Note that both, request and response need to implement SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages because of the bidirectional gRPC streams. For example, when the sequencer channel service receives a SequencerChannelSessionKeyAck request message from a sequencer channel client, it needs to forward it as a SequencerChannelSessionKeyAck response message to the destination sequencer channel client.

traceContext

Canton trace context Required

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[ConnectToSequencerChannelRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConnectToSequencerChannelRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConnectToSequencerChannelRequest(request: Request, traceContext: Option[TraceContext])

    traceContext

    Canton trace context Required

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearRequest: ConnectToSequencerChannelRequest
  6. def clearTraceContext: ConnectToSequencerChannelRequest
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def companion: ConnectToSequencerChannelRequest.type
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  13. def getMetadata: SequencerChannelMetadata
  14. def getPayload: ByteString
  15. def getSessionKey: SequencerChannelSessionKey
  16. def getSessionKeyAcknowledgement: SequencerChannelSessionKeyAck
  17. def getTraceContext: TraceContext
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val request: Request
  24. def serializedSize: Int
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  27. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  28. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  29. def toProtoString: String
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  30. val traceContext: Option[TraceContext]
  31. def update(ms: (Lens[ConnectToSequencerChannelRequest, ConnectToSequencerChannelRequest]) => Mutation[ConnectToSequencerChannelRequest]*): ConnectToSequencerChannelRequest
    Definition Classes
    Updatable
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. def withMetadata(__v: SequencerChannelMetadata): ConnectToSequencerChannelRequest
  36. def withPayload(__v: ByteString): ConnectToSequencerChannelRequest
  37. def withRequest(__v: Request): ConnectToSequencerChannelRequest
  38. def withSessionKey(__v: SequencerChannelSessionKey): ConnectToSequencerChannelRequest
  39. def withSessionKeyAcknowledgement(__v: SequencerChannelSessionKeyAck): ConnectToSequencerChannelRequest
  40. def withTraceContext(__v: TraceContext): ConnectToSequencerChannelRequest
  41. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  42. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ConnectToSequencerChannelRequest → GeneratedMessage
  43. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

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 Updatable[ConnectToSequencerChannelRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped