From c4522fe10317b1729a0820dc880afc78c663f64d Mon Sep 17 00:00:00 2001 From: Ondrej Fabry Date: Thu, 6 Jun 2019 14:08:48 +0200 Subject: Add various generator improvements - generate service implementation for modules - generate conversion maps and String() method for enums - generate module name and version as constants - rename Union_data field to XXX_UnionData for consistency - generate constant GoVppAPIPackageIsVersionN for checking compatibility with API - add example for using service clients - add some documentation to socketclient adapter - cleanup gen.go file used for generating binapi - regenerate binapi with latest VPP release (19.04.1) - change global variables Messages into a function AllMessages Change-Id: Id1ef97764570759eaa3e5a4dc14ecda7a168ee39 Signed-off-by: Ondrej Fabry --- adapter/socketclient/doc.go | 33 +++++++++++++++++++++++++++++++++ adapter/socketclient/socketclient.go | 2 +- 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 adapter/socketclient/doc.go (limited to 'adapter/socketclient') diff --git a/adapter/socketclient/doc.go b/adapter/socketclient/doc.go new file mode 100644 index 0000000..0f93c56 --- /dev/null +++ b/adapter/socketclient/doc.go @@ -0,0 +1,33 @@ +// Copyright (c) 2018 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 socketclient is a pure Go implementation of adapter.VppAPI, which uses +// unix domain sockets as the transport for connecting to the VPP binary API. +// +// The current implementation only supports VPP binary API, the VPP stats API +// is not supported and clients still have to use vppapiclient for retrieving stats. +// +// +// Requirements +// +// The socketclient will connect to /run/vpp-api.sock by default. However this +// is not enabled in VPP configuration by default. +// +// To enable the socket in VPP, add following section to VPP config. +// +// socksvr { +// default +// } +// +package socketclient diff --git a/adapter/socketclient/socketclient.go b/adapter/socketclient/socketclient.go index 4a76df2..19fff7a 100644 --- a/adapter/socketclient/socketclient.go +++ b/adapter/socketclient/socketclient.go @@ -18,7 +18,7 @@ import ( "git.fd.io/govpp.git/adapter" "git.fd.io/govpp.git/codec" - "git.fd.io/govpp.git/examples/bin_api/memclnt" + "git.fd.io/govpp.git/examples/binapi/memclnt" ) const ( -- cgit 1.2.3-korg