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         SubDelReqMsg      *e2ap.E2APSubscriptionDeleteRequest //SubDelReq TODO: maybe own transactions per type
  54         Payload           []byte                              //packed message to optimize retransmissions
  55         PayloadLen        int                                 //packed message len to optimize  retransmissions
  56         RespReceived      bool
  57         ForwardRespToXapp bool
  58 }
  59
  60 func (t *Transaction) String() string {
  61         t.mutex.Lock()
  62         defer t.mutex.Unlock()
  63         var subId string = "?"
  64         if t.Subs != nil {
  65                 subId = strconv.FormatUint(uint64(t.Subs.Seq), 10)
  66         }
  67         return subId + "/" + t.RmrEndpoint.String() + "/" + t.Xid
  68 }
  69
  70 func (t *Transaction) GetXid() string {
  71         t.mutex.Lock()
  72         defer t.mutex.Unlock()
  73         return t.Xid
  74 }
  75
  76 func (t *Transaction) GetMtype() int {
  77         t.mutex.Lock()
  78         defer t.mutex.Unlock()
  79         return t.Mtype
  80 }
  81
  82 func (t *Transaction) GetMeid() *xapp.RMRMeid {
  83         t.mutex.Lock()
  84         defer t.mutex.Unlock()
  85         if t.Meid != nil {
  86                 return t.Meid
  87         }
  88         return nil
  89 }
  90
  91 func (t *Transaction) GetSrc() string {
  92         t.mutex.Lock()
  93         defer t.mutex.Unlock()
  94         return t.RmrEndpoint.String()
  95 }
  96
  97 func (t *Transaction) CheckResponseReceived() bool {
  98         t.mutex.Lock()
  99         defer t.mutex.Unlock()
 100         if t.RespReceived == false {
 101                 t.RespReceived = true
 102                 return false
 103         }
 104         return true
 105 }
 106
 107 func (t *Transaction) RetryTransaction() {
 108         t.mutex.Lock()
 109         defer t.mutex.Unlock()
 110         t.RespReceived = false
 111 }
 112
 113 func (t *Transaction) Release() {
 114         t.mutex.Lock()
 115         defer t.mutex.Unlock()
 116         if t.Subs != nil {
 117                 t.Subs.UnSetTransaction(t)
 118         }
 119         if t.tracker != nil {
 120                 xappkey := TransactionXappKey{t.RmrEndpoint, t.Xid}
 121                 t.tracker.UnTrackTransaction(xappkey)
 122         }
 123         t.Subs = nil
 124         t.tracker = nil
 125 }