Format generated Go source code in-process
[govpp.git] / examples / binapi / memif / memif.ba.go
index 4123ad8..2388cc2 100644 (file)
-// Code generated by GoVPP binapi-generator. DO NOT EDIT.
+// Code generated by GoVPP's binapi-generator. DO NOT EDIT.
 // source: /usr/share/vpp/api/plugins/memif.api.json
 
 /*
-Package memif is a generated from VPP binary API module 'memif'.
+Package memif is a generated VPP binary API for 'memif' module.
 
- The memif module consists of:
+It consists of:
+         8 enums
+         2 aliases
         10 messages
          5 services
 */
 package memif
 
-import api "git.fd.io/govpp.git/api"
-import bytes "bytes"
-import context "context"
-import strconv "strconv"
-import struc "github.com/lunixbochs/struc"
+import (
+       "bytes"
+       "context"
+       "io"
+       "strconv"
 
-// Reference imports to suppress errors if they are not otherwise used.
-var _ = api.RegisterMessage
-var _ = bytes.NewBuffer
-var _ = context.Background
-var _ = strconv.Itoa
-var _ = struc.Pack
+       api "git.fd.io/govpp.git/api"
+       struc "github.com/lunixbochs/struc"
 
-// This is a compile-time assertion to ensure that this generated file
-// is compatible with the GoVPP api package it is being compiled against.
-// A compilation error at this line likely means your copy of the
-// GoVPP api package needs to be updated.
-const _ = api.GoVppAPIPackageIsVersion1 // please upgrade the GoVPP api package
+       ethernet_types "git.fd.io/govpp.git/examples/binapi/ethernet_types"
+       interface_types "git.fd.io/govpp.git/examples/binapi/interface_types"
+)
 
 const (
        // ModuleName is the name of this module.
        ModuleName = "memif"
        // APIVersion is the API version of this module.
-       APIVersion = "2.0.0"
+       APIVersion = "3.0.0"
        // VersionCrc is the CRC of this module.
-       VersionCrc = 0x31b42e17
+       VersionCrc = 0x88dc56c9
 )
 
-/* Messages */
+type IfStatusFlags = interface_types.IfStatusFlags
+
+type IfType = interface_types.IfType
+
+type LinkDuplex = interface_types.LinkDuplex
 
-// MemifCreate represents VPP binary API message 'memif_create':
+// MemifMode represents VPP binary API enum 'memif_mode'.
+type MemifMode uint32
+
+const (
+       MEMIF_MODE_API_ETHERNET    MemifMode = 0
+       MEMIF_MODE_API_IP          MemifMode = 1
+       MEMIF_MODE_API_PUNT_INJECT MemifMode = 2
+)
+
+var MemifMode_name = map[uint32]string{
+       0: "MEMIF_MODE_API_ETHERNET",
+       1: "MEMIF_MODE_API_IP",
+       2: "MEMIF_MODE_API_PUNT_INJECT",
+}
+
+var MemifMode_value = map[string]uint32{
+       "MEMIF_MODE_API_ETHERNET":    0,
+       "MEMIF_MODE_API_IP":          1,
+       "MEMIF_MODE_API_PUNT_INJECT": 2,
+}
+
+func (x MemifMode) String() string {
+       s, ok := MemifMode_name[uint32(x)]
+       if ok {
+               return s
+       }
+       return strconv.Itoa(int(x))
+}
+
+// MemifRole represents VPP binary API enum 'memif_role'.
+type MemifRole uint32
+
+const (
+       MEMIF_ROLE_API_MASTER MemifRole = 0
+       MEMIF_ROLE_API_SLAVE  MemifRole = 1
+)
+
+var MemifRole_name = map[uint32]string{
+       0: "MEMIF_ROLE_API_MASTER",
+       1: "MEMIF_ROLE_API_SLAVE",
+}
+
+var MemifRole_value = map[string]uint32{
+       "MEMIF_ROLE_API_MASTER": 0,
+       "MEMIF_ROLE_API_SLAVE":  1,
+}
+
+func (x MemifRole) String() string {
+       s, ok := MemifRole_name[uint32(x)]
+       if ok {
+               return s
+       }
+       return strconv.Itoa(int(x))
+}
+
+type MtuProto = interface_types.MtuProto
+
+type RxMode = interface_types.RxMode
+
+type SubIfFlags = interface_types.SubIfFlags
+
+type InterfaceIndex = interface_types.InterfaceIndex
+
+type MacAddress = ethernet_types.MacAddress
+
+// MemifCreate represents VPP binary API message 'memif_create'.
 type MemifCreate struct {
-       Role       uint8
-       Mode       uint8
+       Role       MemifRole
+       Mode       MemifMode
        RxQueues   uint8
        TxQueues   uint8
        ID         uint32
        SocketID   uint32
-       Secret     []byte `struc:"[24]byte"`
        RingSize   uint32
        BufferSize uint16
-       HwAddr     []byte `struc:"[6]byte"`
+       NoZeroCopy bool
+       HwAddr     MacAddress
+       Secret     string `struc:"[24]byte"`
 }
 
