pkg/rpe/types.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    This source code is part of the near-RT RIC (RAN Intelligent Controller)
  20    platform project (RICP).
  21
  22 ==================================================================================
  23 */
  24 /*
  25   Mnemonic:     rpe/types.go
  26   Abstract:     Contains RPE (Route Policy Engine) specific types
  27   Date:         12 March 2019
  28 */
  29
  30 package rpe
  31
  32 import (
  33         "routing-manager/pkg/models"
  34         "routing-manager/pkg/rtmgr"
  35 )
  36
  37 //type generatePolicies func(rtmgr.Endpoints) *[]string
  38 //type generateRouteTable func(rtmgr.Endpoints) *rtmgr.RouteTable
  39
  40 type EngineConfig struct {
  41         Name        string
  42         Version     string
  43         Protocol    string
  44         Instance    Engine
  45         IsAvailable bool
  46 }
  47
  48 type Engine interface {
  49         GeneratePolicies(rtmgr.Endpoints, *rtmgr.RicComponents) *[]string
  50         GenerateRouteTable(rtmgr.Endpoints) *rtmgr.RouteTable
  51         GeneratePartialPolicies(eps rtmgr.Endpoints, xappSubData *models.XappSubscriptionData, updatetype rtmgr.RMRUpdateType) *[]string
  52 }
  53
  54 type RouteIndex struct {
  55         flag  bool
  56         index uint16
  57 }