Merge "Configure Repo for Documentation"
[ric-plt/e2mgr.git] / E2Manager / rmrCgo / rmrCgoApi.go
1 //
2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //      http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16
17 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 //  platform project (RICP).
19
20
21 package rmrCgo
22
23 // #cgo LDFLAGS: -L/usr/local/lib -lrmr_nng -lnng
24 // #include <rmr/rmr.h>
25 // #include <stdlib.h>
26 import "C"
27 import (
28         "fmt"
29         "github.com/pkg/errors"
30         "strings"
31         "time"
32         "unsafe"
33
34         "e2mgr/logger"
35 )
36
37 func (*Context) Init(port string, maxMsgSize int, flags int, logger *logger.Logger) *RmrMessenger {//TODO remove pointer from interface
38         pp := C.CString(port)
39         defer C.free(unsafe.Pointer(pp))
40         logger.Debugf("#rmrCgoApi.Init - Going to initiate RMR router")
41         ctx := NewContext(maxMsgSize, flags, C.rmr_init(pp, C.int(maxMsgSize), C.int(flags)), logger)
42         start := time.Now()
43         //TODO use time.Ticker()
44         for !ctx.IsReady() {
45                 time.Sleep(time.Second)
46                 if time.Since(start) >= time.Minute {
47                         logger.Debugf("#rmrCgoApi.Init - Routing table is not ready")
48                         start = time.Now()
49                 }
50         }
51         logger.Infof("#rmrCgoApi.Init - RMR router has been initiated")
52
53         // Configure the rmr to make rounds of attempts to send a message before notifying the application that it should retry.
54         // Each round is about 1000 attempts with a short sleep between each round.
55         C.rmr_set_stimeout(ctx.RmrCtx, C.int(1000))
56         r := RmrMessenger(ctx)
57         return &r
58 }
59
60 func (ctx *Context) SendMsg(msg *MBuf) (*MBuf, error) {
61         ctx.checkContextInitialized()
62         ctx.Logger.Debugf("#rmrCgoApi.SendMsg - Going to send message. MBuf: %v", *msg)
63         allocatedCMBuf := ctx.getAllocatedCRmrMBuf(ctx.Logger, msg, ctx.MaxMsgSize)
64         defer C.rmr_free_msg(allocatedCMBuf)
65         state := allocatedCMBuf.state
66         if state != RMR_OK {
67                 errorMessage := fmt.Sprintf("#rmrCgoApi.SendMsg - Failed to get allocated message. state: %v - %s", state, states[int(state)])
68                 return nil, errors.New(errorMessage)
69         }
70
71         //TODO: if debug enabled
72         transactionId := string(*msg.XAction)
73         tmpTid := strings.TrimSpace(transactionId)
74         ctx.Logger.Infof("[E2 Manager -> RMR] #rmrCgoApi.SendMsg - Going to send message %v for transaction id: %s", *msg, tmpTid)
75
76         currCMBuf := C.rmr_send_msg(ctx.RmrCtx, allocatedCMBuf)
77         state = currCMBuf.state
78         ctx.Logger.Debugf("#rmrCgoApi.SendMsg - The current message  state: %v, message buffer:%v", state, currCMBuf)
79
80         if state != RMR_OK {
81                 errorMessage := fmt.Sprintf("#rmrCgoApi.SendMsg - Failed to send message. state: %v - %s", state, states[int(state)])
82                 return nil, errors.New(errorMessage)
83         }
84
85         ctx.Logger.Debugf("#rmrCgoApi.SendMsg - The message has been sent successfully ")
86         return convertToMBuf(ctx.Logger, currCMBuf), nil
87 }
88
89 func (ctx *Context) RecvMsg() (*MBuf, error) {
90         ctx.checkContextInitialized()
91         ctx.Logger.Debugf("#rmrCgoApi.RecvMsg - Going to receive message")
92         allocatedCMBuf := C.rmr_alloc_msg(ctx.RmrCtx, C.int(ctx.MaxMsgSize))
93         defer C.rmr_free_msg(allocatedCMBuf)
94
95         currCMBuf := C.rmr_rcv_msg(ctx.RmrCtx, allocatedCMBuf)
96         state := currCMBuf.state
97
98         if state != RMR_OK {
99                 errorMessage := fmt.Sprintf("#rmrCgoApi.RecvMsg - Failed to receive message. state: %v - %s", state, states[int(state)])
100                 ctx.Logger.Errorf(errorMessage)
101                 return nil, errors.New(errorMessage)
102         }
103
104         mbuf := convertToMBuf(ctx.Logger, currCMBuf)
105         transactionId := string(*mbuf.XAction)
106         tmpTid := strings.TrimSpace(transactionId)
107         ctx.Logger.Infof("[RMR -> E2 Manager] #rmrCgoApi.RecvMsg - message %v has been received for transaction id: %s", *mbuf, tmpTid)
108         return mbuf, nil
109 }
110
111 func (ctx *Context) RtsMsg(msg *MBuf) {
112         ctx.checkContextInitialized()
113         ctx.Logger.Debugf("#rmrCgoApi.RtsMsg - Going to return message to the sender")
114         allocatedCMBuf := C.rmr_alloc_msg(ctx.RmrCtx, C.int(ctx.MaxMsgSize))
115         defer C.rmr_free_msg(allocatedCMBuf)
116         C.rmr_rts_msg(ctx.RmrCtx, allocatedCMBuf)
117 }
118
119 func (ctx *Context) IsReady() bool {
120         ctx.Logger.Debugf("#rmrCgoApi.IsReady - Going to check if routing table is initialized")
121         return int(C.rmr_ready(ctx.RmrCtx)) != 0
122 }
123
124 func (ctx *Context) Close() {
125         ctx.Logger.Debugf("#rmrCgoApi.Close - Going to close RMR context")
126         C.rmr_close(ctx.RmrCtx)
127         time.Sleep(100 * time.Millisecond)
128 }