package chainreplication

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Join (JoinRequest, NodeConfiguration)

  manage.proto:8

  / Join from new node

  message JoinRequest

  manage.proto:23

  • uint64 node_id = 1

    / Self-appointed node identifier

  • string replication_address = 2

    / Address that is used for replicating logs

  • string client_address = 3

    / Address used for servicing client requests

• rpc Poll (PollRequest, NodeConfiguration)

  manage.proto:11

  / Poll for reconfiguration. Serves as a heartbeat.

  message PollRequest

  manage.proto:41

  • uint64 node_id = 1

    / Node identifier to poll

• rpc Snapshot (ClientNodeRequest, ClientConfiguration)

  manage.proto:18

  / Gets all node configurations

  message ClientNodeRequest

  manage.proto:62

  (message has no fields)

  message ClientConfiguration

  manage.proto:64

  • repeated ClientNode nodes = 1

    / Node to send new log entries

Service for a linearizable commit log.

• rpc Append (AppendRequest, AppendAck)

  storage.proto:12

  Log Append issued against the HEAD node

  message AppendRequest

  storage.proto:26

  Request to append an entry to the log.

  • uint64 client_id = 1

    Client identifier. This is a persistent identifier used during the reply.

  • uint64 client_request_id = 2

    The identifier of the client request. This should be unique by client_id and client_request_id.

  • bytes payload = 3

    Payload of the log entry

  message AppendAck

  storage.proto:42

  Acknowledges that the log is starting the append cycle. This does not indicate that the entry is appended.

  (message has no fields)

• rpc LatestOffset (LatestOffsetQuery, LatestOffsetResult)

  storage.proto:19

  Queries latest offset from the node

  message LatestOffsetQuery

  storage.proto:46

  Query for the latest entry in the log

  (message has no fields)

  message LatestOffsetResult

  storage.proto:70

  Latest log offset

  • oneof latest_offset

    • uint64 offset = 1

• rpc QueryLog (QueryRequest, QueryResult)

  storage.proto:22

  Queries the log starting at the given offset

  message QueryRequest

  storage.proto:56

  Requests to read the log

  • uint64 start_offset = 1

    Starting offset to read from the log

  • uint32 max_bytes = 2

    Max number of bytes to read

  message QueryResult

  storage.proto:77

  Entries read from the log

  • repeated LogEntry entries = 1

• rpc Replies (ReplyRequest, stream Reply)

  storage.proto:16

  Generates a stream of committed log entries from the TAIL node from previously issued Append messages for a single client.

  message ReplyRequest

  storage.proto:50

  Request to generate a stream of committed log entries

  • uint64 client_id = 1

    The client identifier used to request replies

  message Reply

  storage.proto:64

  Set of entries appended to the log

  • repeated uint64 client_request_ids = 1

    Request IDs that have been completely appended

Used in: ClientConfiguration

• uint64 id = 1

  / Node identifier

• string client_address = 2

  / Address used for servicing client requests

Single entry in the log

Used in: QueryResult

• uint64 offset = 1

  Offset of the log entry

• bytes payload = 2

  Payload of the log entry

Used in: NodeConfiguration

• uint64 id = 1

  / Node identifier

• string replication_address = 2

  / Address used for replicating logs downstream

Used as response type in: Configuration.Join, Configuration.Poll

• optional Node self_node = 1

  / Metadata for the current

• repeated Node active_chain = 2

  / Active nodes in order

• uint32 quorum = 3

  Configured number of nodes to be considered available

• optional google.protobuf.Duration poll_wait = 4

  Duration of time to wait before the next poll call