Default package

Get desktop application:
View/edit binary Protocol Buffers messages

General namespace arguments

Used in: Mpb_Request

• required string namespace = 1

  In single chain/non-clustered environment, use namespace=""

• required string prefix = 10

• required bytes chunk = 11

• required Mpb_ChunkCSum csum = 12

• optional uint32 chunk_extra = 20

• optional string preferred_file_name = 21

• optional bool flag_fail_preferred = 22

  Fail the operation if our preferred file name is not available

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_ChunkPos chunk_pos = 2

  If OK, then chunk_pos is defined.

Used in: Mpb_LL_Request, Mpb_Request

• required bytes user = 1

• required bytes password = 2

Used in: Mpb_LL_Response, Mpb_Response

• required int32 code = 1

  TODO: not implemented yet

Must match with machi.hrl's values!

Used in: Mpb_ChunkCSum

• CSUM_TAG_NONE = 0

• CSUM_TAG_CLIENT_SHA = 1

• CSUM_TAG_SERVER_SHA = 2

• CSUM_TAG_SERVER_REGEN_SHA = 3

Used in: Mpb_Request

• required string file = 1

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1

• optional bytes chunk = 2

  For data type rationale, see comments for machi_flu1_client:checksum_list/4 or http://basho.github.io/machi/edoc/machi_flu1_client.html#checksum_list-4

Used in: Mpb_LL_ReadChunkResp, Mpb_LL_WriteChunkReq, Mpb_ReadChunkResp, Mpb_WriteChunkReq

• required uint64 offset = 1

• required string file_name = 2

• required bytes chunk = 3

• optional Mpb_ChunkCSum csum = 4

  TODO: must be required, in future?

chunk_csum() type

Used in: Mpb_AppendChunkReq, Mpb_Chunk, Mpb_LL_AppendChunkReq

• required Mpb_CSumType type = 1

• optional bytes csum = 2

chunk_pos() type

Used in: Mpb_AppendChunkResp, Mpb_LL_AppendChunkResp, Mpb_LL_ReadChunkReq, Mpb_LL_ReadChunkResp, Mpb_ReadChunkReq, Mpb_ReadChunkResp, Mpb_TrimChunkReq

• required uint64 offset = 1

• required uint64 chunk_size = 2

• required string file_name = 3

Used in: Mpb_LL_Request, Mpb_Request

• optional string message = 1

Used in: Mpb_LL_Response, Mpb_Response

• optional string message = 1

epoch_id() type

Used in: Mpb_LL_AppendChunkReq, Mpb_LL_DeleteMigrationReq, Mpb_LL_GetLatestEpochIDResp, Mpb_LL_ListFilesReq, Mpb_LL_ReadChunkReq, Mpb_LL_TrimChunkReq, Mpb_LL_TruncHackReq, Mpb_LL_WedgeStatusResp, Mpb_LL_WriteChunkReq

• required uint32 epoch_number = 1

• required bytes epoch_csum = 2

Error response - may be generated for any Req

Used in: Mpb_LL_Response, Mpb_Response

• required int32 code = 1

  Free-form (depends on server, which is probably a bad idea TODO)

• required string msg = 2

• optional bytes extra = 3

file_info() type

Used in: Mpb_LL_ListFilesResp, Mpb_ListFilesResp

• required uint64 file_size = 1

• required string file_name = 2

Used in: Mpb_AppendChunkResp, Mpb_ChecksumListResp, Mpb_LL_AppendChunkResp, Mpb_LL_ChecksumListResp, Mpb_LL_DeleteMigrationResp, Mpb_LL_GetAllProjectionsResp, Mpb_LL_GetLatestEpochIDResp, Mpb_LL_ListAllProjectionsResp, Mpb_LL_ListFilesResp, Mpb_LL_ReadChunkResp, Mpb_LL_ReadLatestProjectionResp, Mpb_LL_ReadProjectionResp, Mpb_LL_TrimChunkResp, Mpb_LL_TruncHackResp, Mpb_LL_WedgeStatusResp, Mpb_LL_WriteChunkResp, Mpb_LL_WriteProjectionResp, Mpb_ListFilesResp, Mpb_ReadChunkResp, Mpb_TrimChunkResp, Mpb_WriteChunkResp

