diff options
author | Luca Muscariello <lumuscar+fdio@cisco.com> | 2017-02-24 07:59:45 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2017-02-24 07:59:45 +0000 |
commit | e0ec678c016fbce560e7f94973d4fada3ba5e799 (patch) | |
tree | a171ed331a830510f3064a6ad99b296ac1b2d2bc /metis/ccnx/forwarder/metis/core/metis_System.h | |
parent | f28308bd99381ef5f1e178e2e1f870f245e35873 (diff) | |
parent | c580a00aac271a524e5a75b35f4b91c174ed227b (diff) |
Merge "Initial commit: sb-forwarder, metis." into sb-forwarder/master
Diffstat (limited to 'metis/ccnx/forwarder/metis/core/metis_System.h')
-rw-r--r-- | metis/ccnx/forwarder/metis/core/metis_System.h | 80 |
1 files changed, 80 insertions, 0 deletions
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 <ccnx/forwarder/metis/core/metis_Forwarder.h> +#include <ccnx/api/control/cpi_InterfaceSet.h> + +/** + * @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 |