tools/xapp_mock/rmr/rmrCgoTypes.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
  18 package rmr
  19
  20 // #cgo LDFLAGS: -L/usr/local/lib -lrmr_nng -lnng
  21 // #include <rmr/rmr.h>
  22 // #include <stdlib.h>
  23 import "C"
  24 import (
  25         "fmt"
  26         "unsafe"
  27 )
  28
  29 func NewMBuf(mType int, len int, payload []byte, xAction []byte) *MBuf {
  30         return &MBuf{
  31                 MType:   mType,
  32                 Len:     len,
  33                 Payload: payload,
  34                 XAction: xAction,
  35         }
  36 }
  37
  38 func NewContext(maxMsgSize int, maxRetries, flags int, ctx unsafe.Pointer) *Context {
  39         return &Context{
  40                 MaxMsgSize: maxMsgSize,
  41                 MaxRetries: maxRetries,
  42                 Flags:      flags,
  43                 RmrCtx:     ctx,
  44         }
  45 }
  46
  47 const (
  48         RMR_MAX_XACTION_LEN = int(C.RMR_MAX_XID)
  49         RMR_MAX_MSG_SIZE    = int(C.RMR_MAX_RCV_BYTES)
  50         RMR_MAX_MEID_LEN    = int(C.RMR_MAX_MEID)
  51
  52         //states
  53         RMR_OK             = C.RMR_OK
  54         RMR_ERR_BADARG     = C.RMR_ERR_BADARG
  55         RMR_ERR_NOENDPT    = C.RMR_ERR_NOENDPT
  56         RMR_ERR_EMPTY      = C.RMR_ERR_EMPTY
  57         RMR_ERR_NOHDR      = C.RMR_ERR_NOHDR
  58         RMR_ERR_SENDFAILED = C.RMR_ERR_SENDFAILED
  59         RMR_ERR_CALLFAILED = C.RMR_ERR_CALLFAILED
  60         RMR_ERR_NOWHOPEN   = C.RMR_ERR_NOWHOPEN
  61         RMR_ERR_WHID       = C.RMR_ERR_WHID
  62         RMR_ERR_OVERFLOW   = C.RMR_ERR_OVERFLOW
  63         RMR_ERR_RETRY      = C.RMR_ERR_RETRY
  64         RMR_ERR_RCVFAILED  = C.RMR_ERR_RCVFAILED
  65         RMR_ERR_TIMEOUT    = C.RMR_ERR_TIMEOUT
  66         RMR_ERR_UNSET      = C.RMR_ERR_UNSET
  67         RMR_ERR_TRUNC      = C.RMR_ERR_TRUNC
  68         RMR_ERR_INITFAILED = C.RMR_ERR_INITFAILED
  69 )
  70
  71 var states = map[int]string{
  72         RMR_OK:             "state is good",
  73         RMR_ERR_BADARG:     "argument passd to function was unusable",
  74         RMR_ERR_NOENDPT:    "send/call could not find an endpoint based on msg type",
  75         RMR_ERR_EMPTY:      "msg received had no payload; attempt to send an empty message",
  76         RMR_ERR_NOHDR:      "message didn't contain a valid header",
  77         RMR_ERR_SENDFAILED: "send failed; errno has nano reason",
  78         RMR_ERR_CALLFAILED: "unable to send call() message",
  79         RMR_ERR_NOWHOPEN:   "no wormholes are open",
  80         RMR_ERR_WHID:       "wormhole id was invalid",
  81         RMR_ERR_OVERFLOW:   "operation would have busted through a buffer/field size",
  82         RMR_ERR_RETRY:      "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
  83         RMR_ERR_RCVFAILED:  "receive failed (hard error)",
  84         RMR_ERR_TIMEOUT:    "message processing call timed out",
  85         RMR_ERR_UNSET:      "the message hasn't been populated with a transport buffer",
  86         RMR_ERR_TRUNC:      "received message likely truncated",
  87         RMR_ERR_INITFAILED: "initialisation of something (probably message) failed",
  88 }
  89
  90 type MBuf struct {
  91         MType   int
  92         Len     int
  93         Meid    string //Managed entity id (RAN name)*/
  94         Payload []byte
  95         XAction []byte
  96 }
  97
  98
  99 func (m MBuf) String() string {
 100         return fmt.Sprintf("{ MType: %d, Len: %d, Meid: %q, Xaction: %q, Payload: [%x] }", m.MType, m.Len, m.Meid, m.XAction, m.Payload)
 101 }
 102
 103
 104 type Context struct {
 105         MaxMsgSize     int
 106         MaxRetries     int
 107         Flags          int
 108         RmrCtx         unsafe.Pointer
 109 }
 110
 111 type Messenger interface {
 112         Init(port string, maxMsgSize int, maxRetries int, flags int) *Messenger
 113         SendMsg(msg *MBuf) (*MBuf, error)
 114         RecvMsg() (*MBuf, error)
 115         IsReady() bool
 116         Close()
 117 }
 118 type Config struct {
 119         Port       int
 120         MaxMsgSize int
 121         MaxRetries int
 122         Flags      int
 123 }