Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package kvstore |
| 17 | |
Neha Sharma | 130ac6d | 2020-04-08 08:46:32 +0000 | [diff] [blame] | 18 | import ( |
| 19 | "context" |
| 20 | "time" |
| 21 | ) |
npujar | 5bf737f | 2020-01-16 19:35:25 +0530 | [diff] [blame] | 22 | |
Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 23 | const ( |
| 24 | // Default timeout in seconds when making a kvstore request |
Neha Sharma | 130ac6d | 2020-04-08 08:46:32 +0000 | [diff] [blame] | 25 | defaultKVGetTimeout = 5 * time.Second |
Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 26 | // Maximum channel buffer between publisher/subscriber goroutines |
| 27 | maxClientChannelBufferSize = 10 |
| 28 | ) |
| 29 | |
| 30 | // These constants represent the event types returned by the KV client |
| 31 | const ( |
| 32 | PUT = iota |
| 33 | DELETE |
| 34 | CONNECTIONDOWN |
| 35 | UNKNOWN |
| 36 | ) |
| 37 | |
| 38 | // KVPair is a common wrapper for key-value pairs returned from the KV store |
| 39 | type KVPair struct { |
| 40 | Key string |
| 41 | Value interface{} |
| 42 | Version int64 |
| 43 | Session string |
| 44 | Lease int64 |
| 45 | } |
| 46 | |
Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 47 | // NewKVPair creates a new KVPair object |
| 48 | func NewKVPair(key string, value interface{}, session string, lease int64, version int64) *KVPair { |
| 49 | kv := new(KVPair) |
| 50 | kv.Key = key |
| 51 | kv.Value = value |
| 52 | kv.Session = session |
| 53 | kv.Lease = lease |
| 54 | kv.Version = version |
| 55 | return kv |
| 56 | } |
| 57 | |
| 58 | // Event is generated by the KV client when a key change is detected |
| 59 | type Event struct { |
| 60 | EventType int |
| 61 | Key interface{} |
| 62 | Value interface{} |
| 63 | Version int64 |
| 64 | } |
| 65 | |
| 66 | // NewEvent creates a new Event object |
| 67 | func NewEvent(eventType int, key interface{}, value interface{}, version int64) *Event { |
| 68 | evnt := new(Event) |
| 69 | evnt.EventType = eventType |
| 70 | evnt.Key = key |
| 71 | evnt.Value = value |
| 72 | evnt.Version = version |
| 73 | |
| 74 | return evnt |
| 75 | } |
| 76 | |
| 77 | // Client represents the set of APIs a KV Client must implement |
| 78 | type Client interface { |
npujar | 5bf737f | 2020-01-16 19:35:25 +0530 | [diff] [blame] | 79 | List(ctx context.Context, key string) (map[string]*KVPair, error) |
| 80 | Get(ctx context.Context, key string) (*KVPair, error) |
| 81 | Put(ctx context.Context, key string, value interface{}) error |
| 82 | Delete(ctx context.Context, key string) error |
Neha Sharma | 130ac6d | 2020-04-08 08:46:32 +0000 | [diff] [blame] | 83 | Reserve(ctx context.Context, key string, value interface{}, ttl time.Duration) (interface{}, error) |
npujar | 5bf737f | 2020-01-16 19:35:25 +0530 | [diff] [blame] | 84 | ReleaseReservation(ctx context.Context, key string) error |
| 85 | ReleaseAllReservations(ctx context.Context) error |
| 86 | RenewReservation(ctx context.Context, key string) error |
divyadesai | 8bf9686 | 2020-02-07 12:24:26 +0000 | [diff] [blame] | 87 | Watch(ctx context.Context, key string, withPrefix bool) chan *Event |
Neha Sharma | 130ac6d | 2020-04-08 08:46:32 +0000 | [diff] [blame] | 88 | AcquireLock(ctx context.Context, lockName string, timeout time.Duration) error |
Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 89 | ReleaseLock(lockName string) error |
npujar | 5bf737f | 2020-01-16 19:35:25 +0530 | [diff] [blame] | 90 | IsConnectionUp(ctx context.Context) bool // timeout in second |
Scott Baker | 2c1c482 | 2019-10-16 11:02:41 -0700 | [diff] [blame] | 91 | CloseWatch(key string, ch chan *Event) |
| 92 | Close() |
| 93 | } |