pkg/control/registry.go

   1 /*
   2 ==================================================================================
   3   Copyright (c) 2019 AT&T Intellectual Property.
   4   Copyright (c) 2019 Nokia
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 */
  19
  20 package control
  21
  22 import (
  23         "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
  24         "sync"
  25 )
  26
  27 var registryMutex = &sync.Mutex{}
  28
  29 type Registry struct {
  30         register map[uint16]bool
  31         counter  uint16
  32 }
  33
  34 // This method should run as a constructor
  35 func (r *Registry) Initialize(seedsn uint16) {
  36         r.register = make(map[uint16]bool)
  37         r.counter = seedsn
  38 }
  39
  40 // Reserves and returns the next free sequence number
  41 func (r *Registry) ReserveSequenceNumber() (uint16, bool) {
  42         // Check is current SequenceNumber valid
  43         registryMutex.Lock()
  44         defer registryMutex.Unlock()
  45         sequenceNumber := r.counter
  46         if _, ok := r.register[sequenceNumber]; ok {
  47                 xapp.Logger.Error("Invalid SeqenceNumber sequenceNumber: %v",sequenceNumber)
  48                 return sequenceNumber, false
  49         }
  50         r.register[sequenceNumber] = false
  51
  52         // Allocate next SequenceNumber value
  53         if r.counter == 65535 {
  54                 r.counter = 0
  55         } else {
  56                 r.counter++
  57         }
  58         return sequenceNumber, true
  59 }
  60
  61 // This function checks the validity of the given subscription id
  62 func (r *Registry) IsValidSequenceNumber(sn uint16) bool {
  63         registryMutex.Lock()
  64         defer registryMutex.Unlock()
  65         xapp.Logger.Debug("Registry map: %v", r.register)
  66         if _, ok := r.register[sn]; ok {
  67                 return true
  68         }
  69         return false
  70 }
  71
  72 // This function sets the give id as confirmed in the register
  73 func (r *Registry) setSubscriptionToConfirmed(sn uint16) {
  74         registryMutex.Lock()
  75         defer registryMutex.Unlock()
  76         r.register[sn] = true
  77 }
  78
  79 //This function sets the given id as unused in the register
  80 func (r *Registry) deleteSubscription(sn uint16) {
  81         registryMutex.Lock()
  82         defer registryMutex.Unlock()
  83         r.register[sn] = false
  84 }
  85
  86 //This function releases the given id as unused in the register
  87 func (r *Registry) releaseSequenceNumber(sn uint16) bool {
  88         registryMutex.Lock()
  89         defer registryMutex.Unlock()
  90         if r.register[sn] {
  91                 return false
  92                 } else {
  93                 delete(r.register, sn)
  94                 return true
  95         }
  96 }