pkg/control/tracker.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         "fmt"
  24         "sync"
  25 )
  26
  27 /*
  28 Implements a record of ongoing transactions and helper functions to CRUD the records.
  29 */
  30 type Tracker struct {
  31         transactionTable map[TransactionKey]Transaction
  32         mutex sync.Mutex
  33 }
  34
  35 func (t *Tracker) Init() {
  36         t.transactionTable = make(map[TransactionKey]Transaction)
  37 }
  38
  39 /*
  40 Checks if a tranascation with similar type has been ongoing. If not then creates one.
  41 Returns error if there is similar transatcion ongoing.
  42 */
  43 func (t *Tracker) TrackTransaction(key TransactionKey, xact Transaction) error {
  44         t.mutex.Lock()
  45         defer t.mutex.Unlock()
  46         if _, ok := t.transactionTable[key]; ok {
  47                 // TODO: Implement merge related check here. If the key is same but the value is different.
  48                 err := fmt.Errorf("transaction tracker: Similar transaction with sub id %d and type %s is ongoing", key.SubID, key.transType)
  49                 return err
  50         }
  51         t.transactionTable[key] = xact
  52         return nil
  53 }
  54
  55 /*
  56 Retreives the transaction table entry for the given request.
  57 Returns error in case the transaction cannot be found.
  58 */
  59 func (t *Tracker) UpdateTransaction(SubID uint16, transType Action, xact Transaction) error {
  60         key := TransactionKey{SubID, transType}
  61         t.mutex.Lock()
  62         defer t.mutex.Unlock()
  63         if _, ok := t.transactionTable[key]; ok {
  64                 // TODO: Implement merge related check here. If the key is same but the value is different.
  65                 err := fmt.Errorf("transaction tracker: Similar transaction with sub id %d and type %v is ongoing", key.SubID, key.transType)
  66                 return err
  67         }
  68         t.transactionTable[key] = xact
  69         return nil
  70 }
  71
  72 /*
  73 Retreives the transaction table entry for the given request.
  74 Returns error in case the transaction cannot be found.
  75 */
  76 func (t *Tracker) RetriveTransaction(subID uint16, act Action) (Transaction, error) {
  77         key := TransactionKey{subID, act}
  78         t.mutex.Lock()
  79         defer t.mutex.Unlock()
  80         var xact Transaction
  81         if xact, ok := t.transactionTable[key]; ok {
  82                 return xact, nil
  83         }
  84         err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
  85         return xact, err
  86 }
  87
  88 /*
  89 Deletes the transaction table entry for the given request and returns the deleted xapp's address and port for reference.
  90 Returns error in case the transaction cannot be found.
  91 */
  92 func (t *Tracker) completeTransaction(subID uint16, act Action) (Transaction, error) {
  93         key := TransactionKey{subID, act}
  94         var emptyTransaction Transaction
  95         t.mutex.Lock()
  96         defer t.mutex.Unlock()
  97         if xact, ok := t.transactionTable[key]; ok {
  98                 delete(t.transactionTable, key)
  99                 return xact, nil
 100         }
 101         err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
 102         return emptyTransaction, err
 103 }