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