From c580a00aac271a524e5a75b35f4b91c174ed227b Mon Sep 17 00:00:00 2001 From: michele papalini Date: Thu, 23 Feb 2017 17:01:34 +0100 Subject: Initial commit: sb-forwarder, metis. Change-Id: I65ee3c851a6901929ef4417ad80d34bca0dce445 Signed-off-by: michele papalini --- metis/ccnx/forwarder/metis/core/metis_System.h | 80 ++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 metis/ccnx/forwarder/metis/core/metis_System.h (limited to 'metis/ccnx/forwarder/metis/core/metis_System.h') diff --git a/metis/ccnx/forwarder/metis/core/metis_System.h b/metis/ccnx/forwarder/metis/core/metis_System.h new file mode 100644 index 00000000..5775e0fe --- /dev/null +++ b/metis/ccnx/forwarder/metis/core/metis_System.h @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2017 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. + */ + +/** + * @header metis_System.h + * @abstract System-level properties + * @discussion + * <#Discussion#> + * + */ + +#ifndef Metis_metis_System_h +#define Metis_metis_System_h + +#include +#include + +/** + * @function metisSystem_Interfaces + * @abstract The system network interfaces + * @discussion + * <#Discussion#> + * + * @param <#param1#> + * @return <#return#> + */ +CPIInterfaceSet *metisSystem_Interfaces(MetisForwarder *metis); + +/** + * Returns the MTU of the named interface + * + * <#Paragraphs Of Explanation#> + * + * @param [in] metis An allocated forwarder + * @param [in] interfaceName The system interface name, e.g. "eth0" + * + * @return 0 Interface does not exist + * @return positive the MTU the kernel reports + * + * Example: + * @code + * { + * <#example#> + * } + * @endcode + */ +unsigned metisSystem_InterfaceMtu(MetisForwarder *metis, const char *interfaceName); + +/** + * Returns the LINK address of the specified interface + * + * <#Paragraphs Of Explanation#> + * + * @param [in] metis An allocated forwarder + * @param [in] interfaceName The system interface name, e.g. "eth0" + * + * @retval non-null The MAC address of the interface + * @retval null The interface does not exist + * + * Example: + * @code + * { + * CPIAddress *linkAddress = metisSystem_GetMacAddressByName(metis, "en0"); + * } + * @endcode + */ +CPIAddress *metisSystem_GetMacAddressByName(MetisForwarder *metis, const char *interfaceName); +#endif -- cgit 1.2.3-korg