pkg/nbi/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:     nbi.go
  26   Abstract:     Contains NBI (NorthBound Interface) specific types
  27   Date:         12 March 2019
  28 */
  29
  30 package nbi
  31
  32 import (
  33         "routing-manager/pkg/models"
  34         "routing-manager/pkg/rpe"
  35         "routing-manager/pkg/rtmgr"
  36         "routing-manager/pkg/sdl"
  37 )
  38
  39 type FetchAllXAppsHandler func(string) (*[]rtmgr.XApp, error)
  40 type RecvXappCallbackDataHandler func(<-chan *models.XappCallbackData) (*[]rtmgr.XApp, error)
  41 type LaunchRestHandler func(*string, chan<- *models.XappCallbackData, chan<- *models.XappSubscriptionData, chan<- *models.XappSubscriptionData)
  42 type ProvideXappHandleHandlerImpl func(chan<- *models.XappCallbackData, *models.XappCallbackData) error
  43 type RetrieveStartupDataHandler func(string, string, string, string, sdl.Engine) error
  44
  45 type EngineConfig struct {
  46         Name        string
  47         Version     string
  48         Protocol    string
  49         Instance    Engine
  50         IsAvailable bool
  51 }
  52
  53 type Engine interface {
  54         Initialize(string, string, string, string, sdl.Engine, rpe.Engine, chan<- bool) error
  55         Terminate() error
  56 }