package LibLogCabin.Protocol.Client

Get desktop application:
View/edit binary Protocol Buffers messages

* AdvanceStateMachineVersion state machine command: changes state machine behavior to the given version, if and only if the requested_version is greater than the state machine's current version. This is currently only used internally by the Raft servers. It is not currently sent by the client library, rather it is appended by the Raft leader automatically as needed.

(message has no fields)

Used in: StateMachineCommand.Request

• required uint32 requested_version = 1

Used in: StateMachineCommand.Response

• required uint32 running_version = 1

  * The version of the state machine behavior that the replicated state machine is running after applying this command (this will be at least the requested version, but may be higher if the state machine was already running a higher version).

* CloseSession state machine command: Terminate a session with the cluster. This cleans up any state that the session held; future RPCs on this session will have errors. \since This command was introduced in state machine version 2. State machines running version 1 will ignore this command; they only expire sessions based on timeouts.

(message has no fields)

Used in: StateMachineCommand.Request

• required uint64 client_id = 1

  * The ID assigned to the client as previously returned by OpenSession.

Used in: StateMachineCommand.Response

(message has no fields)

* The type of "service-specific error" replies that this service returns.

• optional Error.Code error_code = 1

• optional string leader_hint = 2

  * If error_code is NOT_LEADER and this field is set, the client should try the server found at this address, which is likely to be the current leader.

Used in: Error

• UNKNOWN = 0

  * This must be the first value in the enum and is never assigned explicitly. If new values are added, old code will see them as set and equal to this value (though they will still serialize to the correct value).

• NOT_LEADER = 1

  * The server is not the current cluster leader. The client should look elsewhere for the cluster leader. The server MAY provide a hint as to who the leader is (see leader_hint field).

* This is included in some RPCs to prevent processing of duplicated RPCs.

Used in: ReadWriteTree.Request

• required uint64 client_id = 1

  * A session ID returned from the OpenSession RPC. Valid client IDs will always be strictly greater than 0.

• required uint64 first_outstanding_rpc = 2

  * The lowest numbered RPC for which the client has not yet received a response. The server may discard all copies of responses for RPCs with smaller numbers.

• required uint64 rpc_number = 3

  * A strictly increasing sequence number for the RPC.

* GetConfiguration RPC: Get the current cluster configuration. This will only return stable configurations; the client will be asked to retry otherwise.

(message has no fields)

(message has no fields)

• required uint64 id = 1

  * Identifies the configuration. Pass this to SetConfiguration later.

• repeated Server servers = 2

  * The list of servers in the configuration.

* GetServerInfo RPC: Retrieve basic information from the given server used for reconfiguration.

(message has no fields)

(message has no fields)

• required Server server_info = 1

  * Server ID, listening addresses.

* Identifies which RPC is being executed.

• STATE_MACHINE_QUERY = 1

• STATE_MACHINE_COMMAND = 2

• VERIFY_RECIPIENT = 3

• GET_CONFIGURATION = 4

• SET_CONFIGURATION = 5

• GET_SERVER_STATS = 6

• GET_SERVER_INFO = 7

* OpenSession state machine command: Open a new session with the cluster. Sessions are necessary for some RPCs to provide exactly-once semantics.

(message has no fields)

Used in: StateMachineCommand.Request

(message has no fields)

Used in: StateMachineCommand.Response

• required uint64 client_id = 1

  * The ID assigned to the client.

* Read-only Tree state machine query: retrieves information from the hierarchical key-value store.

(message has no fields)

Used in: StateMachineQuery.Request

• optional TreeCondition condition = 11

• optional Request.ListDirectory list_directory = 2

• optional Request.Read read = 5

The following are mutually exclusive.

Used in: Request

• required string path = 1

Used in: Request

• required string path = 1

Used in: StateMachineQuery.Response

• optional Status status = 1

• optional string error = 2

  The following are mutually exclusive.

• optional Response.ListDirectory list_directory = 3

• optional Response.Read read = 4

Used in: Response

• repeated string child = 1

Used in: Response

• required bytes contents = 1

* Read-write Tree state machine command: modifies the hierarchical key-value store and retrieves information from it.

(message has no fields)

Used in: StateMachineCommand.Request

• required ExactlyOnceRPCInfo exactly_once = 10

  / See ExactlyOnceRPCInfo.

• optional TreeCondition condition = 11

• optional Request.MakeDirectory make_directory = 1

• optional Request.RemoveDirectory remove_directory = 3

• optional Request.Write write = 4

