blob: b35f1f3236a41bab327c22865570f1cef1997a01 [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
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 */
16package kvstore
17
Neha Sharma130ac6d2020-04-08 08:46:32 +000018import (
19 "context"
20 "time"
21)
npujar5bf737f2020-01-16 19:35:25 +053022
Scott Baker2c1c4822019-10-16 11:02:41 -070023const (
Scott Baker2c1c4822019-10-16 11:02:41 -070024 // Maximum channel buffer between publisher/subscriber goroutines
25 maxClientChannelBufferSize = 10
26)
27
28// These constants represent the event types returned by the KV client
29const (
30 PUT = iota
31 DELETE
32 CONNECTIONDOWN
33 UNKNOWN
34)
35
36// KVPair is a common wrapper for key-value pairs returned from the KV store
37type KVPair struct {
38 Key string
39 Value interface{}
40 Version int64
41 Session string
42 Lease int64
43}
44
Scott Baker2c1c4822019-10-16 11:02:41 -070045// NewKVPair creates a new KVPair object
46func NewKVPair(key string, value interface{}, session string, lease int64, version int64) *KVPair {
47 kv := new(KVPair)
48 kv.Key = key
49 kv.Value = value
50 kv.Session = session
51 kv.Lease = lease
52 kv.Version = version
53 return kv
54}
55
56// Event is generated by the KV client when a key change is detected
57type Event struct {
58 EventType int
59 Key interface{}
60 Value interface{}
61 Version int64
62}
63
64// NewEvent creates a new Event object
65func NewEvent(eventType int, key interface{}, value interface{}, version int64) *Event {
66 evnt := new(Event)
67 evnt.EventType = eventType
68 evnt.Key = key
69 evnt.Value = value
70 evnt.Version = version
71
72 return evnt
73}
74
75// Client represents the set of APIs a KV Client must implement
76type Client interface {
npujar5bf737f2020-01-16 19:35:25 +053077 List(ctx context.Context, key string) (map[string]*KVPair, error)
78 Get(ctx context.Context, key string) (*KVPair, error)
79 Put(ctx context.Context, key string, value interface{}) error
80 Delete(ctx context.Context, key string) error
Serkant Uluderya198de902020-11-16 20:29:17 +030081 DeleteWithPrefix(ctx context.Context, prefixKey string) error
Neha Sharma130ac6d2020-04-08 08:46:32 +000082 Reserve(ctx context.Context, key string, value interface{}, ttl time.Duration) (interface{}, error)
npujar5bf737f2020-01-16 19:35:25 +053083 ReleaseReservation(ctx context.Context, key string) error
84 ReleaseAllReservations(ctx context.Context) error
85 RenewReservation(ctx context.Context, key string) error
divyadesai8bf96862020-02-07 12:24:26 +000086 Watch(ctx context.Context, key string, withPrefix bool) chan *Event
Neha Sharma130ac6d2020-04-08 08:46:32 +000087 AcquireLock(ctx context.Context, lockName string, timeout time.Duration) error
Scott Baker2c1c4822019-10-16 11:02:41 -070088 ReleaseLock(lockName string) error
npujar5bf737f2020-01-16 19:35:25 +053089 IsConnectionUp(ctx context.Context) bool // timeout in second
Neha Sharma94f16a92020-06-26 04:17:55 +000090 CloseWatch(ctx context.Context, key string, ch chan *Event)
91 Close(ctx context.Context)
Scott Baker2c1c4822019-10-16 11:02:41 -070092}