From 43765e2b4eaa8e1f2a5f1562414e04962c777ff3 Mon Sep 17 00:00:00 2001 From: Dave Barach Date: Tue, 17 Sep 2019 09:47:35 -0400 Subject: builtinurl: initial working attempt Note that the builtin URLs are disabled by default. To activate, "builtinurl enable" or use the builtinurl_enable API. See .../extras/http/sample.md for some Hugo-friendly .md w/ embedded Javascript that accesses the builtin URLs. Type: feature Signed-off-by: Dave Barach Change-Id: I6d82d9292c41d6d2d90be73ba8a1a043fb20c986 --- src/plugins/builtinurl/builtinurl.api | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 src/plugins/builtinurl/builtinurl.api (limited to 'src/plugins/builtinurl/builtinurl.api') diff --git a/src/plugins/builtinurl/builtinurl.api b/src/plugins/builtinurl/builtinurl.api new file mode 100644 index 00000000000..f292fd77a8e --- /dev/null +++ b/src/plugins/builtinurl/builtinurl.api @@ -0,0 +1,43 @@ +/* + * builtinurl.api - binary API skeleton + * + * Copyright (c) + * 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. + */ + +/** + * @file builtinurl.api + * @brief VPP control-plane API messages. + * + * This file defines VPP control-plane binary API messages which are generally + * called through a shared memory interface. + */ + +/* Version and type recitations */ + +option version = "1.0.0"; + +/** @brief API to enable / disable builtinurl on an interface + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param enable_disable - 1 to enable, 0 to disable the feature + @param sw_if_index - interface handle +*/ + +autoreply define builtinurl_enable { + /* Client identifier, set from api_main.my_client_index */ + u32 client_index; + + /* Arbitrary context, so client can match reply to request */ + u32 context; +}; -- cgit 1.2.3-korg