• OK = 0

• BAD_ARG = 1

• WEDGED = 2

• BAD_CHECKSUM = 3

• PARTITION = 4

  * There is no timout error code, only PARTITION. If the client * wants to know if a lot of time has elapsed, then the client * can do its own timekeeping.

• NOT_WRITTEN = 5

• WRITTEN = 6

• TRIMMED = 7

  The whole file was trimmed

• NO_SUCH_FILE = 8

• PARTIAL_READ = 9

• BAD_EPOCH = 10

• BAD_JOSS = 255

  Only for testing by the Taipan

Used in: Mpb_LL_Request

• required uint32 namespace_version = 1

  General namespace arguments

• required string namespace = 2

• required uint32 locator = 3

• required Mpb_EpochID epoch_id = 10

• required string prefix = 11

• required bytes chunk = 12

• required Mpb_ChunkCSum csum = 13

• optional uint32 chunk_extra = 20

• optional string preferred_file_name = 21

• optional bool flag_fail_preferred = 22

  Fail the operation if our preferred file name is not available

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_ChunkPos chunk_pos = 2

  If OK, then chunk_pos is defined.

Used in: Mpb_LL_Request

• required string file = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional bytes chunk = 2

  For data type rationale, see comments for machi_flu1_client:checksum_list/4 or http://basho.github.io/machi/edoc/machi_flu1_client.html#checksum_list-4

Used in: Mpb_LL_Request

• required Mpb_EpochID epoch_id = 1

• required string file = 2

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• repeated Mpb_ProjectionV1 projs = 2

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_EpochID epoch_id = 2

Used in: Mpb_LL_Request

(message has no fields)

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• repeated uint32 epochs = 2

Used in: Mpb_LL_Request

• required Mpb_EpochID epoch_id = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• repeated Mpb_FileInfo files = 2

Used in: Mpb_LL_Request

• required uint32 namespace_version = 1

  General namespace arguments

• required string namespace = 2

• required Mpb_EpochID epoch_id = 10

• required Mpb_ChunkPos chunk_pos = 11

• optional bool flag_no_checksum = 20

  Use flag_no_checksum=non-zero to skip returning the chunk's checksum. TODO: not implemented yet.

• optional bool flag_no_chunk = 21

  Use flag_no_chunk=non-zero to skip returning the chunk (which only makes sense if flag_checksum is not set). TODO: not implemented yet.

• optional bool flag_needs_trimmed = 22

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• repeated Mpb_Chunk chunks = 2

• repeated Mpb_ChunkPos trimmed = 3

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_ProjectionV1 proj = 2

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

• required uint32 epoch_number = 2

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_ProjectionV1 proj = 2

• required bytes req_id = 1

  TODO: If we wish to support pipelined requests sometime in the future, this is the placeholder to do it.

• required uint32 do_not_alter = 2

  CLIENTS must not set 'do_not_alter' flag; leave it to default.

• optional Mpb_EchoReq echo = 10

  The client should only define one request message. If the client includes multiple requests here, the server may pick/choose an arbitrary one. NOTE: The erlang protobuffs compiler doesn't support 'oneof'. But 'oneof' appears to be a very tiny memory optimization that not all languages might care about? (Erlang doesn't)

  Re-use from high level API

• optional Mpb_AuthReq auth = 11

  Re-use from high level API

• optional Mpb_LL_GetLatestEpochIDReq proj_gl = 12

• optional Mpb_LL_ReadLatestProjectionReq proj_rl = 13

• optional Mpb_LL_ReadProjectionReq proj_rp = 14

• optional Mpb_LL_WriteProjectionReq proj_wp = 15

• optional Mpb_LL_GetAllProjectionsReq proj_ga = 16

• optional Mpb_LL_ListAllProjectionsReq proj_la = 17

