pkg/sbi/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:     sbi/types.go
  21   Abstract:     Contains SBI (SouthBound Interface) specific types
  22   Date:         16 March 2019
  23 */
  24
  25 package sbi
  26
  27 import "routing-manager/pkg/rtmgr"
  28
  29 type EngineConfig struct {
  30         Name        string
  31         Version     string
  32         Protocol    string
  33         Instance    Engine
  34         IsAvailable bool
  35 }
  36
  37 type Engine interface {
  38         Initialize(string) error
  39         Terminate() error
  40         DistributeAll(*[]string) error
  41         AddEndpoint(*rtmgr.Endpoint) error
  42         DeleteEndpoint(*rtmgr.Endpoint) error
  43         UpdateEndpoints(*rtmgr.RicComponents)
  44 }
  45
  46 type NngSocket interface {
  47         Listen(string) error
  48         Send([]byte) error
  49         Close() error
  50         DialOptions(string, map[string]interface{}) error
  51 }
  52
  53 type CreateNewNngSocketHandler func() (NngSocket, error)