blob: 937eefebd0249af1640b4c33018457b936324a74 [file] [log] [blame]
khenaidoobf6e7bb2018-08-14 22:27:29 -04001/*
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 */
khenaidoocfee5f42018-07-19 22:47:38 -040016package kvstore
17
khenaidoob9203542018-09-17 22:56:37 -040018import (
19 "github.com/opencord/voltha-go/common/log"
20)
21
khenaidoocfee5f42018-07-19 22:47:38 -040022const (
23 // Default timeout in seconds when making a kvstore request
24 defaultKVGetTimeout = 5
25 // Maximum channel buffer between publisher/subscriber goroutines
26 maxClientChannelBufferSize = 10
27)
28
29// These constants represent the event types returned by the KV client
30const (
31 PUT = iota
32 DELETE
33 CONNECTIONDOWN
34 UNKNOWN
35)
36
37// KVPair is a common wrapper for key-value pairs returned from the KV store
38type KVPair struct {
39 Key string
40 Value interface{}
Stephane Barbarieef6650d2019-07-18 12:15:09 -040041 Version int64
khenaidoocfee5f42018-07-19 22:47:38 -040042 Session string
43 Lease int64
44}
45
khenaidoob9203542018-09-17 22:56:37 -040046func init() {
47 log.AddPackage(log.JSON, log.WarnLevel, nil)
48}
49
khenaidoocfee5f42018-07-19 22:47:38 -040050// NewKVPair creates a new KVPair object
Stephane Barbarieef6650d2019-07-18 12:15:09 -040051func NewKVPair(key string, value interface{}, session string, lease int64, version int64) *KVPair {
khenaidoocfee5f42018-07-19 22:47:38 -040052 kv := new(KVPair)
53 kv.Key = key
54 kv.Value = value
55 kv.Session = session
56 kv.Lease = lease
Stephane Barbarieef6650d2019-07-18 12:15:09 -040057 kv.Version = version
khenaidoocfee5f42018-07-19 22:47:38 -040058 return kv
59}
60
61// Event is generated by the KV client when a key change is detected
62type Event struct {
63 EventType int
64 Key interface{}
65 Value interface{}
Stephane Barbarieef6650d2019-07-18 12:15:09 -040066 Version int64
khenaidoocfee5f42018-07-19 22:47:38 -040067}
68
69// NewEvent creates a new Event object
Stephane Barbarieef6650d2019-07-18 12:15:09 -040070func NewEvent(eventType int, key interface{}, value interface{}, version int64) *Event {
khenaidoocfee5f42018-07-19 22:47:38 -040071 evnt := new(Event)
72 evnt.EventType = eventType
73 evnt.Key = key
74 evnt.Value = value
Stephane Barbarieef6650d2019-07-18 12:15:09 -040075 evnt.Version = version
khenaidoocfee5f42018-07-19 22:47:38 -040076
77 return evnt
78}
79
80// Client represents the set of APIs a KV Client must implement
81type Client interface {
Stephane Barbarie260a5632019-02-26 16:12:49 -050082 List(key string, timeout int, lock ...bool) (map[string]*KVPair, error)
83 Get(key string, timeout int, lock ...bool) (*KVPair, error)
84 Put(key string, value interface{}, timeout int, lock ...bool) error
85 Delete(key string, timeout int, lock ...bool) error
khenaidoocfee5f42018-07-19 22:47:38 -040086 Reserve(key string, value interface{}, ttl int64) (interface{}, error)
87 ReleaseReservation(key string) error
88 ReleaseAllReservations() error
89 RenewReservation(key string) error
90 Watch(key string) chan *Event
khenaidoobdcb8e02019-03-06 16:28:56 -050091 AcquireLock(lockName string, timeout int) error
92 ReleaseLock(lockName string) error
khenaidoocfee5f42018-07-19 22:47:38 -040093 CloseWatch(key string, ch chan *Event)
94 Close()
95}