• optional Mpb_LL_KickProjectionReactionReq proj_kp = 18

• optional Mpb_LL_AppendChunkReq append_chunk = 30

• optional Mpb_LL_WriteChunkReq write_chunk = 31

• optional Mpb_LL_ReadChunkReq read_chunk = 32

• optional Mpb_LL_TrimChunkReq trim_chunk = 33

• optional Mpb_LL_ChecksumListReq checksum_list = 34

• optional Mpb_LL_ListFilesReq list_files = 35

• optional Mpb_LL_WedgeStatusReq wedge_status = 36

• optional Mpb_LL_DeleteMigrationReq delete_migration = 37

• optional Mpb_LL_TruncHackReq trunc_hack = 38

• required bytes req_id = 1

  TODO: If we wish to support pipelined requests sometime in the future, this is the placeholder to do it.

• optional Mpb_ErrorResp generic = 2

  Generic error response, typically used when something quite bad/unexpected happened within the server. Clients should always check this response and, if defined, ignore any request-specific response at codes 10+.

• optional Mpb_EchoResp echo = 10

  Specific responses.

  Re-use from high level API

• optional Mpb_AuthResp auth = 11

  Re-use from high level API

• optional Mpb_LL_GetLatestEpochIDResp proj_gl = 12

• optional Mpb_LL_ReadLatestProjectionResp proj_rl = 13

• optional Mpb_LL_ReadProjectionResp proj_rp = 14

• optional Mpb_LL_WriteProjectionResp proj_wp = 15

• optional Mpb_LL_GetAllProjectionsResp proj_ga = 16

• optional Mpb_LL_ListAllProjectionsResp proj_la = 17

  No reponse to Mpb_LL_KickProjectionReactionReq = 18;

• optional Mpb_LL_AppendChunkResp append_chunk = 30

• optional Mpb_LL_WriteChunkResp write_chunk = 31

• optional Mpb_LL_ReadChunkResp read_chunk = 32

• optional Mpb_LL_TrimChunkResp trim_chunk = 33

• optional Mpb_LL_ChecksumListResp checksum_list = 34

• optional Mpb_LL_ListFilesResp list_files = 35

• optional Mpb_LL_WedgeStatusResp wedge_status = 36

• optional Mpb_LL_DeleteMigrationResp delete_migration = 37

• optional Mpb_LL_TruncHackResp trunc_hack = 38

Used in: Mpb_LL_Request

• required uint32 namespace_version = 1

  General namespace arguments

• required string namespace = 2

• required Mpb_EpochID epoch_id = 10

• required string file = 11

• required uint64 offset = 12

• required uint32 size = 13

• optional bool trigger_gc = 20

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

Used in: Mpb_LL_Request

• required Mpb_EpochID epoch_id = 1

• required string file = 2

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

No options

Used in: Mpb_LL_Request

(message has no fields)

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

• optional Mpb_EpochID epoch_id = 2

• optional bool wedged_flag = 3

• optional uint32 namespace_version = 4

• optional string namespace = 5

Used in: Mpb_LL_Request

• required uint32 namespace_version = 1

  General namespace arguments

• required string namespace = 2

• required Mpb_EpochID epoch_id = 10

• required Mpb_Chunk chunk = 11

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

Used in: Mpb_LL_Request

• required Mpb_ProjType type = 1

• required Mpb_ProjectionV1 proj = 2

Used in: Mpb_LL_Response

• required Mpb_GeneralStatusCode status = 1

TODO: Add flag for file glob/regexp/other filter type TODO: What else could go wrong?

Used in: Mpb_Request

(message has no fields)

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1

• repeated Mpb_FileInfo files = 2

  Wow, I cannot use optional & repeated together?

Used in: Mpb_ProjectionV1

• required string key = 1

• required Mpb_P_Srvr val = 2

Used in: Mpb_ProjectionV1

• AP_MODE = 30

• CP_MODE = 31

Used in: Mpb_ProjectionV1

• required uint64 sec = 1

