aboutsummaryrefslogtreecommitdiffstats
path: root/binapigen/vppapi/api_schema.go
diff options
context:
space:
mode:
authorOndrej Fabry <ofabry@cisco.com>2020-07-17 10:36:28 +0200
committerOndrej Fabry <ofabry@cisco.com>2020-07-17 11:43:41 +0200
commitd1f24d37bd447b64e402298bb8eb2479681facf9 (patch)
treea3fc21ba730a91d8a402c7a5bf9c614e3677c4fc /binapigen/vppapi/api_schema.go
parent1548c7e12531e3d055567d761c580a1c7ff0ac40 (diff)
Improve binapi generator
- simplified Size/Marshal/Unmarshal methods - replace struc in unions with custom marshal/unmarshal - fix imports in generated files - fix mock adapter - generate rpc service using low-level stream API (dumps generate control ping or stream msg..) - move examples/binapi to binapi and generate all API for latest release - add binapigen.Plugin for developing custom generator plugins - optionally generate HTTP handlers (REST API) for RPC services - add govpp program for browsing VPP API Change-Id: I092e9ed2b0c17972b3476463c3d4b14dd76ed42b Signed-off-by: Ondrej Fabry <ofabry@cisco.com>
Diffstat (limited to 'binapigen/vppapi/api_schema.go')
-rw-r--r--binapigen/vppapi/api_schema.go89
1 files changed, 89 insertions, 0 deletions
diff --git a/binapigen/vppapi/api_schema.go b/binapigen/vppapi/api_schema.go
new file mode 100644
index 0000000..7eceab3
--- /dev/null
+++ b/binapigen/vppapi/api_schema.go
@@ -0,0 +1,89 @@
+// Copyright (c) 2020 Cisco and/or its affiliates.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package vppapi parses VPP API files without any additional processing.
+package vppapi
+
+type (
+ File struct {
+ Name string
+ Path string
+ CRC string
+
+ Options map[string]string `json:",omitempty"`
+ Imports []string `json:",omitempty"`
+
+ AliasTypes []AliasType `json:",omitempty"`
+ EnumTypes []EnumType `json:",omitempty"`
+ StructTypes []StructType `json:",omitempty"`
+ UnionTypes []UnionType `json:",omitempty"`
+
+ Messages []Message `json:",omitempty"`
+ Service *Service `json:",omitempty"`
+ }
+
+ AliasType struct {
+ Name string
+ Type string
+ Length int `json:",omitempty"`
+ }
+
+ EnumType struct {
+ Name string
+ Type string
+ Entries []EnumEntry
+ }
+
+ EnumEntry struct {
+ Name string
+ Value uint32
+ }
+
+ StructType struct {
+ Name string
+ Fields []Field
+ }
+
+ UnionType struct {
+ Name string
+ Fields []Field
+ }
+
+ Message struct {
+ Name string
+ Fields []Field
+ CRC string
+ }
+
+ Field struct {
+ Name string
+ Type string
+ Length int `json:",omitempty"`
+ Array bool `json:",omitempty"`
+ SizeFrom string `json:",omitempty"`
+ Meta map[string]interface{} `json:",omitempty"`
+ }
+
+ Service struct {
+ RPCs []RPC `json:",omitempty"`
+ }
+
+ RPC struct {
+ Request string
+ Reply string
+ Stream bool `json:",omitempty"`
+ StreamMsg string `json:",omitempty"`
+ Events []string `json:",omitempty"`
+ }
+)