netint.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * 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.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal_netint.h: Platform-neutral method for enumerating network interfaces. */
 
#ifndef ETCPAL_NETINT_H_
#define ETCPAL_NETINT_H_
 
#include <stdbool.h>
#include <stddef.h>
#include "etcpal/common.h"
#include "etcpal/inet.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
etcpal_error_t etcpal_netint_get_interfaces(EtcPalNetintInfo* netints, size_t* num_netints);
etcpal_error_t etcpal_netint_get_interfaces_for_index(unsigned int      netint_index,
                                                      EtcPalNetintInfo* netints,
                                                      size_t*           num_netints);
etcpal_error_t etcpal_netint_get_interface_with_ip(const EtcPalIpAddr* ip, EtcPalNetintInfo* netint);
 
etcpal_error_t etcpal_netint_get_default_interface(etcpal_iptype_t type, unsigned int* netint_index);
etcpal_error_t etcpal_netint_get_interface_for_dest(const EtcPalIpAddr* dest, unsigned int* netint_index);
 
etcpal_error_t etcpal_netint_refresh_interfaces();
 
bool etcpal_netint_is_up(unsigned int netint_index);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_NETINT_H_ */