• required uint32 usec = 2

#p_srvr{} type

Used in: Mpb_MembersDictEntry

• required string name = 1

• required string proto_mod = 2

• required string address = 3

• required string port = 4

• required bytes opaque_props = 5

Used in: Mpb_LL_GetAllProjectionsReq, Mpb_LL_GetLatestEpochIDReq, Mpb_LL_ListAllProjectionsReq, Mpb_LL_ReadLatestProjectionReq, Mpb_LL_ReadProjectionReq, Mpb_LL_WriteProjectionReq

• PRIVATE = 20

• PUBLIC = 21

Used in: Mpb_LL_GetAllProjectionsResp, Mpb_LL_ReadLatestProjectionResp, Mpb_LL_ReadProjectionResp, Mpb_LL_WriteProjectionReq

• required uint32 epoch_number = 1

• required bytes epoch_csum = 2

• required string author_server = 3

• required string chain_name = 4

• repeated string all_members = 5

• repeated string witnesses = 6

• required Mpb_Now creation_time = 7

• required Mpb_Mode mode = 8

• repeated string upi = 9

• repeated string repairing = 10

• repeated string down = 11

• required bytes opaque_dbg = 12

• required bytes opaque_dbg2 = 13

• repeated Mpb_MembersDictEntry members_dict = 14

No namespace arguments are required because NS is embedded inside of the file name.

Used in: Mpb_Request

• required Mpb_ChunkPos chunk_pos = 10

• optional bool flag_no_checksum = 20

  Use flag_no_checksum=non-zero to skip returning the chunk's checksum. TODO: not implemented yet.

• optional bool flag_no_chunk = 21

  Use flag_no_chunk=non-zero to skip returning the chunk (which only makes sense if flag_no_checksum is not set). TODO: not implemented yet.

• optional bool flag_needs_trimmed = 22

  TODO: not implemented yet.

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1

• repeated Mpb_Chunk chunks = 2

• repeated Mpb_ChunkPos trimmed = 3

• required bytes req_id = 1

  TODO: If we wish to support pipelined requests sometime in the future, this is the placeholder to do it.

• required uint32 do_not_alter = 2

  CLIENTS must not set 'do_not_alter' flag; leave it to default.

• optional Mpb_EchoReq echo = 110

  The client should only define one request message. If the client includes multiple requests here, the server may pick/choose an arbitrary one. NOTE: The erlang protobuffs compiler doesn't support 'oneof'. But 'oneof' appears to be a very tiny memory optimization that not all languages might care about? (Erlang doesn't)

• optional Mpb_AuthReq auth = 111

• optional Mpb_AppendChunkReq append_chunk = 112

• optional Mpb_WriteChunkReq write_chunk = 113

• optional Mpb_ReadChunkReq read_chunk = 114

• optional Mpb_TrimChunkReq trim_chunk = 115

• optional Mpb_ChecksumListReq checksum_list = 116

• optional Mpb_ListFilesReq list_files = 117

• required bytes req_id = 1

  TODO: If we wish to support pipelined requests sometime in the future, this is the placeholder to do it.

• optional Mpb_ErrorResp generic = 2

  Generic error response, typically used when something quite bad/unexpected happened within the server. Clients should always check this response and, if defined, ignore any request-specific response at codes 10+.

• optional Mpb_EchoResp echo = 10

  Specific responses.

• optional Mpb_AuthResp auth = 11

• optional Mpb_AppendChunkResp append_chunk = 12

• optional Mpb_WriteChunkResp write_chunk = 13

• optional Mpb_ReadChunkResp read_chunk = 14

• optional Mpb_TrimChunkResp trim_chunk = 15

• optional Mpb_ChecksumListResp checksum_list = 16

• optional Mpb_ListFilesResp list_files = 17

Used in: Mpb_Request

• required Mpb_ChunkPos chunk_pos = 1

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1

Used in: Mpb_Request

• required Mpb_Chunk chunk = 10

Used in: Mpb_Response

• required Mpb_GeneralStatusCode status = 1