-func (*MemifCreate) GetMessageName() string {
-       return "memif_create"
-}
-func (*MemifCreate) GetCrcString() string {
-       return "6597cdb2"
-}
-func (*MemifCreate) GetMessageType() api.MessageType {
-       return api.RequestMessage
-}
+func (m *MemifCreate) Reset()                        { *m = MemifCreate{} }
+func (*MemifCreate) GetMessageName() string          { return "memif_create" }
+func (*MemifCreate) GetCrcString() string            { return "b1b25061" }
+func (*MemifCreate) GetMessageType() api.MessageType { return api.RequestMessage }
 
-// MemifCreateReply represents VPP binary API message 'memif_create_reply':
+// MemifCreateReply represents VPP binary API message 'memif_create_reply'.
 type MemifCreateReply struct {
        Retval    int32
-       SwIfIndex uint32
+       SwIfIndex InterfaceIndex
 }
 
-func (*MemifCreateReply) GetMessageName() string {
-       return "memif_create_reply"
-}
-func (*MemifCreateReply) GetCrcString() string {
-       return "fda5941f"
-}
-func (*MemifCreateReply) GetMessageType() api.MessageType {
-       return api.ReplyMessage
-}
+func (m *MemifCreateReply) Reset()                        { *m = MemifCreateReply{} }
+func (*MemifCreateReply) GetMessageName() string          { return "memif_create_reply" }
+func (*MemifCreateReply) GetCrcString() string            { return "5383d31f" }
+func (*MemifCreateReply) GetMessageType() api.MessageType { return api.ReplyMessage }
 
-// MemifDelete represents VPP binary API message 'memif_delete':
+// MemifDelete represents VPP binary API message 'memif_delete'.
 type MemifDelete struct {
-       SwIfIndex uint32
+       SwIfIndex InterfaceIndex
 }
 
-func (*MemifDelete) GetMessageName() string {
-       return "memif_delete"
-}
-func (*MemifDelete) GetCrcString() string {
-       return "529cb13f"
-}
-func (*MemifDelete) GetMessageType() api.MessageType {
-       return api.RequestMessage
-}
+func (m *MemifDelete) Reset()                        { *m = MemifDelete{} }
+func (*MemifDelete) GetMessageName() string          { return "memif_delete" }
+func (*MemifDelete) GetCrcString() string            { return "f9e6675e" }
+func (*MemifDelete) GetMessageType() api.MessageType { return api.RequestMessage }
 
-// MemifDeleteReply represents VPP binary API message 'memif_delete_reply':
+// MemifDeleteReply represents VPP binary API message 'memif_delete_reply'.
 type MemifDeleteReply struct {
        Retval int32
 }
 
-func (*MemifDeleteReply) GetMessageName() string {
-       return "memif_delete_reply"
-}
-func (*MemifDeleteReply) GetCrcString() string {
-       return "e8d4e804"
-}
-func (*MemifDeleteReply) GetMessageType() api.MessageType {
-       return api.ReplyMessage
-}
+func (m *MemifDeleteReply) Reset()                        { *m = MemifDeleteReply{} }
+func (*MemifDeleteReply) GetMessageName() string          { return "memif_delete_reply" }
+func (*MemifDeleteReply) GetCrcString() string            { return "e8d4e804" }
+func (*MemifDeleteReply) GetMessageType() api.MessageType { return api.ReplyMessage }
 
