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 /*
  20   Mnemonic:     nbi.go
  21   Abstract:     Contains NBI (NorthBound Interface) specific types
  22   Date:         12 March 2019
  23 */
  24
  25 package nbi
  26
  27 import (
  28         "routing-manager/pkg/models"
  29         "routing-manager/pkg/rpe"
  30         "routing-manager/pkg/rtmgr"
  31         "routing-manager/pkg/sdl"
  32 )
  33
  34 type FetchAllXAppsHandler func(string) (*[]rtmgr.XApp, error)
  35 type RecvXappCallbackDataHandler func(<-chan *models.XappCallbackData) (*[]rtmgr.XApp, error)
  36 type LaunchRestHandler func(*string, chan<- *models.XappCallbackData, chan<- *models.XappSubscriptionData, chan<- *models.XappSubscriptionData)
  37 type ProvideXappHandleHandlerImpl func(chan<- *models.XappCallbackData, *models.XappCallbackData) error
  38 type RetrieveStartupDataHandler func(string, string, string, string, sdl.Engine) error
  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         Initialize(string, string, string, string, sdl.Engine, rpe.Engine, chan<- bool) error
  50         Terminate() error
  51 }