pkg/control/transaction.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/e2ap/pkg/e2ap"
  24         "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
  25         "strconv"
  26         "sync"
  27 )
  28
  29 //-----------------------------------------------------------------------------
  30 //
  31 //-----------------------------------------------------------------------------
  32 type TransactionXappKey struct {
  33         RmrEndpoint
  34         Xid string // xapp xid in req
  35 }
  36
  37 func (key *TransactionXappKey) String() string {
  38         return key.RmrEndpoint.String() + "/" + key.Xid
  39 }
  40
  41 //-----------------------------------------------------------------------------
  42 //
  43 //-----------------------------------------------------------------------------
  44 type Transaction struct {
  45         mutex             sync.Mutex
  46         tracker           *Tracker                            //tracker instance
  47         Subs              *Subscription                       //related subscription
  48         RmrEndpoint       RmrEndpoint                         //xapp endpoint
  49         Mtype             int                                 //type of initiating message
  50         Xid               string                              //xapp xid in req
  51         Meid              *xapp.RMRMeid                       //meid transaction related
  52         SubReqMsg         *e2ap.E2APSubscriptionRequest       //SubReq TODO: maybe own transactions per type
  53         SubRespMsg        *e2ap.E2APSubscriptionResponse      //SubResp TODO: maybe own transactions per type
  54         SubFailMsg        *e2ap.E2APSubscriptionFailure       //SubFail TODO: maybe own transactions per type
  55         SubDelReqMsg      *e2ap.E2APSubscriptionDeleteRequest //SubDelReq TODO: maybe own transactions per type
  56         Payload           []byte                              //packed message to optimize retransmissions
  57         PayloadLen        int                                 //packed message len to optimize  retransmissions
  58         RespReceived      bool
  59         ForwardRespToXapp bool
  60 }
  61
  62 func (t *Transaction) String() string {
  63         t.mutex.Lock()
  64         defer t.mutex.Unlock()
  65         var subId string = "?"
  66         if t.Subs != nil {
  67                 subId = strconv.FormatUint(uint64(t.Subs.Seq), 10)
  68         }
  69         return subId + "/" + t.RmrEndpoint.String() + "/" + t.Xid
  70 }
  71
  72 func (t *Transaction) GetXid() string {
  73         t.mutex.Lock()
  74         defer t.mutex.Unlock()
  75         return t.Xid
  76 }
  77
  78 func (t *Transaction) GetMtype() int {
  79         t.mutex.Lock()
  80         defer t.mutex.Unlock()
  81         return t.Mtype
  82 }
  83
  84 func (t *Transaction) GetMeid() *xapp.RMRMeid {
  85         t.mutex.Lock()
  86         defer t.mutex.Unlock()
  87         if t.Meid != nil {
  88                 return t.Meid
  89         }
  90         return nil
  91 }
  92
  93 func (t *Transaction) GetSrc() string {
  94         t.mutex.Lock()
  95         defer t.mutex.Unlock()
  96         return t.RmrEndpoint.String()
  97 }
  98
  99 func (t *Transaction) CheckResponseReceived() bool {
 100         t.mutex.Lock()
 101         defer t.mutex.Unlock()
 102         if t.RespReceived == false {
 103                 t.RespReceived = true
 104                 return false
 105         }
 106         return true
 107 }
 108
 109 func (t *Transaction) RetryTransaction() {
 110         t.mutex.Lock()
 111         defer t.mutex.Unlock()
 112         t.RespReceived = false
 113 }
 114
 115 func (t *Transaction) Release() {
 116         xapp.Logger.Info("Transaction: Releasing %s", t)
 117         t.mutex.Lock()
 118         defer t.mutex.Unlock()
 119         if t.Subs != nil {
 120                 t.Subs.UnSetTransaction(t)
 121         }
 122         if t.tracker != nil {
 123                 xappkey := TransactionXappKey{t.RmrEndpoint, t.Xid}
 124                 t.tracker.UnTrackTransaction(xappkey)
 125         }
 126         t.Subs = nil
 127         t.tracker = nil
 128 }