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:     Containes SBI (SouthBound Interface) specific types
  22   Date:         16 March 2019
  23 */
  24
  25 package sbi
  26
  27 import "rtmgr"
  28
  29 type distributeAll func(*[]string) error
  30 type openSocket func(string) error
  31 type closeSocket func() error
  32 type createEndpointSocket func(*rtmgr.Endpoint) error
  33 type destroyEndpointSocket func(*rtmgr.Endpoint) error
  34
  35
  36 type SbiEngine struct {
  37         Name     string
  38         Version  string
  39         Protocol string
  40 }
  41
  42 type SbiEngineConfig struct {
  43         Engine        SbiEngine
  44         OpenSocket    openSocket
  45         CloseSocket   closeSocket
  46         CreateEndpointSocket createEndpointSocket
  47         DestroyEndpointSocket destroyEndpointSocket
  48         DistributeAll distributeAll
  49         IsAvailable   bool
  50 }