internal/cli/types.go

   1 /*
   2    Copyright (c) 2021 AT&T Intellectual Property.
   3    Copyright (c) 2018-2021 Nokia.
   4
   5    Licensed under the Apache License, Version 2.0 (the "License");
   6    you may not use this file except in compliance with the License.
   7    You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11    Unless required by applicable law or agreed to in writing, software
  12    distributed under the License is distributed on an "AS IS" BASIS,
  13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14    See the License for the specific language governing permissions and
  15    limitations under the License.
  16 */
  17
  18 /*
  19  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  20  * platform project (RICP).
  21  */
  22
  23 package cli
  24
  25 import "gerrit.o-ran-sc.org/r/ric-plt/sdlgo/internal/sdlgoredis"
  26
  27 //iDatabase is an interface towards database backend, for the time being
  28 //sdlgoredis.DB implements this interface.
  29 type iDatabase interface {
  30         Info() (*sdlgoredis.DbInfo, error)
  31         State() (*sdlgoredis.DbState, error)
  32         Keys(pattern string) ([]string, error)
  33         Statistics() (*sdlgoredis.DbStatistics, error)
  34 }
  35
  36 //Database struct is a holder for the internal database instances.
  37 type Database struct {
  38         Instances []iDatabase
  39 }
  40
  41 //DbCreateCb callback function type to create a new database
  42 type DbCreateCb func() *Database
  43
  44 //iSyncStorage is an interface towards SDL SyncStorage API
  45 type ISyncStorage interface {
  46         Get(ns string, keys []string) (map[string]interface{}, error)
  47         ListKeys(ns string, pattern string) ([]string, error)
  48         Set(ns string, pairs ...interface{}) error
  49         Remove(ns string, keys []string) error
  50 }
  51
  52 //SyncStorageCreateCb callback function type to create a new SyncStorageInterface
  53 type SyncStorageCreateCb func() ISyncStorage
  54
  55 //keysArgs struct is used for keys command arguments.
  56 type keysArgs struct {
  57         ns      string
  58         pattern string
  59 }
  60
  61 //newKeysArgs constructs a new keysArgs struct.
  62 func newKeysArgs(ns string, pattern string) keysArgs {
  63         return keysArgs{
  64                 ns:      ns,
  65                 pattern: pattern,
  66         }
  67 }
  68
  69 //nsMap is a map having SDL DB cluster address as a key and namespace map of type nsKeyMap as a value
  70 type nsMap map[string]nsKeyMap
  71
  72 //nsKeyMap is a map having namespace as a key and DB key count as a value
  73 type nsKeyMap map[string]uint32
  74
  75 //SdlCliApp constant defines the name of the SDL CLI application
  76 const SdlCliApp = "sdlcli"