src/vpp-api/python/vpp_papi/data/memclnt.api.json

   1 {
   2     "types": [
   3         [
   4             "module_version",
   5             [
   6                 "u32",
   7                 "major"
   8             ],
   9             [
  10                 "u32",
  11                 "minor"
  12             ],
  13             [
  14                 "u32",
  15                 "patch"
  16             ],
  17             [
  18                 "string",
  19                 "name",
  20                 64
  21             ]
  22         ],
  23         [
  24             "message_table_entry",
  25             [
  26                 "u16",
  27                 "index"
  28             ],
  29             [
  30                 "string",
  31                 "name",
  32                 64
  33             ]
  34         ]
  35     ],
  36     "messages": [
  37         [
  38             "memclnt_create",
  39             [
  40                 "u16",
  41                 "_vl_msg_id"
  42             ],
  43             [
  44                 "u32",
  45                 "context"
  46             ],
  47             [
  48                 "i32",
  49                 "ctx_quota"
  50             ],
  51             [
  52                 "u64",
  53                 "input_queue"
  54             ],
  55             [
  56                 "string",
  57                 "name",
  58                 64
  59             ],
  60             [
  61                 "u32",
  62                 "api_versions",
  63                 8
  64             ],
  65             {
  66                 "crc": "0x9c5e1c2f",
  67                 "options": {
  68                     "deprecated": null
  69                 },
  70                 "comment": "/*\n * Create a client registration\n */"
  71             }
  72         ],
  73         [
  74             "memclnt_create_reply",
  75             [
  76                 "u16",
  77                 "_vl_msg_id"
  78             ],
  79             [
  80                 "u32",
  81                 "context"
  82             ],
  83             [
  84                 "i32",
  85                 "response"
  86             ],
  87             [
  88                 "u64",
  89                 "handle"
  90             ],
  91             [
  92                 "u32",
  93                 "index"
  94             ],
  95             [
  96                 "u64",
  97                 "message_table"
  98             ],
  99             {
 100                 "crc": "0x42ec4560",
 101                 "options": {
 102                     "deprecated": null
 103                 }
 104             }
 105         ],
 106         [
 107             "memclnt_delete",
 108             [
 109                 "u16",
 110                 "_vl_msg_id"
 111             ],
 112             [
 113                 "u32",
 114                 "index"
 115             ],
 116             [
 117                 "u64",
 118                 "handle"
 119             ],
 120             [
 121                 "bool",
 122                 "do_cleanup"
 123             ],
 124             {
 125                 "crc": "0x7e1c04e3",
 126                 "options": {},
 127                 "comment": "/*\n * Delete a client registration\n */"
 128             }
 129         ],
 130         [
 131             "memclnt_delete_reply",
 132             [
 133                 "u16",
 134                 "_vl_msg_id"
 135             ],
 136             [
 137                 "i32",
 138                 "response"
 139             ],
 140             [
 141                 "u64",
 142                 "handle"
 143             ],
 144             {
 145                 "crc": "0x3d3b6312",
 146                 "options": {}
 147             }
 148         ],
 149         [
 150             "rx_thread_exit",
 151             [
 152                 "u16",
 153                 "_vl_msg_id"
 154             ],
 155             [
 156                 "u8",
 157                 "dummy"
 158             ],
 159             {
 160                 "crc": "0xc3a3a452",
 161                 "options": {},
 162                 "comment": "/*\n * Client RX thread exit\n */"
 163             }
 164         ],
 165         [
 166             "memclnt_rx_thread_suspend",
 167             [
 168                 "u16",
 169                 "_vl_msg_id"
 170             ],
 171             [
 172                 "u8",
 173                 "dummy"
 174             ],
 175             {
 176                 "crc": "0xc3a3a452",
 177                 "options": {},
 178                 "comment": "/*\n * Client RX thread suspend\n */"
 179             }
 180         ],
 181         [
 182             "memclnt_read_timeout",
 183             [
 184                 "u16",
 185                 "_vl_msg_id"
 186             ],
 187             [
 188                 "u8",
 189                 "dummy"
 190             ],
 191             {
 192                 "crc": "0xc3a3a452",
 193                 "options": {},
 194                 "comment": "/*\n * Client read timeout\n */"
 195             }
 196         ],
 197         [
 198             "rpc_call",
 199             [
 200                 "u16",
 201                 "_vl_msg_id"
 202             ],
 203             [
 204                 "u32",
 205                 "client_index"
 206             ],
 207             [
 208                 "u32",
 209                 "context"
 210             ],
 211             [
 212                 "u64",
 213                 "function"
 214             ],
 215             [
 216                 "u8",
 217                 "multicast"
 218             ],
 219             [
 220                 "u8",
 221                 "need_barrier_sync"
 222             ],
 223             [
 224                 "u8",
 225                 "send_reply"
 226             ],
 227             [
 228                 "u32",
 229                 "data_len"
 230             ],
 231             [
 232                 "u8",
 233                 "data",
 234                 0,
 235                 "data_len"
 236             ],
 237             {
 238                 "crc": "0x7e8a2c95",
 239                 "options": {},
 240                 "comment": "/*\n * RPC\n */"
 241             }
 242         ],
 243         [
 244             "rpc_call_reply",
 245             [
 246                 "u16",
 247                 "_vl_msg_id"
 248             ],
 249             [
 250                 "u32",
 251                 "context"
 252             ],
 253             [
 254                 "i32",
 255                 "retval"
 256             ],
 257             {
 258                 "crc": "0xe8d4e804",
 259                 "options": {}
 260             }
 261         ],
 262         [
 263             "get_first_msg_id",
 264             [
 265                 "u16",
 266                 "_vl_msg_id"
 267             ],
 268             [
 269                 "u32",
 270                 "client_index"
 271             ],
 272             [
 273                 "u32",
 274                 "context"
 275             ],
 276             [
 277                 "string",
 278                 "name",
 279                 64
 280             ],
 281             {
 282                 "crc": "0xebf79a66",
 283                 "options": {},
 284                 "comment": "/*\n * Lookup message-ID base by name\n */"
 285             }
 286         ],
 287         [
 288             "get_first_msg_id_reply",
 289             [
 290                 "u16",
 291                 "_vl_msg_id"
 292             ],
 293             [
 294                 "u32",
 295                 "context"
 296             ],
 297             [
 298                 "i32",
 299                 "retval"
 300             ],
 301             [
 302                 "u16",
 303                 "first_msg_id"
 304             ],
 305             {
 306                 "crc": "0x7d337472",
 307                 "options": {}
 308             }
 309         ],
 310         [
 311             "api_versions",
 312             [
 313                 "u16",
 314                 "_vl_msg_id"
 315             ],
 316             [
 317                 "u32",
 318                 "client_index"
 319             ],
 320             [
 321                 "u32",
 322                 "context"
 323             ],
 324             {
 325                 "crc": "0x51077d14",
 326                 "options": {},
 327                 "comment": "/*\n * Get API version table (includes built-in and plugins)\n */"
 328             }
 329         ],
 330         [
 331             "api_versions_reply",
 332             [
 333                 "u16",
 334                 "_vl_msg_id"
 335             ],
 336             [
 337                 "u32",
 338                 "context"
 339             ],
 340             [
 341                 "i32",
 342                 "retval"
 343             ],
 344             [
 345                 "u32",
 346                 "count"
 347             ],
 348             [
 349                 "vl_api_module_version_t",
 350                 "api_versions",
 351                 0,
 352                 "count"
 353             ],
 354             {
 355                 "crc": "0x5f0d99d6",
 356                 "options": {}
 357             }
 358         ],
 359         [
 360             "trace_plugin_msg_ids",
 361             [
 362                 "u16",
 363                 "_vl_msg_id"
 364             ],
 365             [
 366                 "u32",
 367                 "client_index"
 368             ],
 369             [
 370                 "u32",
 371                 "context"
 372             ],
 373             [
 374                 "string",
 375                 "plugin_name",
 376                 128
 377             ],
 378             [
 379                 "u16",
 380                 "first_msg_id"
 381             ],
 382             [
 383                 "u16",
 384                 "last_msg_id"
 385             ],
 386             {
 387                 "crc": "0xf476d3ce",
 388                 "options": {},
 389                 "comment": "/*\n * Trace the plugin message-id allocator\n * so we stand a chance of dealing with different sets of plugins\n * at api trace replay time\n */"
 390             }
 391         ],
 392         [
 393             "sockclnt_create",
 394             [
 395                 "u16",
 396                 "_vl_msg_id"
 397             ],
 398             [
 399                 "u32",
 400                 "context"
 401             ],
 402             [
 403                 "string",
 404                 "name",
 405                 64
 406             ],
 407             {
 408                 "crc": "0x455fb9c4",
 409                 "options": {},
 410                 "comment": "/*\n * Create a socket client registration.\n */"
 411             }
 412         ],
 413         [
 414             "sockclnt_create_reply",
 415             [
 416                 "u16",
 417                 "_vl_msg_id"
 418             ],
 419             [
 420                 "u32",
 421                 "client_index"
 422             ],
 423             [
 424                 "u32",
 425                 "context"
 426             ],
 427             [
 428                 "i32",
 429                 "response"
 430             ],
 431             [
 432                 "u32",
 433                 "index"
 434             ],
 435             [
 436                 "u16",
 437                 "count"
 438             ],
 439             [
 440                 "vl_api_message_table_entry_t",
 441                 "message_table",
 442                 0,
 443                 "count"
 444             ],
 445             {
 446                 "crc": "0x35166268",
 447                 "options": {}
 448             }
 449         ],
 450         [
 451             "sockclnt_delete",
 452             [
 453                 "u16",
 454                 "_vl_msg_id"
 455             ],
 456             [
 457                 "u32",
 458                 "client_index"
 459             ],
 460             [
 461                 "u32",
 462                 "context"
 463             ],
 464             [
 465                 "u32",
 466                 "index"
 467             ],
 468             {
 469                 "crc": "0x8ac76db6",
 470                 "options": {},
 471                 "comment": "/*\n * Delete a client registration\n */"
 472             }
 473         ],
 474         [
 475             "sockclnt_delete_reply",
 476             [
 477                 "u16",
 478                 "_vl_msg_id"
 479             ],
 480             [
 481                 "u32",
 482                 "context"
 483             ],
 484             [
 485                 "i32",
 486                 "response"
 487             ],
 488             {
 489                 "crc": "0x8f38b1ee",
 490                 "options": {}
 491             }
 492         ],
 493         [
 494             "sock_init_shm",
 495             [
 496                 "u16",
 497                 "_vl_msg_id"
 498             ],
 499             [
 500                 "u32",
 501                 "client_index"
 502             ],
 503             [
 504                 "u32",
 505                 "context"
 506             ],
 507             [
 508                 "u32",
 509                 "requested_size"
 510             ],
 511             [
 512                 "u8",
 513                 "nitems"
 514             ],
 515             [
 516                 "u64",
 517                 "configs",
 518                 0,
 519                 "nitems"
 520             ],
 521             {
 522                 "crc": "0x51646d92",
 523                 "options": {},
 524                 "comment": "/*\n * Initialize shm api over socket api\n */"
 525             }
 526         ],
 527         [
 528             "sock_init_shm_reply",
 529             [
 530                 "u16",
 531                 "_vl_msg_id"
 532             ],
 533             [
 534                 "u32",
 535                 "context"
 536             ],
 537             [
 538                 "i32",
 539                 "retval"
 540             ],
 541             {
 542                 "crc": "0xe8d4e804",
 543                 "options": {}
 544             }
 545         ],
 546         [
 547             "memclnt_keepalive",
 548             [
 549                 "u16",
 550                 "_vl_msg_id"
 551             ],
 552             [
 553                 "u32",
 554                 "client_index"
 555             ],
 556             [
 557                 "u32",
 558                 "context"
 559             ],
 560             {
 561                 "crc": "0x51077d14",
 562                 "options": {},
 563                 "comment": "/*\n * Memory client ping / response\n * Only sent on inactive connections\n */"
 564             }
 565         ],
 566         [
 567             "memclnt_keepalive_reply",
 568             [
 569                 "u16",
 570                 "_vl_msg_id"
 571             ],
 572             [
 573                 "u32",
 574                 "context"
 575             ],
 576             [
 577                 "i32",
 578                 "retval"
 579             ],
 580             {
 581                 "crc": "0xe8d4e804",
 582                 "options": {}
 583             }
 584         ],
 585         [
 586             "control_ping",
 587             [
 588                 "u16",
 589                 "_vl_msg_id"
 590             ],
 591             [
 592                 "u32",
 593                 "client_index"
 594             ],
 595             [
 596                 "u32",
 597                 "context"
 598             ],
 599             {
 600                 "crc": "0x51077d14",
 601                 "options": {},
 602                 "comment": "/** \\brief Control ping from client to api server request\n    @param client_index - opaque cookie to identify the sender\n    @param context - sender context, to match reply w/ request\n*/"
 603             }
 604         ],
 605         [
 606             "control_ping_reply",
 607             [
 608                 "u16",
 609                 "_vl_msg_id"
 610             ],
 611             [
 612                 "u32",
 613                 "context"
 614             ],
 615             [
 616                 "i32",
 617                 "retval"
 618             ],
 619             [
 620                 "u32",
 621                 "client_index"
 622             ],
 623             [
 624                 "u32",
 625                 "vpe_pid"
 626             ],
 627             {
 628                 "crc": "0xf6b0b8ca",
 629                 "options": {},
 630                 "comment": "/** \\brief Control ping from the client to the server response\n    @param client_index - opaque cookie to identify the sender\n    @param context - sender context, to match reply w/ request\n    @param retval - return code for the request\n    @param vpe_pid - the pid of the vpe, returned by the server\n*/"
 631             }
 632         ],
 633         [
 634             "memclnt_create_v2",
 635             [
 636                 "u16",
 637                 "_vl_msg_id"
 638             ],
 639             [
 640                 "u32",
 641                 "context"
 642             ],
 643             [
 644                 "i32",
 645                 "ctx_quota"
 646             ],
 647             [
 648                 "u64",
 649                 "input_queue"
 650             ],
 651             [
 652                 "string",
 653                 "name",
 654                 64
 655             ],
 656             [
 657                 "u32",
 658                 "api_versions",
 659                 8
 660             ],
 661             [
 662                 "bool",
 663                 "keepalive",
 664                 {
 665                     "default": "true"
 666                 }
 667             ],
 668             {
 669                 "crc": "0xc4bd4882",
 670                 "options": {}
 671             }
 672         ],
 673         [
 674             "memclnt_create_v2_reply",
 675             [
 676                 "u16",
 677                 "_vl_msg_id"
 678             ],
 679             [
 680                 "u32",
 681                 "context"
 682             ],
 683             [
 684                 "i32",
 685                 "response"
 686             ],
 687             [
 688                 "u64",
 689                 "handle"
 690             ],
 691             [
 692                 "u32",
 693                 "index"
 694             ],
 695             [
 696                 "u64",
 697                 "message_table"
 698             ],
 699             {
 700                 "crc": "0x42ec4560",
 701                 "options": {}
 702             }
 703         ],
 704         [
 705             "get_api_json",
 706             [
 707                 "u16",
 708                 "_vl_msg_id"
 709             ],
 710             [
 711                 "u32",
 712                 "client_index"
 713             ],
 714             [
 715                 "u32",
 716                 "context"
 717             ],
 718             {
 719                 "crc": "0x51077d14",
 720                 "options": {}
 721             }
 722         ],
 723         [
 724             "get_api_json_reply",
 725             [
 726                 "u16",
 727                 "_vl_msg_id"
 728             ],
 729             [
 730                 "u32",
 731                 "context"
 732             ],
 733             [
 734                 "i32",
 735                 "retval"
 736             ],
 737             [
 738                 "string",
 739                 "json",
 740                 0
 741             ],
 742             {
 743                 "crc": "0xea715b59",
 744                 "options": {}
 745             }
 746         ]
 747     ],
 748     "unions": [],
 749     "enums": [],
 750     "enumflags": [],
 751     "services": {
 752         "memclnt_rx_thread_suspend": {
 753             "reply": "null"
 754         },
 755         "memclnt_read_timeout": {
 756             "reply": "null"
 757         },
 758         "rx_thread_exit": {
 759             "reply": "null"
 760         },
 761         "trace_plugin_msg_ids": {
 762             "reply": "null"
 763         },
 764         "memclnt_create": {
 765             "reply": "memclnt_create_reply"
 766         },
 767         "memclnt_delete": {
 768             "reply": "memclnt_delete_reply"
 769         },
 770         "rpc_call": {
 771             "reply": "rpc_call_reply"
 772         },
 773         "get_first_msg_id": {
 774             "reply": "get_first_msg_id_reply"
 775         },
 776         "api_versions": {
 777             "reply": "api_versions_reply"
 778         },
 779         "sockclnt_create": {
 780             "reply": "sockclnt_create_reply"
 781         },
 782         "sockclnt_delete": {
 783             "reply": "sockclnt_delete_reply"
 784         },
 785         "sock_init_shm": {
 786             "reply": "sock_init_shm_reply"
 787         },
 788         "memclnt_keepalive": {
 789             "reply": "memclnt_keepalive_reply"
 790         },
 791         "control_ping": {
 792             "reply": "control_ping_reply"
 793         },
 794         "memclnt_create_v2": {
 795             "reply": "memclnt_create_v2_reply"
 796         },
 797         "get_api_json": {
 798             "reply": "get_api_json_reply"
 799         }
 800     },
 801     "options": {
 802         "version": "2.1.0"
 803     },
 804     "aliases": {},
 805     "vl_api_version": "0xb197c551",
 806     "imports": [],
 807     "counters": [],
 808     "paths": []
 809 }