RICPLT-3014 Subscription multiple endpoints
[ric-plt/submgr.git] / pkg / control / tracker.go
index 584b331..c16a76a 100644 (file)
@@ -25,135 +25,79 @@ import (
        "sync"
 )
 
-type TransactionKey struct {
-       SubID     uint16 // subscription id / sequence number
-       TransType Action // action ongoing (CREATE/DELETE etc)
-}
-
-type TransactionXappKey struct {
-       Addr string // xapp addr
-       Port uint16 // xapp port
-       Xid  string // xapp xid in req
-}
-
-type Transaction struct {
-       tracker           *Tracker           // tracker instance
-       Key               TransactionKey     // action key
-       Xappkey           TransactionXappKey // transaction key
-       OrigParams        *xapp.RMRParams    // request orginal params
-       RespReceived      bool
-       ForwardRespToXapp bool
-}
-
-func (t *Transaction) SubRouteInfo() SubRouteInfo {
-       return SubRouteInfo{t.Key.TransType, t.Xappkey.Addr, t.Xappkey.Port, t.Key.SubID}
-}
-
-/*
-Implements a record of ongoing transactions and helper functions to CRUD the records.
-*/
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
 type Tracker struct {
-       transactionTable     map[TransactionKey]*Transaction
-       transactionXappTable map[TransactionXappKey]*Transaction
        mutex                sync.Mutex
+       transactionXappTable map[TransactionXappKey]*Transaction
+       transSeq             uint64
 }
 
 func (t *Tracker) Init() {
-       t.transactionTable = make(map[TransactionKey]*Transaction)
        t.transactionXappTable = make(map[TransactionXappKey]*Transaction)
 }
 
-/*
-Checks if a tranascation with similar type has been ongoing. If not then creates one.
-Returns error if there is similar transatcion ongoing.
-*/
-func (t *Tracker) TrackTransaction(subID uint16, act Action, addr string, port uint16, params *xapp.RMRParams, respReceived bool, forwardRespToXapp bool) (*Transaction, error) {
-       key := TransactionKey{subID, act}
-       xappkey := TransactionXappKey{addr, port, params.Xid}
-       trans := &Transaction{t, key, xappkey, params, respReceived, forwardRespToXapp}
+func (t *Tracker) NewTransactionFromSkel(transSkel *Transaction) *Transaction {
        t.mutex.Lock()
        defer t.mutex.Unlock()
-       if _, ok := t.transactionTable[key]; ok {
-               // TODO: Implement merge related check here. If the key is same but the value is different.
-               err := fmt.Errorf("transaction tracker: Similar transaction with sub id %d and type %s is ongoing", key.SubID, key.TransType)
-               return nil, err
-       }
-       if _, ok := t.transactionXappTable[xappkey]; ok {
-               // TODO: Implement merge related check here. If the key is same but the value is different.
-               err := fmt.Errorf("transaction tracker: Similar transaction with xapp key %v is ongoing", xappkey)
-               return nil, err
+       trans := transSkel
+       if trans == nil {
+               trans = &Transaction{}
        }
-       t.transactionTable[key] = trans
-       t.transactionXappTable[xappkey] = trans
-       return trans, nil
+       trans.EventChan = make(chan interface{})
+       trans.tracker = t
+       trans.Seq = t.transSeq
+       t.transSeq++
+       xapp.Logger.Debug("Transaction: Create %s", trans.String())
+       return trans
 }
 
-/*
-Retreives the transaction table entry for the given request. Controls that only one response is sent to xapp.
-Returns error in case the transaction cannot be found.
-*/
-func (t *Tracker) RetriveTransaction(subID uint16, act Action) (*Transaction, error) {
-       key := TransactionKey{subID, act}
-       t.mutex.Lock()
-       defer t.mutex.Unlock()
-       if trans, ok := t.transactionTable[key]; ok {
-               return trans, nil
-       }
-       err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
-       return nil, err
+func (t *Tracker) NewTransaction(meid *xapp.RMRMeid) *Transaction {
+       trans := &Transaction{}
+       trans.Meid = meid
+       trans = t.NewTransactionFromSkel(trans)
+       return trans
 }
 
-/*
-Deletes the transaction table entry for the given request and returns the deleted xapp's address and port for reference.
-Returns error in case the transaction cannot be found.
-*/
-func (t *Tracker) completeTransaction(subID uint16, act Action) (*Transaction, error) {
-       key := TransactionKey{subID, act}
-       t.mutex.Lock()
-       defer t.mutex.Unlock()
-       if trans, ok1 := t.transactionTable[key]; ok1 {
-               if _, ok2 := t.transactionXappTable[trans.Xappkey]; ok2 {
-                       delete(t.transactionXappTable, trans.Xappkey)
-               }
-               delete(t.transactionTable, key)
-               return trans, nil
+func (t *Tracker) TrackTransaction(
+       endpoint *RmrEndpoint,
+       xid string,
+       meid *xapp.RMRMeid) (*Transaction, error) {
+
+       if endpoint == nil {
+               err := fmt.Errorf("Tracker: No valid endpoint given")
+               return nil, err
        }
-       err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
-       return nil, err
-}
 
-/*
-Makes possible to to detect has response already received from BTS
-Returns error in case the transaction cannot be found.
-*/
-func (t *Tracker) CheckResponseReceived(subID uint16, act Action) (*Transaction, bool, error) {
-       key := TransactionKey{subID, act}
+       trans := &Transaction{}
+       trans.XappKey = &TransactionXappKey{*endpoint, xid}
+       trans.Meid = meid
+       trans = t.NewTransactionFromSkel(trans)
+
        t.mutex.Lock()
        defer t.mutex.Unlock()
-       if trans, ok := t.transactionTable[key]; ok {
-               if trans.RespReceived == false {
-                       trans.RespReceived = true
-                       // This is used to control that only one response action (success response, failure or timer) is excecuted for the transaction
-                       return trans, false, nil
-               }
-               return trans, true, nil
+
+       if othtrans, ok := t.transactionXappTable[*trans.XappKey]; ok {
+               err := fmt.Errorf("Tracker: %s is ongoing, %s not created ", othtrans, trans)
+               return nil, err
        }
-       err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
-       return nil, false, err
+
+       trans.tracker = t
+       t.transactionXappTable[*trans.XappKey] = trans
+       xapp.Logger.Debug("Tracker: Add %s", trans.String())
+       //xapp.Logger.Debug("Tracker: transtable=%v", t.transactionXappTable)
+       return trans, nil
 }
 
-/*
-Makes possible to receive response to retransmitted request to BTS
-Returns error in case the transaction cannot be found.
-*/
-func (t *Tracker) RetryTransaction(subID uint16, act Action) error {
-       key := TransactionKey{subID, act}
+func (t *Tracker) UnTrackTransaction(xappKey TransactionXappKey) (*Transaction, error) {
        t.mutex.Lock()
        defer t.mutex.Unlock()
-       if trans, ok := t.transactionTable[key]; ok {
-               trans.RespReceived = false
-               return nil
+       if trans, ok2 := t.transactionXappTable[xappKey]; ok2 {
+               xapp.Logger.Debug("Tracker: Delete %s", trans.String())
+               delete(t.transactionXappTable, xappKey)
+               //xapp.Logger.Debug("Tracker: transtable=%v", t.transactionXappTable)
+               return trans, nil
        }
-       err := fmt.Errorf("transaction record for Subscription ID %d and action %s does not exist", subID, act)
-       return err
+       return nil, fmt.Errorf("Tracker: No record %s", xappKey)
 }