khenaidoo | bf6e7bb | 2018-08-14 22:27:29 -0400 | [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 | */ |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 16 | package kvstore |
| 17 | |
| 18 | const ( |
| 19 | // Default timeout in seconds when making a kvstore request |
| 20 | defaultKVGetTimeout = 5 |
| 21 | // Maximum channel buffer between publisher/subscriber goroutines |
| 22 | maxClientChannelBufferSize = 10 |
| 23 | ) |
| 24 | |
| 25 | // These constants represent the event types returned by the KV client |
| 26 | const ( |
| 27 | PUT = iota |
| 28 | DELETE |
| 29 | CONNECTIONDOWN |
| 30 | UNKNOWN |
| 31 | ) |
| 32 | |
| 33 | // KVPair is a common wrapper for key-value pairs returned from the KV store |
| 34 | type KVPair struct { |
| 35 | Key string |
| 36 | Value interface{} |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 37 | Version int64 |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 38 | Session string |
| 39 | Lease int64 |
| 40 | } |
| 41 | |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 42 | // NewKVPair creates a new KVPair object |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 43 | func NewKVPair(key string, value interface{}, session string, lease int64, version int64) *KVPair { |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 44 | kv := new(KVPair) |
| 45 | kv.Key = key |
| 46 | kv.Value = value |
| 47 | kv.Session = session |
| 48 | kv.Lease = lease |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 49 | kv.Version = version |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 50 | return kv |
| 51 | } |
| 52 | |
| 53 | // Event is generated by the KV client when a key change is detected |
| 54 | type Event struct { |
| 55 | EventType int |
| 56 | Key interface{} |
| 57 | Value interface{} |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 58 | Version int64 |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | // NewEvent creates a new Event object |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 62 | func NewEvent(eventType int, key interface{}, value interface{}, version int64) *Event { |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 63 | evnt := new(Event) |
| 64 | evnt.EventType = eventType |
| 65 | evnt.Key = key |
| 66 | evnt.Value = value |
Stephane Barbarie | ef6650d | 2019-07-18 12:15:09 -0400 | [diff] [blame] | 67 | evnt.Version = version |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 68 | |
| 69 | return evnt |
| 70 | } |
| 71 | |
khenaidoo | b324421 | 2019-08-27 14:32:27 -0400 | [diff] [blame] | 72 | // Client represents the set of APIs a KV Client must implement |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 73 | type Client interface { |
sbarbari | 17d7e22 | 2019-11-05 10:02:29 -0500 | [diff] [blame] | 74 | List(key string, timeout int) (map[string]*KVPair, error) |
| 75 | Get(key string, timeout int) (*KVPair, error) |
| 76 | Put(key string, value interface{}, timeout int) error |
| 77 | Delete(key string, timeout int) error |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 78 | Reserve(key string, value interface{}, ttl int64) (interface{}, error) |
| 79 | ReleaseReservation(key string) error |
| 80 | ReleaseAllReservations() error |
| 81 | RenewReservation(key string) error |
| 82 | Watch(key string) chan *Event |
khenaidoo | bdcb8e0 | 2019-03-06 16:28:56 -0500 | [diff] [blame] | 83 | AcquireLock(lockName string, timeout int) error |
| 84 | ReleaseLock(lockName string) error |
khenaidoo | b324421 | 2019-08-27 14:32:27 -0400 | [diff] [blame] | 85 | IsConnectionUp(timeout int) bool // timeout in second |
khenaidoo | cfee5f4 | 2018-07-19 22:47:38 -0400 | [diff] [blame] | 86 | CloseWatch(key string, ch chan *Event) |
| 87 | Close() |
| 88 | } |