Skip to content

Commit

Permalink
feat: add lock.proto (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
fengys1996 authored Feb 10, 2023
1 parent 328c41f commit b846743
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
1 change: 1 addition & 0 deletions build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ fn main() {
"proto/greptime/v1/meta/heartbeat.proto",
"proto/greptime/v1/meta/route.proto",
"proto/greptime/v1/meta/store.proto",
"proto/greptime/v1/meta/lock.proto",
"proto/greptime/v1/meta/cluster.proto",
"proto/prometheus/remote/remote.proto",
],
Expand Down
43 changes: 43 additions & 0 deletions proto/greptime/v1/meta/lock.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
syntax = "proto3";

package greptime.v1.meta;

import "greptime/v1/meta/common.proto";

service Lock {
// Lock acquires a distributed shared lock on a given named lock. On success, it
// will return a unique key that exists so long as the lock is held by the caller.
rpc Lock(LockRequest) returns (LockResponse);

// Unlock takes a key returned by Lock and releases the hold on lock.
rpc Unlock(UnlockRequest) returns (UnlockResponse);
}

message LockRequest {
RequestHeader header = 1;

// Name is the identifier for the distributed shared lock to be acquired.
bytes name = 2;

// If the expiration time is exceeded and currently holds the lock, the lock is
// aytomatically released. The unit is second.
int64 expire = 3;
}

message LockResponse {
ResponseHeader header = 1;

// Key will exist as long as lock is held by the caller.
bytes key = 2;
}

message UnlockRequest {
RequestHeader header = 1;

// key is the lock ownership key granted by Lock.
bytes key = 2;
}

message UnlockResponse {
ResponseHeader header = 1;
}
2 changes: 2 additions & 0 deletions src/v1/meta.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ gen_set_header!(BatchPutRequest);
gen_set_header!(CompareAndPutRequest);
gen_set_header!(DeleteRangeRequest);
gen_set_header!(MoveValueRequest);
gen_set_header!(LockRequest);
gen_set_header!(UnlockRequest);

#[cfg(test)]
mod tests {
Expand Down

0 comments on commit b846743

Please sign in to comment.