examples/binapi/memclnt/memclnt.ba.go

   1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
   2 // source: /usr/share/vpp/api/core/memclnt.api.json
   3
   4 /*
   5 Package memclnt is a generated VPP binary API for 'memclnt' module.
   6
   7 It consists of:
   8           2 types
   9          22 messages
  10          13 services
  11 */
  12 package memclnt
  13
  14 import (
  15         bytes "bytes"
  16         context "context"
  17         api "git.fd.io/govpp.git/api"
  18         struc "github.com/lunixbochs/struc"
  19         io "io"
  20         strconv "strconv"
  21 )
  22
  23 const (
  24         // ModuleName is the name of this module.
  25         ModuleName = "memclnt"
  26         // APIVersion is the API version of this module.
  27         APIVersion = "2.1.0"
  28         // VersionCrc is the CRC of this module.
  29         VersionCrc = 0xb619530
  30 )
  31
  32 // MessageTableEntry represents VPP binary API type 'message_table_entry'.
  33 type MessageTableEntry struct {
  34         Index uint16
  35         Name  []byte `struc:"[64]byte"`
  36 }
  37
  38 func (*MessageTableEntry) GetTypeName() string {
  39         return "message_table_entry"
  40 }
  41 func (*MessageTableEntry) GetCrcString() string {
  42         return "913bf1c6"
  43 }
  44
  45 // ModuleVersion represents VPP binary API type 'module_version'.
  46 type ModuleVersion struct {
  47         Major uint32
  48         Minor uint32
  49         Patch uint32
  50         Name  []byte `struc:"[64]byte"`
  51 }
  52
  53 func (*ModuleVersion) GetTypeName() string {
  54         return "module_version"
  55 }
  56 func (*ModuleVersion) GetCrcString() string {
  57         return "4b6da11a"
  58 }
  59
  60 // APIVersions represents VPP binary API message 'api_versions'.
  61 type APIVersions struct{}
  62
  63 func (*APIVersions) GetMessageName() string {
  64         return "api_versions"
  65 }
  66 func (*APIVersions) GetCrcString() string {
  67         return "51077d14"
  68 }
  69 func (*APIVersions) GetMessageType() api.MessageType {
  70         return api.RequestMessage
  71 }
  72
  73 // APIVersionsReply represents VPP binary API message 'api_versions_reply'.
  74 type APIVersionsReply struct {
  75         Retval      int32
  76         Count       uint32 `struc:"sizeof=APIVersions"`
  77         APIVersions []ModuleVersion
  78 }
  79
  80 func (*APIVersionsReply) GetMessageName() string {
  81         return "api_versions_reply"
  82 }
  83 func (*APIVersionsReply) GetCrcString() string {
  84         return "90a39195"
  85 }
  86 func (*APIVersionsReply) GetMessageType() api.MessageType {
  87         return api.ReplyMessage
  88 }
  89
  90 // GetFirstMsgID represents VPP binary API message 'get_first_msg_id'.
  91 type GetFirstMsgID struct {
  92         Name []byte `struc:"[64]byte"`
  93 }
  94
  95 func (*GetFirstMsgID) GetMessageName() string {
  96         return "get_first_msg_id"
  97 }
  98 func (*GetFirstMsgID) GetCrcString() string {
  99         return "0cb71b0e"
 100 }
 101 func (*GetFirstMsgID) GetMessageType() api.MessageType {
 102         return api.RequestMessage
 103 }
 104
 105 // GetFirstMsgIDReply represents VPP binary API message 'get_first_msg_id_reply'.
 106 type GetFirstMsgIDReply struct {
 107         Retval     int32
 108         FirstMsgID uint16
 109 }
 110
 111 func (*GetFirstMsgIDReply) GetMessageName() string {
 112         return "get_first_msg_id_reply"
 113 }
 114 func (*GetFirstMsgIDReply) GetCrcString() string {
 115         return "7d337472"
 116 }
 117 func (*GetFirstMsgIDReply) GetMessageType() api.MessageType {
 118         return api.ReplyMessage
 119 }
 120
 121 // MemclntCreate represents VPP binary API message 'memclnt_create'.
 122 type MemclntCreate struct {
 123         CtxQuota    int32
 124         InputQueue  uint64
 125         Name        []byte   `struc:"[64]byte"`
 126         APIVersions []uint32 `struc:"[8]uint32"`
 127 }
 128
 129 func (*MemclntCreate) GetMessageName() string {
 130         return "memclnt_create"
 131 }
 132 func (*MemclntCreate) GetCrcString() string {
 133         return "6d33c5ea"
 134 }
 135 func (*MemclntCreate) GetMessageType() api.MessageType {
 136         return api.ReplyMessage
 137 }
 138
 139 // MemclntCreateReply represents VPP binary API message 'memclnt_create_reply'.
 140 type MemclntCreateReply struct {
 141         Response     int32
 142         Handle       uint64
 143         Index        uint32
 144         MessageTable uint64
 145 }
 146
 147 func (*MemclntCreateReply) GetMessageName() string {
 148         return "memclnt_create_reply"
 149 }
 150 func (*MemclntCreateReply) GetCrcString() string {
 151         return "42ec4560"
 152 }
 153 func (*MemclntCreateReply) GetMessageType() api.MessageType {
 154         return api.ReplyMessage
 155 }
 156
 157 // MemclntDelete represents VPP binary API message 'memclnt_delete'.
 158 type MemclntDelete struct {
 159         Index     uint32
 160         Handle    uint64
 161         DoCleanup uint8
 162 }
 163
 164 func (*MemclntDelete) GetMessageName() string {
 165         return "memclnt_delete"
 166 }
 167 func (*MemclntDelete) GetCrcString() string {
 168         return "4dd351e9"
 169 }
 170 func (*MemclntDelete) GetMessageType() api.MessageType {
 171         return api.OtherMessage
 172 }
 173
 174 // MemclntDeleteReply represents VPP binary API message 'memclnt_delete_reply'.
 175 type MemclntDeleteReply struct {
 176         Response int32
 177         Handle   uint64
 178 }
 179
 180 func (*MemclntDeleteReply) GetMessageName() string {
 181         return "memclnt_delete_reply"
 182 }
 183 func (*MemclntDeleteReply) GetCrcString() string {
 184         return "3d3b6312"
 185 }
 186 func (*MemclntDeleteReply) GetMessageType() api.MessageType {
 187         return api.OtherMessage
 188 }
 189
 190 // MemclntKeepalive represents VPP binary API message 'memclnt_keepalive'.
 191 type MemclntKeepalive struct{}
 192
 193 func (*MemclntKeepalive) GetMessageName() string {
 194         return "memclnt_keepalive"
 195 }
 196 func (*MemclntKeepalive) GetCrcString() string {
 197         return "51077d14"
 198 }
 199 func (*MemclntKeepalive) GetMessageType() api.MessageType {
 200         return api.RequestMessage
 201 }
 202
 203 // MemclntKeepaliveReply represents VPP binary API message 'memclnt_keepalive_reply'.
 204 type MemclntKeepaliveReply struct {
 205         Retval int32
 206 }
 207
 208 func (*MemclntKeepaliveReply) GetMessageName() string {
 209         return "memclnt_keepalive_reply"
 210 }
 211 func (*MemclntKeepaliveReply) GetCrcString() string {
 212         return "e8d4e804"
 213 }
 214 func (*MemclntKeepaliveReply) GetMessageType() api.MessageType {
 215         return api.ReplyMessage
 216 }
 217
 218 // MemclntReadTimeout represents VPP binary API message 'memclnt_read_timeout'.
 219 type MemclntReadTimeout struct {
 220         Dummy uint8
 221 }
 222
 223 func (*MemclntReadTimeout) GetMessageName() string {
 224         return "memclnt_read_timeout"
 225 }
 226 func (*MemclntReadTimeout) GetCrcString() string {
 227         return "c3a3a452"
 228 }
 229 func (*MemclntReadTimeout) GetMessageType() api.MessageType {
 230         return api.OtherMessage
 231 }
 232
 233 // MemclntRxThreadSuspend represents VPP binary API message 'memclnt_rx_thread_suspend'.
 234 type MemclntRxThreadSuspend struct {
 235         Dummy uint8
 236 }
 237
 238 func (*MemclntRxThreadSuspend) GetMessageName() string {
 239         return "memclnt_rx_thread_suspend"
 240 }
 241 func (*MemclntRxThreadSuspend) GetCrcString() string {
 242         return "c3a3a452"
 243 }
 244 func (*MemclntRxThreadSuspend) GetMessageType() api.MessageType {
 245         return api.OtherMessage
 246 }
 247
 248 // RPCCall represents VPP binary API message 'rpc_call'.
 249 type RPCCall struct {
 250         Function        uint64
 251         Multicast       uint8
 252         NeedBarrierSync uint8
 253         SendReply       uint8
 254         DataLen         uint32 `struc:"sizeof=Data"`
 255         Data            []byte
 256 }
 257
 258 func (*RPCCall) GetMessageName() string {
 259         return "rpc_call"
 260 }
 261 func (*RPCCall) GetCrcString() string {
 262         return "7e8a2c95"
 263 }
 264 func (*RPCCall) GetMessageType() api.MessageType {
 265         return api.RequestMessage
 266 }
 267
 268 // RPCCallReply represents VPP binary API message 'rpc_call_reply'.
 269 type RPCCallReply struct {
 270         Retval int32
 271 }
 272
 273 func (*RPCCallReply) GetMessageName() string {
 274         return "rpc_call_reply"
 275 }
 276 func (*RPCCallReply) GetCrcString() string {
 277         return "e8d4e804"
 278 }
 279 func (*RPCCallReply) GetMessageType() api.MessageType {
 280         return api.ReplyMessage
 281 }
 282
 283 // RxThreadExit represents VPP binary API message 'rx_thread_exit'.
 284 type RxThreadExit struct {
 285         Dummy uint8
 286 }
 287
 288 func (*RxThreadExit) GetMessageName() string {
 289         return "rx_thread_exit"
 290 }
 291 func (*RxThreadExit) GetCrcString() string {
 292         return "c3a3a452"
 293 }
 294 func (*RxThreadExit) GetMessageType() api.MessageType {
 295         return api.OtherMessage
 296 }
 297
 298 // SockInitShm represents VPP binary API message 'sock_init_shm'.
 299 type SockInitShm struct {
 300         RequestedSize uint32
 301         Nitems        uint8 `struc:"sizeof=Configs"`
 302         Configs       []uint64
 303 }
 304
 305 func (*SockInitShm) GetMessageName() string {
 306         return "sock_init_shm"
 307 }
 308 func (*SockInitShm) GetCrcString() string {
 309         return "51646d92"
 310 }
 311 func (*SockInitShm) GetMessageType() api.MessageType {
 312         return api.RequestMessage
 313 }
 314
 315 // SockInitShmReply represents VPP binary API message 'sock_init_shm_reply'.
 316 type SockInitShmReply struct {
 317         Retval int32
 318 }
 319
 320 func (*SockInitShmReply) GetMessageName() string {
 321         return "sock_init_shm_reply"
 322 }
 323 func (*SockInitShmReply) GetCrcString() string {
 324         return "e8d4e804"
 325 }
 326 func (*SockInitShmReply) GetMessageType() api.MessageType {
 327         return api.ReplyMessage
 328 }
 329
 330 // SockclntCreate represents VPP binary API message 'sockclnt_create'.
 331 type SockclntCreate struct {
 332         Name []byte `struc:"[64]byte"`
 333 }
 334
 335 func (*SockclntCreate) GetMessageName() string {
 336         return "sockclnt_create"
 337 }
 338 func (*SockclntCreate) GetCrcString() string {
 339         return "df2cf94d"
 340 }
 341 func (*SockclntCreate) GetMessageType() api.MessageType {
 342         return api.ReplyMessage
 343 }
 344
 345 // SockclntCreateReply represents VPP binary API message 'sockclnt_create_reply'.
 346 type SockclntCreateReply struct {
 347         Response     int32
 348         Index        uint32
 349         Count        uint16 `struc:"sizeof=MessageTable"`
 350         MessageTable []MessageTableEntry
 351 }
 352
 353 func (*SockclntCreateReply) GetMessageName() string {
 354         return "sockclnt_create_reply"
 355 }
 356 func (*SockclntCreateReply) GetCrcString() string {
 357         return "a134a8a8"
 358 }
 359 func (*SockclntCreateReply) GetMessageType() api.MessageType {
 360         return api.RequestMessage
 361 }
 362
 363 // SockclntDelete represents VPP binary API message 'sockclnt_delete'.
 364 type SockclntDelete struct {
 365         Index uint32
 366 }
 367
 368 func (*SockclntDelete) GetMessageName() string {
 369         return "sockclnt_delete"
 370 }
 371 func (*SockclntDelete) GetCrcString() string {
 372         return "8ac76db6"
 373 }
 374 func (*SockclntDelete) GetMessageType() api.MessageType {
 375         return api.RequestMessage
 376 }
 377
 378 // SockclntDeleteReply represents VPP binary API message 'sockclnt_delete_reply'.
 379 type SockclntDeleteReply struct {
 380         Response int32
 381 }
 382
 383 func (*SockclntDeleteReply) GetMessageName() string {
 384         return "sockclnt_delete_reply"
 385 }
 386 func (*SockclntDeleteReply) GetCrcString() string {
 387         return "8f38b1ee"
 388 }
 389 func (*SockclntDeleteReply) GetMessageType() api.MessageType {
 390         return api.ReplyMessage
 391 }
 392
 393 // TracePluginMsgIds represents VPP binary API message 'trace_plugin_msg_ids'.
 394 type TracePluginMsgIds struct {
 395         PluginName []byte `struc:"[128]byte"`
 396         FirstMsgID uint16
 397         LastMsgID  uint16
 398 }
 399
 400 func (*TracePluginMsgIds) GetMessageName() string {
 401         return "trace_plugin_msg_ids"
 402 }
 403 func (*TracePluginMsgIds) GetCrcString() string {
 404         return "64af79f9"
 405 }
 406 func (*TracePluginMsgIds) GetMessageType() api.MessageType {
 407         return api.RequestMessage
 408 }
 409
 410 func init() {
 411         api.RegisterMessage((*APIVersions)(nil), "memclnt.APIVersions")
 412         api.RegisterMessage((*APIVersionsReply)(nil), "memclnt.APIVersionsReply")
 413         api.RegisterMessage((*GetFirstMsgID)(nil), "memclnt.GetFirstMsgID")
 414         api.RegisterMessage((*GetFirstMsgIDReply)(nil), "memclnt.GetFirstMsgIDReply")
 415         api.RegisterMessage((*MemclntCreate)(nil), "memclnt.MemclntCreate")
 416         api.RegisterMessage((*MemclntCreateReply)(nil), "memclnt.MemclntCreateReply")
 417         api.RegisterMessage((*MemclntDelete)(nil), "memclnt.MemclntDelete")
 418         api.RegisterMessage((*MemclntDeleteReply)(nil), "memclnt.MemclntDeleteReply")
 419         api.RegisterMessage((*MemclntKeepalive)(nil), "memclnt.MemclntKeepalive")
 420         api.RegisterMessage((*MemclntKeepaliveReply)(nil), "memclnt.MemclntKeepaliveReply")
 421         api.RegisterMessage((*MemclntReadTimeout)(nil), "memclnt.MemclntReadTimeout")
 422         api.RegisterMessage((*MemclntRxThreadSuspend)(nil), "memclnt.MemclntRxThreadSuspend")
 423         api.RegisterMessage((*RPCCall)(nil), "memclnt.RPCCall")
 424         api.RegisterMessage((*RPCCallReply)(nil), "memclnt.RPCCallReply")
 425         api.RegisterMessage((*RxThreadExit)(nil), "memclnt.RxThreadExit")
 426         api.RegisterMessage((*SockInitShm)(nil), "memclnt.SockInitShm")
 427         api.RegisterMessage((*SockInitShmReply)(nil), "memclnt.SockInitShmReply")
 428         api.RegisterMessage((*SockclntCreate)(nil), "memclnt.SockclntCreate")
 429         api.RegisterMessage((*SockclntCreateReply)(nil), "memclnt.SockclntCreateReply")
 430         api.RegisterMessage((*SockclntDelete)(nil), "memclnt.SockclntDelete")
 431         api.RegisterMessage((*SockclntDeleteReply)(nil), "memclnt.SockclntDeleteReply")
 432         api.RegisterMessage((*TracePluginMsgIds)(nil), "memclnt.TracePluginMsgIds")
 433 }
 434
 435 // Messages returns list of all messages in this module.
 436 func AllMessages() []api.Message {
 437         return []api.Message{
 438                 (*APIVersions)(nil),
 439                 (*APIVersionsReply)(nil),
 440                 (*GetFirstMsgID)(nil),
 441                 (*GetFirstMsgIDReply)(nil),
 442                 (*MemclntCreate)(nil),
 443                 (*MemclntCreateReply)(nil),
 444                 (*MemclntDelete)(nil),
 445                 (*MemclntDeleteReply)(nil),
 446                 (*MemclntKeepalive)(nil),
 447                 (*MemclntKeepaliveReply)(nil),
 448                 (*MemclntReadTimeout)(nil),
 449                 (*MemclntRxThreadSuspend)(nil),
 450                 (*RPCCall)(nil),
 451                 (*RPCCallReply)(nil),
 452                 (*RxThreadExit)(nil),
 453                 (*SockInitShm)(nil),
 454                 (*SockInitShmReply)(nil),
 455                 (*SockclntCreate)(nil),
 456                 (*SockclntCreateReply)(nil),
 457                 (*SockclntDelete)(nil),
 458                 (*SockclntDeleteReply)(nil),
 459                 (*TracePluginMsgIds)(nil),
 460         }
 461 }
 462
 463 // RPCService represents RPC service API for memclnt module.
 464 type RPCService interface {
 465         APIVersions(ctx context.Context, in *APIVersions) (*APIVersionsReply, error)
 466         GetFirstMsgID(ctx context.Context, in *GetFirstMsgID) (*GetFirstMsgIDReply, error)
 467         MemclntCreate(ctx context.Context, in *MemclntCreate) (*MemclntCreateReply, error)
 468         MemclntDelete(ctx context.Context, in *MemclntDelete) (*MemclntDeleteReply, error)
 469         MemclntKeepalive(ctx context.Context, in *MemclntKeepalive) (*MemclntKeepaliveReply, error)
 470         MemclntReadTimeout(ctx context.Context, in *MemclntReadTimeout) error
 471         MemclntRxThreadSuspend(ctx context.Context, in *MemclntRxThreadSuspend) error
 472         RPCCall(ctx context.Context, in *RPCCall) (*RPCCallReply, error)
 473         RxThreadExit(ctx context.Context, in *RxThreadExit) error
 474         SockInitShm(ctx context.Context, in *SockInitShm) (*SockInitShmReply, error)
 475         SockclntCreate(ctx context.Context, in *SockclntCreate) (*SockclntCreateReply, error)
 476         SockclntDelete(ctx context.Context, in *SockclntDelete) (*SockclntDeleteReply, error)
 477         TracePluginMsgIds(ctx context.Context, in *TracePluginMsgIds) error
 478 }
 479
 480 type serviceClient struct {
 481         ch api.Channel
 482 }
 483
 484 func NewServiceClient(ch api.Channel) RPCService {
 485         return &serviceClient{ch}
 486 }
 487
 488 func (c *serviceClient) APIVersions(ctx context.Context, in *APIVersions) (*APIVersionsReply, error) {
 489         out := new(APIVersionsReply)
 490         err := c.ch.SendRequest(in).ReceiveReply(out)
 491         if err != nil {
 492                 return nil, err
 493         }
 494         return out, nil
 495 }
 496
 497 func (c *serviceClient) GetFirstMsgID(ctx context.Context, in *GetFirstMsgID) (*GetFirstMsgIDReply, error) {
 498         out := new(GetFirstMsgIDReply)
 499         err := c.ch.SendRequest(in).ReceiveReply(out)
 500         if err != nil {
 501                 return nil, err
 502         }
 503         return out, nil
 504 }
 505
 506 func (c *serviceClient) MemclntCreate(ctx context.Context, in *MemclntCreate) (*MemclntCreateReply, error) {
 507         out := new(MemclntCreateReply)
 508         err := c.ch.SendRequest(in).ReceiveReply(out)
 509         if err != nil {
 510                 return nil, err
 511         }
 512         return out, nil
 513 }
 514
 515 func (c *serviceClient) MemclntDelete(ctx context.Context, in *MemclntDelete) (*MemclntDeleteReply, error) {
 516         out := new(MemclntDeleteReply)
 517         err := c.ch.SendRequest(in).ReceiveReply(out)
 518         if err != nil {
 519                 return nil, err
 520         }
 521         return out, nil
 522 }
 523
 524 func (c *serviceClient) MemclntKeepalive(ctx context.Context, in *MemclntKeepalive) (*MemclntKeepaliveReply, error) {
 525         out := new(MemclntKeepaliveReply)
 526         err := c.ch.SendRequest(in).ReceiveReply(out)
 527         if err != nil {
 528                 return nil, err
 529         }
 530         return out, nil
 531 }
 532
 533 func (c *serviceClient) MemclntReadTimeout(ctx context.Context, in *MemclntReadTimeout) error {
 534         c.ch.SendRequest(in)
 535         return nil
 536 }
 537
 538 func (c *serviceClient) MemclntRxThreadSuspend(ctx context.Context, in *MemclntRxThreadSuspend) error {
 539         c.ch.SendRequest(in)
 540         return nil
 541 }
 542
 543 func (c *serviceClient) RPCCall(ctx context.Context, in *RPCCall) (*RPCCallReply, error) {
 544         out := new(RPCCallReply)
 545         err := c.ch.SendRequest(in).ReceiveReply(out)
 546         if err != nil {
 547                 return nil, err
 548         }
 549         return out, nil
 550 }
 551
 552 func (c *serviceClient) RxThreadExit(ctx context.Context, in *RxThreadExit) error {
 553         c.ch.SendRequest(in)
 554         return nil
 555 }
 556
 557 func (c *serviceClient) SockInitShm(ctx context.Context, in *SockInitShm) (*SockInitShmReply, error) {
 558         out := new(SockInitShmReply)
 559         err := c.ch.SendRequest(in).ReceiveReply(out)
 560         if err != nil {
 561                 return nil, err
 562         }
 563         return out, nil
 564 }
 565
 566 func (c *serviceClient) SockclntCreate(ctx context.Context, in *SockclntCreate) (*SockclntCreateReply, error) {
 567         out := new(SockclntCreateReply)
 568         err := c.ch.SendRequest(in).ReceiveReply(out)
 569         if err != nil {
 570                 return nil, err
 571         }
 572         return out, nil
 573 }
 574
 575 func (c *serviceClient) SockclntDelete(ctx context.Context, in *SockclntDelete) (*SockclntDeleteReply, error) {
 576         out := new(SockclntDeleteReply)
 577         err := c.ch.SendRequest(in).ReceiveReply(out)
 578         if err != nil {
 579                 return nil, err
 580         }
 581         return out, nil
 582 }
 583
 584 func (c *serviceClient) TracePluginMsgIds(ctx context.Context, in *TracePluginMsgIds) error {
 585         c.ch.SendRequest(in)
 586         return nil
 587 }
 588
 589 // This is a compile-time assertion to ensure that this generated file
 590 // is compatible with the GoVPP api package it is being compiled against.
 591 // A compilation error at this line likely means your copy of the
 592 // GoVPP api package needs to be updated.
 593 const _ = api.GoVppAPIPackageIsVersion1 // please upgrade the GoVPP api package
 594
 595 // Reference imports to suppress errors if they are not otherwise used.
 596 var _ = api.RegisterMessage
 597 var _ = bytes.NewBuffer
 598 var _ = context.Background
 599 var _ = io.Copy
 600 var _ = strconv.Itoa
 601 var _ = struc.Pack