root
API
Generated with
root/org.sigilaris/org.sigilaris.node/org.sigilaris.node.gossip

org.sigilaris.node.gossip

package org.sigilaris.node.gossip

Members list

Packages

package org.sigilaris.node.gossip.tx

Type members

Classlikes

final case class ArtifactApplyResult(applied: Boolean, duplicate: Boolean)

Result of applying a gossip artifact to the local sink.

Result of applying a gossip artifact to the local sink.

Value parameters

applied

true if the artifact was newly applied

duplicate

true if the artifact was already known

Attributes

Source
Contracts.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class AvailableGossipEvent[A](event: GossipEvent[A], availableAt: Instant, encodedSizeBytes: Option[Long])

A gossip event paired with the timestamp at which it became available for delivery.

A gossip event paired with the timestamp at which it became available for delivery.

Type parameters

A

the payload type of the gossip event

Value parameters

availableAt

the instant at which this event became eligible for producer batching

encodedSizeBytes

optional size of the encoded peer-facing event, when the source can provide it for byte-budget enforcement

event

the gossip event

Attributes

Companion
object
Source
Contracts.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AvailableGossipEvent

Attributes

Companion
class
Source
Contracts.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait CanonicalRejection extends StructuredFailureDiagnostic

Base trait for all canonical rejection types in the gossip protocol.

Base trait for all canonical rejection types in the gossip protocol.

Attributes

Companion
object
Source
GossipRejections.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class StaleCursor
object CanonicalRejection

Companion for CanonicalRejection defining concrete rejection subtypes.

Companion for CanonicalRejection defining concrete rejection subtypes.

Attributes

Companion
trait
Source
GossipRejections.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object ChainId

Companion for ChainId.

Companion for ChainId.

Attributes

Source
GossipIdentifiers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ChainId.type
final case class ChainTopic(chainId: ChainId, topic: GossipTopic)

A pair of chain id and gossip topic, identifying a specific gossip stream.

A pair of chain id and gossip topic, identifying a specific gossip stream.

Value parameters

chainId

the chain identifier

topic

the gossip topic

Attributes

Companion
object
Source
GossipIdentifiers.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChainTopic

Companion for ChainTopic.

Companion for ChainTopic.

Attributes

Companion
class
Source
GossipIdentifiers.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ChainTopic.type
final case class CompositeCursor(values: Map[ChainTopic, CursorToken])

A cursor that holds per-chain-topic cursor tokens for multiplexed session streaming.

A cursor that holds per-chain-topic cursor tokens for multiplexed session streaming.

Value parameters

values

the mapping of chain-topic pairs to their cursor tokens

Attributes

Companion
object
Source
GossipCursorModel.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CompositeCursor

Companion for CompositeCursor.

Companion for CompositeCursor.

Attributes

Companion
class
Source
GossipCursorModel.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ControlBatch(idempotencyKey: ControlIdempotencyKey, ops: Vector[ControlOp])

A batch of control operations with an idempotency key for deduplication.

A batch of control operations with an idempotency key for deduplication.

Value parameters

idempotencyKey

unique key to prevent duplicate application

ops

the control operations in this batch

Attributes

Companion
object
Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ControlBatch

Companion for ControlBatch.

Companion for ControlBatch.

Attributes

Companion
class
Source
GossipSessionProtocol.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum ControlChannelMessage

Messages sent on the control channel direction of a gossip session.

Messages sent on the control channel direction of a gossip session.

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ControlIdempotencyKey

Companion for ControlIdempotencyKey.

Companion for ControlIdempotencyKey.

Attributes

Source
GossipSessionProtocol.scala
Supertypes
class Object
trait Matchable
class Any
Self type
enum ControlOp

Algebraic data type representing individual control operations within a control batch.

Algebraic data type representing individual control operations within a control batch.

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum ControlOpKind(val wireName: String)

Enumeration of control operation kinds used in the gossip control channel.

Enumeration of control operation kinds used in the gossip control channel.

Value parameters

wireName

the wire-protocol name of this operation kind

Attributes

Companion
object
Source
GossipSessionProtocol.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ControlOpKind

Companion for ControlOpKind providing wire-format parsing.

Companion for ControlOpKind providing wire-format parsing.

Attributes

Companion
enum
Source
GossipSessionProtocol.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object CursorToken

Attributes

