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 }
  34
  35 //Database struct is a holder for the internal database instances.
  36 type Database struct {
  37         Instances []iDatabase
  38 }
  39
  40 //DbCreateCb callback function type to create a new database
  41 type DbCreateCb func() *Database
  42
  43 //iSyncStorage is an interface towards SDL SyncStorage API
  44 type ISyncStorage interface {
  45         Get(ns string, keys []string) (map[string]interface{}, error)
  46         ListKeys(ns string, pattern string) ([]string, error)
  47         Set(ns string, pairs ...interface{}) error
  48         Remove(ns string, keys []string) error
  49 }
  50
  51 //SyncStorageCreateCb callback function type to create a new SyncStorageInterface
  52 type SyncStorageCreateCb func() ISyncStorage
  53
  54 //keysArgs struct is used for keys command arguments.
  55 type keysArgs struct {
  56         ns      string
  57         pattern string
  58 }
  59
  60 //newKeysArgs constructs a new keysArgs struct.
  61 func newKeysArgs(ns string, pattern string) keysArgs {
  62         return keysArgs{
  63                 ns:      ns,
  64                 pattern: pattern,
  65         }
  66 }
  67
  68 //nsMap is a map having SDL DB cluster address as a key and namespace map of type nsKeyMap as a value
  69 type nsMap map[string]nsKeyMap
  70
  71 //nsKeyMap is a map having namespace as a key and DB key count as a value
  72 type nsKeyMap map[string]uint32
  73
  74 //SdlCliApp constant defines the name of the SDL CLI application
  75 const SdlCliApp = "sdlcli"