-// MemifDetails represents VPP binary API message 'memif_details':
+// MemifDetails represents VPP binary API message 'memif_details'.
 type MemifDetails struct {
-       SwIfIndex   uint32
-       IfName      []byte `struc:"[64]byte"`
-       HwAddr      []byte `struc:"[6]byte"`
-       ID          uint32
-       Role        uint8
-       Mode        uint8
-       SocketID    uint32
-       RingSize    uint32
-       BufferSize  uint16
-       AdminUpDown uint8
-       LinkUpDown  uint8
+       SwIfIndex  InterfaceIndex
+       HwAddr     MacAddress
+       ID         uint32
+       Role       MemifRole
+       Mode       MemifMode
+       ZeroCopy   bool
+       SocketID   uint32
+       RingSize   uint32
+       BufferSize uint16
+       Flags      IfStatusFlags
+       IfName     string `struc:"[64]byte"`
 }
 
-func (*MemifDetails) GetMessageName() string {
-       return "memif_details"
-}
-func (*MemifDetails) GetCrcString() string {
-       return "4f5a3397"
-}
-func (*MemifDetails) GetMessageType() api.MessageType {
-       return api.ReplyMessage
-}
+func (m *MemifDetails) Reset()                        { *m = MemifDetails{} }
+func (*MemifDetails) GetMessageName() string          { return "memif_details" }
+func (*MemifDetails) GetCrcString() string            { return "d0382c4c" }
+func (*MemifDetails) GetMessageType() api.MessageType { return api.ReplyMessage }
 
-// MemifDump represents VPP binary API message 'memif_dump':
+// MemifDump represents VPP binary API message 'memif_dump'.
 type MemifDump struct{}
 
-func (*MemifDump) GetMessageName() string {
-       return "memif_dump"
-}
-func (*MemifDump) GetCrcString() string {
-       return "51077d14"
-}
-func (*MemifDump) GetMessageType() api.MessageType {
-       return api.RequestMessage
-}
+func (m *MemifDump) Reset()                        { *m = MemifDump{} }
+func (*MemifDump) GetMessageName() string          { return "memif_dump" }
+func (*MemifDump) GetCrcString() string            { return "51077d14" }
+func (*MemifDump) GetMessageType() api.MessageType { return api.RequestMessage }
 
-// MemifSocketFilenameAddDel represents VPP binary API message 'memif_socket_filename_add_del':
+// MemifSocketFilenameAddDel represents VPP binary API message 'memif_socket_filename_add_del'.
 type MemifSocketFilenameAddDel struct {
-       IsAdd          uint8
+       IsAdd          bool
        SocketID       uint32
-       SocketFilename []byte `struc:"[128]byte"`
+       SocketFilename string `struc:"[108]byte"`
 }
 
-func (*MemifSocketFilenameAddDel) GetMessageName() string {
-       return "memif_socket_filename_add_del"
-}
-func (*MemifSocketFilenameAddDel) GetCrcString() string {
-       return "30e3929d"
-}
-func (*MemifSocketFilenameAddDel) GetMessageType() api.MessageType {
-       return api.RequestMessage
-}
+func (m *MemifSocketFilenameAddDel) Reset()                        { *m = MemifSocketFilenameAddDel{} }
+func (*MemifSocketFilenameAddDel) GetMessageName() string          { return "memif_socket_filename_add_del" }
+func (*MemifSocketFilenameAddDel) GetCrcString() string            { return "a2ce1a10" }
+func (*MemifSocketFilenameAddDel) GetMessageType() api.MessageType { return api.RequestMessage }
 
-// MemifSocketFilenameAddDelReply represents VPP binary API message 'memif_socket_filename_add_del_reply':
+// MemifSocketFilenameAddDelReply represents VPP binary API message 'memif_socket_filename_add_del_reply'.
 type MemifSocketFilenameAddDelReply struct {
        Retval int32
 }
 
+func (m *MemifSocketFilenameAddDelReply) Reset() { *m = MemifSocketFilenameAddDelReply{} }
 func (*MemifSocketFilenameAddDelReply) GetMessageName() string {
        return "memif_socket_filename_add_del_reply"
 }
-func (*MemifSocketFilenameAddDelReply) GetCrcString() string {
-       return "e8d4e804"
-}
-func (*MemifSocketFilenameAddDelReply) GetMessageType() api.MessageType {
-       return api.ReplyMessage
-}
+func (*MemifSocketFilenameAddDelReply) GetCrcString() string            { return "e8d4e804" }
+func (*MemifSocketFilenameAddDelReply) GetMessageType() api.MessageType { return api.ReplyMessage }
 