Source
GossipCursorModel.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class DirectionalSession(sessionId: DirectionalSessionId, direction: SessionDirection, peer: PeerIdentity, peerCorrelationId: PeerCorrelationId, proposal: SessionOpenProposal, negotiated: Option[NegotiatedSessionParameters], status: DirectionalSessionStatus, createdAt: Instant, openedAt: Option[Instant], lastActivityAt: Instant)

State of a single directional gossip session.

State of a single directional gossip session.

Value parameters

createdAt

when this session was created

direction

whether this session is outbound or inbound

lastActivityAt

the most recent activity timestamp

negotiated

the negotiated parameters (present after handshake completes)

openedAt

when this session became open (if applicable)

peer

the remote peer

peerCorrelationId

the peer correlation id

proposal

the original session open proposal

sessionId

the unique directional session identifier

status

the current lifecycle status

Attributes

Source
SessionEngine.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DirectionalSessionId

Companion for DirectionalSessionId.

Companion for DirectionalSessionId.

Attributes

Source
GossipIdentifiers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
enum DirectionalSessionStatus

Lifecycle status of a single directional session.

Lifecycle status of a single directional session.

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DirectionalSessionStatus

Companion for DirectionalSessionStatus.

Companion for DirectionalSessionStatus.

Attributes

Companion
enum
Source
SessionEngine.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum EventStreamMessage[A]

Messages sent on the event stream direction of a gossip session.

Messages sent on the event stream direction of a gossip session.

Type parameters

A

the artifact payload type

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ExactKnownSetScope(chainId: ChainId, topic: GossipTopic, windowKey: TopicWindowKey)

Identifies a scoped set of known artifacts within a specific chain, topic, and window.

Identifies a scoped set of known artifacts within a specific chain, topic, and window.

Value parameters

chainId

the chain identifier

topic

the gossip topic

windowKey

the window key within the topic

Attributes

Companion
object
Source
GossipCursorModel.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExactKnownSetScope

Companion for ExactKnownSetScope.

Companion for ExactKnownSetScope.

Attributes

Companion
class
Source
GossipCursorModel.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait GossipArtifactSink[F[_], A]

Sink that consumes incoming gossip artifacts from peers.

Sink that consumes incoming gossip artifacts from peers.

Type parameters

A

the artifact payload type

F

the effect type

Attributes

Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait GossipArtifactSource[F[_], A]

Source of gossip artifacts for a producer to read from.

Source of gossip artifacts for a producer to read from.

Type parameters

A

the artifact payload type

F

the effect type

Attributes

Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait GossipClock[F[_]]

Abstraction over a clock used by the gossip subsystem.

Abstraction over a clock used by the gossip subsystem.

Type parameters

F

the effect type

Attributes

Companion
object
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
object GossipClock

Companion for GossipClock providing factory methods.

Companion for GossipClock providing factory methods.

Attributes

Companion
trait
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class GossipEvent[A](chainId: ChainId, topic: GossipTopic, id: StableArtifactId, cursor: CursorToken, ts: Instant, payload: A)

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GossipFieldValidation

Validation utilities for gossip protocol field values.

Validation utilities for gossip protocol field values.

Attributes

Source
GossipRejections.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait GossipFilter

Base trait for gossip event filters used in producer-side deduplication.

Base trait for gossip event filters used in producer-side deduplication.

Attributes

Companion
object
Source
GossipSessionProtocol.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GossipFilter

Companion for GossipFilter defining concrete filter types.

Companion for GossipFilter defining concrete filter types.

Attributes

Companion
trait
Source
GossipSessionProtocol.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object GossipProducerPolling

Utility for batching available gossip events according to QoS constraints.

Utility for batching available gossip events according to QoS constraints.

Attributes

Source
ProducerSession.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait GossipProducerQoS

Quality-of-service settings for gossip event producer batching.

Quality-of-service settings for gossip event producer batching.

Attributes

Source
ProducerSession.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class GossipProducerSessionState(sessionId: DirectionalSessionId, peer: PeerIdentity, peerCorrelationId: PeerCorrelationId, subscriptions: SessionSubscription, negotiated: NegotiatedSessionParameters, durableCursor: CompositeCursor, streamCursor: CompositeCursor, pendingReplay: Map[ChainTopic, Option[CursorToken]])

Mutable state of a producer-side gossip session, tracking cursors, replays, and stream progress.

Mutable state of a producer-side gossip session, tracking cursors, replays, and stream progress.

Value parameters

durableCursor

the cursor persisted by the consumer via SetCursor

negotiated

the negotiated timing parameters

peer

