adapter/vpp_api.go

   1 // Copyright (c) 2017 Cisco and/or its affiliates.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at:
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 package adapter
  16
  17 import (
  18         "errors"
  19 )
  20
  21 const (
  22         // DefaultBinapiSocket defines a default socket file path for VPP binary API.
  23         DefaultBinapiSocket = "/run/vpp/api.sock"
  24 )
  25
  26 var (
  27         // ErrNotImplemented is an error returned when missing implementation.
  28         ErrNotImplemented = errors.New("not implemented for this OS")
  29 )
  30
  31 // MsgCallback defines func signature for message callback.
  32 type MsgCallback func(msgID uint16, data []byte)
  33
  34 // VppAPI provides connection to VPP binary API.
  35 // It is responsible for sending and receiving of binary-encoded messages to/from VPP.
  36 type VppAPI interface {
  37         // Connect connects the process to VPP.
  38         Connect() error
  39
  40         // Disconnect disconnects the process from VPP.
  41         Disconnect() error
  42
  43         // GetMsgID returns a runtime message ID for the given message name and CRC.
  44         GetMsgID(msgName string, msgCrc string) (msgID uint16, err error)
  45
  46         // SendMsg sends a binary-encoded message to VPP.
  47         SendMsg(context uint32, data []byte) error
  48
  49         // SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
  50         SetMsgCallback(cb MsgCallback)
  51
  52         // WaitReady waits until adapter is ready.
  53         WaitReady() error
  54 }