-// MemifSocketFilenameDetails represents VPP binary API message 'memif_socket_filename_details':
+// MemifSocketFilenameDetails represents VPP binary API message 'memif_socket_filename_details'.
 type MemifSocketFilenameDetails struct {
        SocketID       uint32
-       SocketFilename []byte `struc:"[128]byte"`
+       SocketFilename string `struc:"[108]byte"`
 }
 
-func (*MemifSocketFilenameDetails) GetMessageName() string {
-       return "memif_socket_filename_details"
-}
-func (*MemifSocketFilenameDetails) GetCrcString() string {
-       return "e347e32f"
-}
-func (*MemifSocketFilenameDetails) GetMessageType() api.MessageType {
-       return api.ReplyMessage
-}
+func (m *MemifSocketFilenameDetails) Reset()                        { *m = MemifSocketFilenameDetails{} }
+func (*MemifSocketFilenameDetails) GetMessageName() string          { return "memif_socket_filename_details" }
+func (*MemifSocketFilenameDetails) GetCrcString() string            { return "7ff326f7" }
+func (*MemifSocketFilenameDetails) GetMessageType() api.MessageType { return api.ReplyMessage }
 
-// MemifSocketFilenameDump represents VPP binary API message 'memif_socket_filename_dump':
+// MemifSocketFilenameDump represents VPP binary API message 'memif_socket_filename_dump'.
 type MemifSocketFilenameDump struct{}
 
-func (*MemifSocketFilenameDump) GetMessageName() string {
-       return "memif_socket_filename_dump"
-}
-func (*MemifSocketFilenameDump) GetCrcString() string {
-       return "51077d14"
-}
-func (*MemifSocketFilenameDump) GetMessageType() api.MessageType {
-       return api.RequestMessage
-}
+func (m *MemifSocketFilenameDump) Reset()                        { *m = MemifSocketFilenameDump{} }
+func (*MemifSocketFilenameDump) GetMessageName() string          { return "memif_socket_filename_dump" }
+func (*MemifSocketFilenameDump) GetCrcString() string            { return "51077d14" }
+func (*MemifSocketFilenameDump) GetMessageType() api.MessageType { return api.RequestMessage }
 
 func init() {
        api.RegisterMessage((*MemifCreate)(nil), "memif.MemifCreate")
@@ -238,58 +256,76 @@ func AllMessages() []api.Message {
        }
 }
 