the remote peer identity

peerCorrelationId

the peer correlation id

pendingReplay

chain-topics with pending Nack replay requests

sessionId

the directional session identifier

streamCursor

the cursor tracking the most recently emitted events

subscriptions

the session subscriptions

Attributes

Source
ProducerSession.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class GossipSessionEngine(localPeer: PeerIdentity, topology: StaticPeerTopology, policy: HandshakePolicy, relationships: Map[PeerIdentity, PeerRelationship])

Attributes

Source
SessionEngine.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait GossipSourceAppendNotifier[F[_]]

Notifies runtime-owned stream drivers that a source appended an event for a chain-topic.

Notifies runtime-owned stream drivers that a source appended an event for a chain-topic.

Wakeups are advisory and may be coalesced by implementations; retained source data and session cursors remain the delivery source of truth. Implementations should publish only after the retained append is visible to subsequent source reads.

Attributes

Companion
object
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GossipSourceAppendNotifier

Companion for GossipSourceAppendNotifier.

Companion for GossipSourceAppendNotifier.

Attributes

Companion
trait
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object GossipTopic

Companion for GossipTopic with well-known topic constants and parsing.

Companion for GossipTopic with well-known topic constants and parsing.

Attributes

Source
GossipIdentifiers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait GossipTopicContract[A]

Contract defining validation and delivery rules for a specific gossip topic.

Contract defining validation and delivery rules for a specific gossip topic.

Type parameters

A

the artifact payload type

Attributes

Source
GossipSessionProtocol.scala
Supertypes
class Object
trait Matchable
class Any
trait GossipTopicContractRegistry[A]

Registry that maps gossip topics to their validation contracts.

Registry that maps gossip topics to their validation contracts.

Type parameters

A

the artifact payload type

Attributes

Companion
object
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
object GossipTopicContractRegistry

Companion for GossipTopicContractRegistry providing factory methods.

Companion for GossipTopicContractRegistry providing factory methods.

Attributes

Companion
trait
Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class HandshakePolicy(openingHandshakeTimeout: Duration, defaultHeartbeatInterval: Duration, defaultLivenessTimeout: Duration, defaultMaxControlRetryInterval: Duration, minHeartbeatInterval: Duration, maxHeartbeatInterval: Duration, minMaxControlRetryInterval: Duration, maxMaxControlRetryInterval: Duration)

Policy governing session handshake timing constraints and defaults.

Policy governing session handshake timing constraints and defaults.

Value parameters

defaultHeartbeatInterval

default heartbeat interval if not proposed

defaultLivenessTimeout

default liveness timeout if not proposed

defaultMaxControlRetryInterval

default max control retry interval if not proposed

maxHeartbeatInterval

maximum allowed heartbeat interval

maxMaxControlRetryInterval

maximum allowed max control retry interval

minHeartbeatInterval

minimum allowed heartbeat interval

minMaxControlRetryInterval

minimum allowed max control retry interval

openingHandshakeTimeout

timeout for completing the handshake

Attributes

Companion
object
Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HandshakePolicy

Companion for HandshakePolicy.

Companion for HandshakePolicy.

Attributes

Companion
class
Source
GossipSessionProtocol.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait InboundHandshakeResult

Result of processing an inbound session open proposal.

Result of processing an inbound session open proposal.

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Accepted
class Rejected
object InboundHandshakeResult

Companion for InboundHandshakeResult defining the result subtypes.

Companion for InboundHandshakeResult defining the result subtypes.

Attributes

Companion
trait
Source
SessionEngine.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class NegotiatedSessionParameters(heartbeatInterval: Duration, livenessTimeout: Duration, maxControlRetryInterval: Duration)

Parameters negotiated during session handshake that govern session timing.

Parameters negotiated during session handshake that govern session timing.

Value parameters

heartbeatInterval

interval between heartbeat keep-alive messages

livenessTimeout

duration after which a session is considered dead if no activity

maxControlRetryInterval

maximum interval between control batch retries

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait PeerAuthenticator[F[_]]

Authenticates a peer identity during handshake.

Authenticates a peer identity during handshake.

Type parameters

F

the effect type

Attributes

Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PeerCorrelationId

Companion for PeerCorrelationId.

Companion for PeerCorrelationId.

Attributes

Source
GossipIdentifiers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object PeerIdentity

Companion for PeerIdentity.

Companion for PeerIdentity.

Attributes

Source
GossipIdentifiers.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait PeerRegistry

