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 "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
  23
  24 type Registry struct {
  25         register map[uint16]bool
  26         counter  uint16
  27 }
  28
  29 // This method should run as a constructor
  30 func (r *Registry) Initialize(seedsn uint16) {
  31         r.register = make(map[uint16]bool)
  32         r.counter = seedsn
  33 }
  34
  35 // Reserves and returns the next free sequence number
  36 func (r *Registry) ReserveSequenceNumber() uint16 {
  37         if r.IsValidSequenceNumber(r.counter) { }
  38         sequenceNumber := r.counter
  39         r.register[sequenceNumber] = false
  40         r.shift()
  41         return sequenceNumber
  42 }
  43
  44 // This function checks the validity of the given subscription id
  45 func (r *Registry) IsValidSequenceNumber(sn uint16) bool {
  46         xapp.Logger.Debug("Registry map: %v", r.register)
  47         if _, ok := r.register[sn]; ok {
  48                 return true
  49         }
  50         return false
  51 }
  52
  53 // This function sets the give id as confirmed in the register
  54 func (r *Registry) setSubscriptionToConfirmed(sn uint16) {
  55         r.register[sn] = true
  56 }
  57
  58 func (r *Registry) shift() {
  59         if r.counter == 65535 {
  60                 r.counter = 0
  61         } else {
  62                 r.counter++
  63         }
  64 }
  65
  66 //This function sets the given id as unused in the register
  67 func (r *Registry) deleteSubscription(sn uint16) {
  68         r.register[sn] = false
  69 }
  70
  71 //This function releases the given id as unused in the register
  72 func (r *Registry) releaseSequenceNumber(sn uint16) bool {
  73         if r.register[sn] {
  74                 return false
  75         } else {
  76                 delete(r.register, sn)
  77                 return true
  78         }
  79 }