-// Service represents VPP binary API services in memif module.
-type Service interface {
-       DumpMemif(ctx context.Context, in *MemifDump) ([]*MemifDetails, error)
-       DumpMemifSocketFilename(ctx context.Context, in *MemifSocketFilenameDump) ([]*MemifSocketFilenameDetails, error)
+// RPCService represents RPC service API for memif module.
+type RPCService interface {
+       DumpMemif(ctx context.Context, in *MemifDump) (RPCService_DumpMemifClient, error)
+       DumpMemifSocketFilename(ctx context.Context, in *MemifSocketFilenameDump) (RPCService_DumpMemifSocketFilenameClient, error)
        MemifCreate(ctx context.Context, in *MemifCreate) (*MemifCreateReply, error)
        MemifDelete(ctx context.Context, in *MemifDelete) (*MemifDeleteReply, error)
        MemifSocketFilenameAddDel(ctx context.Context, in *MemifSocketFilenameAddDel) (*MemifSocketFilenameAddDelReply, error)
 }
 
-type service struct {
+type serviceClient struct {
        ch api.Channel
 }
 
-func NewService(ch api.Channel) Service {
-       return &service{ch}
+func NewServiceClient(ch api.Channel) RPCService {
+       return &serviceClient{ch}
+}
+
+func (c *serviceClient) DumpMemif(ctx context.Context, in *MemifDump) (RPCService_DumpMemifClient, error) {
+       stream := c.ch.SendMultiRequest(in)
+       x := &serviceClient_DumpMemifClient{stream}
+       return x, nil
+}
+
+type RPCService_DumpMemifClient interface {
+       Recv() (*MemifDetails, error)
+}
+
+type serviceClient_DumpMemifClient struct {
+       api.MultiRequestCtx
 }
 
-func (c *service) DumpMemif(ctx context.Context, in *MemifDump) ([]*MemifDetails, error) {
-       var dump []*MemifDetails
-       req := c.ch.SendMultiRequest(in)
-       for {
-               m := new(MemifDetails)
-               stop, err := req.ReceiveReply(m)
-               if stop {
-                       break
-               }
-               if err != nil {
-                       return nil, err
-               }
-               dump = append(dump, m)
+func (c *serviceClient_DumpMemifClient) Recv() (*MemifDetails, error) {
+       m := new(MemifDetails)
+       stop, err := c.MultiRequestCtx.ReceiveReply(m)
+       if err != nil {
+               return nil, err
+       }
+       if stop {
+               return nil, io.EOF
        }
-       return dump, nil
+       return m, nil
 }
 
-func (c *service) DumpMemifSocketFilename(ctx context.Context, in *MemifSocketFilenameDump) ([]*MemifSocketFilenameDetails, error) {
-       var dump []*MemifSocketFilenameDetails
-       req := c.ch.SendMultiRequest(in)
-       for {
-               m := new(MemifSocketFilenameDetails)
-               stop, err := req.ReceiveReply(m)
-               if stop {
-                       break
-               }
-               if err != nil {
-                       return nil, err
-               }
-               dump = append(dump, m)
+func (c *serviceClient) DumpMemifSocketFilename(ctx context.Context, in *MemifSocketFilenameDump) (RPCService_DumpMemifSocketFilenameClient, error) {
+       stream := c.ch.SendMultiRequest(in)
+       x := &serviceClient_DumpMemifSocketFilenameClient{stream}
+       return x, nil
+}
+
+type RPCService_DumpMemifSocketFilenameClient interface {
+       Recv() (*MemifSocketFilenameDetails, error)
+}
+
+type serviceClient_DumpMemifSocketFilenameClient struct {
+       api.MultiRequestCtx
+}
+
+func (c *serviceClient_DumpMemifSocketFilenameClient) Recv() (*MemifSocketFilenameDetails, error) {
+       m := new(MemifSocketFilenameDetails)
+       stop, err := c.MultiRequestCtx.ReceiveReply(m)
+       if err != nil {
+               return nil, err
+       }
+       if stop {
+               return nil, io.EOF
        }
-       return dump, nil
+       return m, nil
 }
 
-func (c *service) MemifCreate(ctx context.Context, in *MemifCreate) (*MemifCreateReply, error) {
+func (c *serviceClient) MemifCreate(ctx context.Context, in *MemifCreate) (*MemifCreateReply, error) {
        out := new(MemifCreateReply)
        err := c.ch.SendRequest(in).ReceiveReply(out)
        if err != nil {
@@ -298,7 +334,7 @@ func (c *service) MemifCreate(ctx context.Context, in *MemifCreate) (*MemifCreat
        return out, nil
 }
 
-func (c *service) MemifDelete(ctx context.Context, in *MemifDelete) (*MemifDeleteReply, error) {
+func (c *serviceClient) MemifDelete(ctx context.Context, in *MemifDelete) (*MemifDeleteReply, error) {
        out := new(MemifDeleteReply)
        err := c.ch.SendRequest(in).ReceiveReply(out)
        if err != nil {
@@ -307,7 +343,7 @@ func (c *service) MemifDelete(ctx context.Context, in *MemifDelete) (*MemifDelet
        return out, nil
 }
 
-func (c *service) MemifSocketFilenameAddDel(ctx context.Context, in *MemifSocketFilenameAddDel) (*MemifSocketFilenameAddDelReply, error) {
+func (c *serviceClient) MemifSocketFilenameAddDel(ctx context.Context, in *MemifSocketFilenameAddDel) (*MemifSocketFilenameAddDelReply, error) {
        out := new(MemifSocketFilenameAddDelReply)
        err := c.ch.SendRequest(in).ReceiveReply(out)
        if err != nil {
@@ -315,3 +351,17 @@ func (c *service) MemifSocketFilenameAddDel(ctx context.Context, in *MemifSocket
        }
        return out, nil
 }
+
+// This is a compile-time assertion to ensure that this generated file
+// is compatible with the GoVPP api package it is being compiled against.
+// A compilation error at this line likely means your copy of the
+// GoVPP api package needs to be updated.
+const _ = api.GoVppAPIPackageIsVersion1 // please upgrade the GoVPP api package
+
+// Reference imports to suppress errors if they are not otherwise used.
+var _ = api.RegisterMessage
+var _ = bytes.NewBuffer
+var _ = context.Background
+var _ = io.Copy
+var _ = strconv.Itoa
+var _ = struc.Pack