Registry of peers known to the local gossip node.

Registry of peers known to the local gossip node.

Attributes

Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class PeerRelationship(peer: PeerIdentity, peerCorrelationId: PeerCorrelationId, outbound: Option[DirectionalSession], inbound: Option[DirectionalSession], status: PeerRelationshipStatus, wasBidirectionalOpen: Boolean)

Aggregate state of a bidirectional relationship with a single peer.

Aggregate state of a bidirectional relationship with a single peer.

Value parameters

inbound

the inbound directional session, if any

outbound

the outbound directional session, if any

peer

the remote peer identity

peerCorrelationId

the current correlation id for this relationship

status

the aggregate relationship status

wasBidirectionalOpen

true if both directions were simultaneously open at any point

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PeerRelationship

Companion for PeerRelationship providing factory methods.

Companion for PeerRelationship providing factory methods.

Attributes

Companion
class
Source
SessionEngine.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum PeerRelationshipStatus

Aggregate status of a bidirectional peer relationship.

Aggregate status of a bidirectional peer relationship.

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PeerRelationshipStatus

Companion for PeerRelationshipStatus.

Companion for PeerRelationshipStatus.

Attributes

Companion
enum
Source
SessionEngine.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum PreOpenTrafficKind

Kind of traffic that arrived before a session was fully open.

Kind of traffic that arrived before a session was fully open.

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PreOpenTrafficKind

Companion for PreOpenTrafficKind.

Companion for PreOpenTrafficKind.

Attributes

Companion
enum
Source
SessionEngine.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum SessionConfigKey(val wireName: String)

Enumeration of session configuration keys negotiable over the control channel.

Enumeration of session configuration keys negotiable over the control channel.

Value parameters

wireName

the wire-protocol name of this config key

Attributes

Companion
object
Source
GossipSessionProtocol.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SessionConfigKey

Companion for SessionConfigKey providing wire-format parsing.

Companion for SessionConfigKey providing wire-format parsing.

Attributes

Companion
enum
Source
GossipSessionProtocol.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum SessionDirection

Direction of a gossip session relative to the local node.

Direction of a gossip session relative to the local node.

Attributes

Companion
object
Source
SessionEngine.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SessionDirection

Companion for SessionDirection.

Companion for SessionDirection.

Attributes

Companion
enum
Source
SessionEngine.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object SessionNegotiation

Attributes

Source
GossipSessionProtocol.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class SessionOpenAck(sessionId: DirectionalSessionId, peerCorrelationId: PeerCorrelationId, initiator: PeerIdentity, acceptor: PeerIdentity, subscriptions: SessionSubscription, negotiated: NegotiatedSessionParameters)

Acknowledgement sent by the acceptor confirming a session open proposal.

Acknowledgement sent by the acceptor confirming a session open proposal.

Value parameters

acceptor

the accepting peer

initiator

the initiating peer

negotiated

the final negotiated timing parameters

peerCorrelationId

the correlation id from the proposal

sessionId

the directional session identifier from the proposal

subscriptions

the confirmed subscriptions

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class SessionOpenProposal(sessionId: DirectionalSessionId, peerCorrelationId: PeerCorrelationId, initiator: PeerIdentity, acceptor: PeerIdentity, subscriptions: SessionSubscription, heartbeatInterval: Option[Duration], livenessTimeout: Option[Duration], maxControlRetryInterval: Option[Duration])

Proposal sent by the initiator to open a gossip session.

Proposal sent by the initiator to open a gossip session.

Value parameters

acceptor

the peer being asked to accept

heartbeatInterval

proposed heartbeat interval, or None for default

initiator

the peer initiating the session

livenessTimeout

proposed liveness timeout, or None for default

maxControlRetryInterval

proposed max control retry interval, or None for default

peerCorrelationId

the correlation id tying bidirectional sessions

sessionId

the directional session identifier

subscriptions

the chain-topic pairs to subscribe to

Attributes

Source
GossipSessionProtocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class SessionSubscription

An immutable set of chain-topic pairs that a session is subscribed to.

An immutable set of chain-topic pairs that a session is subscribed to.

Value parameters

values

the subscribed chain-topic pairs

Attributes

Companion
object
Source
GossipIdentifiers.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SessionSubscription

Companion for SessionSubscription providing factory methods.

Companion for SessionSubscription providing factory methods.

Attributes

Companion
class
Source
GossipIdentifiers.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object StableArtifactId

Companion for StableArtifactId providing parsing and construction.

