examples/binapi/memclnt/memclnt.ba.go

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