• optional Request.RemoveFile remove_file = 6

The following are mutually exclusive.

Used in: Request

• required string path = 1

Used in: Request

• required string path = 1

Used in: Request

• required string path = 1

Used in: Request

• required string path = 1

• required bytes contents = 2

Used in: StateMachineCommand.Response

• optional Status status = 1

• optional string error = 2

  The following are mutually exclusive.

* A server in a configuration. Used in the GetConfiguration and SetConfiguration RPCs.

Used in: GetConfiguration.Response, GetServerInfo.Response, SetConfiguration.Request, SetConfiguration.Response.ConfigurationBad

• required uint64 server_id = 1

  * The ID of the server.

• required string addresses = 2

  * The network address(es) of the server (comma-delimited).

* SetConfiguration RPC: Change the cluster's configuration.

(message has no fields)

• required uint64 old_id = 1

  * The ID of the cluster's current configuration.

• repeated Server new_servers = 2

  * The list of servers in the new configuration.

• optional Response.OK ok = 1

  * Set if the operation succeeded.

• optional Response.ConfigurationChanged configuration_changed = 2

  * Set if the supplied 'old_id' is no longer current. Call GetConfiguration, re-apply your changes, and try again.

• optional Response.ConfigurationBad configuration_bad = 3

  * Set if the reconfiguration was aborted because some servers are unavailable or too slow.

Used in: Response

• repeated Server bad_servers = 1

  * The servers that were unavailable to join the cluster.

Used in: Response

• optional string error = 1

The following are mutually exclusive.

Used in: Response

(message has no fields)

* StateMachineCommand RPC from clients that is processed by the replicated state machine.

(message has no fields)

* This is what the state machine takes in from the replicated log. These are read-write: they may modify the state machine state.

• optional OpenSession.Request open_session = 1

  The following are mutually exclusive.

• optional CloseSession.Request close_session = 4

• optional ReadWriteTree.Request tree = 2

• optional AdvanceStateMachineVersion.Request advance_version = 3

* This is what the state machine outputs for read-write commands from the log.

• optional OpenSession.Response open_session = 1

  The following are mutually exclusive.

• optional CloseSession.Response close_session = 4

• optional ReadWriteTree.Response tree = 2

• optional AdvanceStateMachineVersion.Response advance_version = 3

* StateMachineQuery RPC from clients that is processed by the replicated state machine.

(message has no fields)

* These are read-only queries that (in the current implementation) are not written to the replicated log (but behave as if they were from the client's perspective). These are read-only: they may not modify the state machine state.

• optional ReadOnlyTree.Request tree = 1

  The following are mutually exclusive.

* This is what the state machine outputs for read-only queries.

• optional ReadOnlyTree.Response tree = 1

  The following are mutually exclusive.

* The status code returned from Tree operations. For now, this should be the exact same as Client::Status and Tree::Status.

Used in: ReadOnlyTree.Response, ReadWriteTree.Response

• UNKNOWN = 10

  * This must be the first value in the enum and is never assigned explicitly. If new values are added, old code will see them as set and equal to this value (though they will still serialize to the correct value).

• OK = 0

• INVALID_ARGUMENT = 1

• LOOKUP_ERROR = 2

• TYPE_ERROR = 3

• CONDITION_NOT_MET = 4

• TIMEOUT = 5

  * This is only used internally in the client library; it is never sent over the network.

• SESSION_EXPIRED = 6

  * This session is no longer valid. Its state has been discarded on the server. The client should treat this as a fatal error.

* A predicate on Tree operations. If set, operations will return CONDITION_NOT_MET and have no effect unless the file at 'path' has the contents 'contents'.

Used in: ReadOnlyTree.Request, ReadWriteTree.Request

• required string path = 1

  * The absolute path to the file that must have the contents specified in 'contents'.

• required bytes contents = 2

  * The contents that the file specified by 'path' must have for the operation to succeed.

* VerifyRecipient RPC: Make sure we're talking to the intended recipient (to avoid disastrous confusion). This is called automatically by Client::SessionManager when creating new sessions.

(message has no fields)

• optional string cluster_uuid = 1

  * The cluster UUID that the recipient must match, if any.

• optional uint64 server_id = 2

  * The server ID of the recipient, if any.

• optional string cluster_uuid = 1

  * The recipient's cluster UUID.

• optional uint64 server_id = 2

  * The recipient's server ID.

• optional bool ok = 3

  * Set to true if everything matched successfully.

• optional string error = 4

  * If there was an error, a message describing why.