Companion for StableArtifactId providing parsing and construction.

Attributes

Source
GossipCursorModel.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class StaticPeerAuthenticator[F[_]](registry: PeerRegistry)(using evidence$1: Applicative[F]) extends PeerAuthenticator[F]

A PeerAuthenticator that accepts only direct neighbors from a static registry.

A PeerAuthenticator that accepts only direct neighbors from a static registry.

Type parameters

F

the effect type

Value parameters

registry

the peer registry used for neighbor verification

Attributes

Source
Contracts.scala
Supertypes
class Object
trait Matchable
class Any
final case class StaticPeerRegistry(topology: StaticPeerTopology) extends PeerRegistry

A PeerRegistry backed by a static peer topology.

A PeerRegistry backed by a static peer topology.

Value parameters

topology

the static topology describing known peers and neighbors

Attributes

Source
Contracts.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait PeerRegistry
class Object
trait Matchable
class Any
Show all
final case class StaticPeerTopology(localNodeIdentity: PeerIdentity, knownPeers: Set[PeerIdentity], directNeighbors: Set[PeerIdentity])

A static, immutable description of the peer topology for a gossip node.

A static, immutable description of the peer topology for a gossip node.

Value parameters

directNeighbors

the subset of known peers that are direct neighbors

knownPeers

all known peer identities (excluding the local node)

localNodeIdentity

the identity of the local node

Attributes

Companion
object
Source
PeerRegistry.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StaticPeerTopology

Companion for StaticPeerTopology providing parsing from raw strings.

Companion for StaticPeerTopology providing parsing from raw strings.

Attributes

Companion
class
Source
PeerRegistry.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class StaticPeerTransportAuth(localPeer: PeerIdentity, peerSecrets: Map[PeerIdentity, TransportSharedSecret])

Transport authentication state holding per-peer shared secrets.

Transport authentication state holding per-peer shared secrets.

Value parameters

localPeer

the identity of the local peer

peerSecrets

the shared secrets for each known peer

Attributes

Companion
object
Source
StaticPeerTransportAuth.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StaticPeerTransportAuth

Companion for StaticPeerTransportAuth providing construction and testing helpers.

Companion for StaticPeerTransportAuth providing construction and testing helpers.

Attributes

Companion
class
Source
StaticPeerTransportAuth.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object TopicWindowKey

Companion for TopicWindowKey providing parsing and construction.

Companion for TopicWindowKey providing parsing and construction.

Attributes

Source
GossipCursorModel.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class TransportSharedSecret

A shared secret used for transport-level peer authentication.

A shared secret used for transport-level peer authentication.

Value parameters

bytes

the secret bytes

Attributes

Companion
object
Source
StaticPeerTransportAuth.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TransportSharedSecret

Companion for TransportSharedSecret.

Companion for TransportSharedSecret.

Attributes

Companion
class
Source
StaticPeerTransportAuth.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

opaque type ChainId

Opaque type representing a blockchain chain identifier.

Opaque type representing a blockchain chain identifier.

Attributes

Source
GossipIdentifiers.scala
opaque type ControlIdempotencyKey

Opaque type for a UUIDv4 idempotency key used to deduplicate control batches.

Opaque type for a UUIDv4 idempotency key used to deduplicate control batches.

Attributes

Source
GossipSessionProtocol.scala
opaque type CursorToken

Opaque type representing a versioned cursor token for resumable event streaming.

Opaque type representing a versioned cursor token for resumable event streaming.

Attributes

Source
GossipCursorModel.scala
opaque type DirectionalSessionId

Attributes

Source
GossipIdentifiers.scala
opaque type GossipTopic

Opaque type representing a gossip topic name.

Opaque type representing a gossip topic name.

Attributes

Source
GossipIdentifiers.scala
opaque type PeerCorrelationId

Opaque type for a correlation identifier that ties bidirectional sessions between two peers.

Opaque type for a correlation identifier that ties bidirectional sessions between two peers.

Attributes

Source
GossipIdentifiers.scala
opaque type PeerIdentity

Opaque type representing the identity of a gossip peer.

Opaque type representing the identity of a gossip peer.

Attributes

Source
GossipIdentifiers.scala
opaque type StableArtifactId

Attributes

Source
GossipCursorModel.scala
opaque type TopicWindowKey

Opaque type representing a windowing key within a gossip topic scope.

Opaque type representing a windowing key within a gossip topic scope.

Attributes

Source
GossipCursorModel.scala
Generated with