Embedded TCP/IP stack: fnet_netif.h Source File

FNET

previous page next page
fnet_netif.h
1 /**************************************************************************
2 *
3 * Copyright 2011-2016 by Andrey Butok. FNET Community.
4 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.
5 * Copyright 2003 by Andrey Butok, Alexey Shervashidze. Motorola SPS
6 *
7 ***************************************************************************
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 *
21 ***************************************************************************
22 *
23 * FNET Network interface API.
24 *
25 ***************************************************************************/
26 
27 #ifndef _FNET_NETIF_H_
28 
29 #define _FNET_NETIF_H_
30 
31 #include "fnet_ip4.h"
32 #include "fnet_ip6.h"
33 #include "fnet_eth.h"
34 #include "fnet_socket.h"
35 
43 /**************************************************************************/
46 typedef enum
47 {
48  FNET_NETIF_TYPE_OTHER = 0,
49  FNET_NETIF_TYPE_ETHERNET,
50  FNET_NETIF_TYPE_WIFI,
51  FNET_NETIF_TYPE_LOOPBACK
52 } fnet_netif_type_t;
53 
54 /**************************************************************************/
57 struct fnet_netif_statistics
58 {
59  fnet_uint32_t tx_packet;
60  fnet_uint32_t rx_packet;
61 };
62 
63 /**************************************************************************/
66 #define FNET_NETIF_NAMELEN (8U)
67 
68 /**************************************************************************/
71 typedef void *fnet_netif_desc_t;
72 
73 #define FNET_NETIF_LL_ADDR_MAX (16)
74 /**************************************************************************/
78 typedef fnet_uint8_t fnet_netif_ll_addr_t[FNET_NETIF_LL_ADDR_MAX];
79 
80 /**************************************************************************/
83 #define FNET_NETIF_LL_ADDR_COPY(from_addr, to_addr, ll_size) \
84  (fnet_memcpy(&(to_addr)[0], &(from_addr)[0], (ll_size)))
85 
86 /**************************************************************************/
89 #define FNET_NETIF_LL_ADDR_ARE_EQUAL(a, b, size) \
90  (fnet_memcmp(&(a)[0], &(b)[0], (size)) == 0)
91 
92 /**************************************************************************/
96 typedef enum
97 {
98  FNET_NETIF_IP6_ADDR_STATE_NOT_USED = 0,
99  FNET_NETIF_IP6_ADDR_STATE_TENTATIVE = 1,
106  FNET_NETIF_IP6_ADDR_STATE_PREFERRED = 2
111 } fnet_netif_ip6_addr_state_t;
112 
113 /**************************************************************************/
117 typedef enum
118 {
119  FNET_NETIF_IP_ADDR_TYPE_MANUAL = 0,
120  FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE = 1,
121  FNET_NETIF_IP_ADDR_TYPE_DHCP = 2
122 } fnet_netif_ip_addr_type_t;
123 
124 /**************************************************************************/
128 typedef struct fnet_netif_ip6_addr_info
129 {
130  fnet_ip6_addr_t address;
131  fnet_netif_ip6_addr_state_t state;
132  fnet_netif_ip_addr_type_t type;
133 } fnet_netif_ip6_addr_info_t;
134 
135 /**************************************************************************/
139 typedef struct fnet_netif_ip6_prefix
140 {
141  fnet_ip6_addr_t prefix;
142  fnet_size_t prefix_length;
144 } fnet_netif_ip6_prefix_t;
145 
146 /**************************************************************************/
150 typedef struct fnet_netif_ip6_neighbor_cache
151 {
152  fnet_ip6_addr_t ip_addr;
153  fnet_netif_ll_addr_t ll_addr;
154  fnet_size_t ll_addr_size;
155  fnet_bool_t is_router;
156 } fnet_netif_ip6_neighbor_cache_t;
157 
158 #if defined(__cplusplus)
159 extern "C" {
160 #endif
161 
162 /***************************************************************************/
182 fnet_netif_desc_t fnet_netif_get_by_name( const fnet_char_t *name );
183 
184 /***************************************************************************/
202 fnet_netif_desc_t fnet_netif_get_by_number( fnet_index_t n );
203 
204 /***************************************************************************/
223 fnet_netif_desc_t fnet_netif_get_by_ip4_addr( fnet_ip4_addr_t addr );
224 
225 /***************************************************************************/
246 void fnet_netif_get_name( fnet_netif_desc_t netif_desc, fnet_char_t *name, fnet_size_t name_size );
247 
248 /***************************************************************************/
265 void fnet_netif_set_default( fnet_netif_desc_t netif_desc );
266 
267 /***************************************************************************/
284 fnet_netif_desc_t fnet_netif_get_default( void );
285 
286 /***************************************************************************/
304 void fnet_netif_set_ip4_addr( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t ipaddr, fnet_ip4_addr_t subnet_mask);
305 
306 /***************************************************************************/
321 fnet_ip4_addr_t fnet_netif_get_ip4_addr( fnet_netif_desc_t netif_desc );
322 
323 /***************************************************************************/
339 void fnet_netif_set_ip4_subnet_mask( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t subnet_mask );
340 
341 /***************************************************************************/
357 fnet_ip4_addr_t fnet_netif_get_ip4_subnet_mask( fnet_netif_desc_t netif_desc );
358 
359 /***************************************************************************/
375 void fnet_netif_set_ip4_gateway( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t gw );
376 
377 /***************************************************************************/
393 fnet_ip4_addr_t fnet_netif_get_ip4_gateway( fnet_netif_desc_t netif_desc );
394 
395 
396 #if FNET_CFG_DNS || defined(__DOXYGEN__)
397 /***************************************************************************/
414 void fnet_netif_set_ip4_dns( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t dns );
415 
416 /***************************************************************************/
434 fnet_ip4_addr_t fnet_netif_get_ip4_dns( fnet_netif_desc_t netif_desc );
435 
436 #endif /*FNET_CFG_DNS*/
437 
438 /***************************************************************************/
466 fnet_return_t fnet_netif_set_hw_addr( fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );
467 
468 /***************************************************************************/
496 fnet_return_t fnet_netif_get_hw_addr( fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );
497 
498 /***************************************************************************/
514 fnet_netif_type_t fnet_netif_get_type( fnet_netif_desc_t netif_desc );
515 
516 /***************************************************************************/
534 fnet_netif_ip_addr_type_t fnet_netif_get_ip4_addr_type( fnet_netif_desc_t netif_desc );
535 
536 /***************************************************************************/
556 void fnet_netif_set_ip4_addr_type( fnet_netif_desc_t netif_desc, fnet_netif_ip_addr_type_t ipaddr_type );
557 
558 /***************************************************************************/
575 fnet_bool_t fnet_netif_is_connected( fnet_netif_desc_t netif_desc );
576 
577 /***************************************************************************/
598 fnet_return_t fnet_netif_get_statistics( fnet_netif_desc_t netif_desc, struct fnet_netif_statistics *statistics );
599 
600 /**************************************************************************/
610 typedef void(*fnet_netif_callback_ip4_addr_conflict_t)( fnet_netif_desc_t netif );
611 
612 /***************************************************************************/
629 void fnet_netif_set_callback_on_ip4_addr_conflict (fnet_netif_callback_ip4_addr_conflict_t callback);
630 
631 /***************************************************************************/
652 fnet_bool_t fnet_netif_is_ip4_addr_conflict(fnet_netif_desc_t netif_desc);
653 
654 /***************************************************************************/
670 void fnet_netif_clear_ip4_addr_conflict( fnet_netif_desc_t netif_desc );
671 
672 #if (FNET_CFG_MULTICAST & FNET_CFG_IP4) || defined(__DOXYGEN__)
673 
674 /***************************************************************************/
696 void fnet_netif_join_ip4_multicast ( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr );
697 
698 /***************************************************************************/
717 void fnet_netif_leave_ip4_multicast ( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr );
718 
719 #endif /* FNET_CFG_MULTICAST & FNET_CFG_IP4*/
720 
721 #if FNET_CFG_IP6 || defined(__DOXYGEN__)
722 
723 /***************************************************************************/
744 void fnet_netif_join_ip6_multicast ( fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *multicast_addr );
745 
746 /***************************************************************************/
764 void fnet_netif_leave_ip6_multicast ( fnet_netif_desc_t netif_desc, fnet_ip6_addr_t *multicast_addr );
765 
766 /***************************************************************************/
786 fnet_bool_t fnet_netif_get_ip6_addr ( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_addr_info_t *addr_info );
787 
788 #if FNET_CFG_DNS || defined(__DOXYGEN__)
789 /***************************************************************************/
811 fnet_bool_t fnet_netif_get_ip6_dns( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_ip6_addr_t *addr_dns );
812 #endif /* FNET_CFG_DNS */
813 
814 /***************************************************************************/
846 fnet_return_t fnet_netif_bind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr, fnet_netif_ip_addr_type_t addr_type);
847 
848 /***************************************************************************/
867 fnet_return_t fnet_netif_unbind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr);
868 
869 /***************************************************************************/
890 fnet_bool_t fnet_netif_get_ip6_prefix( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_prefix_t *ip6_prefix);
891 
892 /***************************************************************************/
913 fnet_bool_t fnet_netif_get_ip6_neighbor_cache(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_neighbor_cache_t *ip6_neighbor_cache );
914 
915 #endif /* FNET_CFG_IP6 */
916 
917 /***************************************************************************/
932 fnet_scope_id_t fnet_netif_get_scope_id(fnet_netif_desc_t netif_desc);
933 
934 /***************************************************************************/
948 fnet_size_t fnet_netif_get_mtu(fnet_netif_desc_t netif_desc);
949 
950 /***************************************************************************/
968 fnet_netif_desc_t fnet_netif_get_by_scope_id(fnet_scope_id_t scope_id);
969 
970 /***************************************************************************/
989 fnet_netif_desc_t fnet_netif_get_by_sockaddr( const struct fnet_sockaddr *addr );
990 
991 /***************************************************************************/
1017 fnet_return_t fnet_netif_init(fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );
1018 
1019 /***************************************************************************/
1035 void fnet_netif_release(fnet_netif_desc_t netif_desc);
1036 
1037 /***************************************************************************/
1053 fnet_bool_t fnet_netif_is_initialized(fnet_netif_desc_t netif_desc);
1054 
1055 #if defined(__cplusplus)
1056 }
1057 #endif
1058 
1061 #endif /* _FNET_NETIF_H_ */
fnet_netif_get_by_name
fnet_netif_desc_t fnet_netif_get_by_name(const fnet_char_t *name)
Looks for a network interface according to the specified name.
fnet_netif_ip6_addr_info::address
fnet_ip6_addr_t address
IPv6 address.
Definition: fnet_netif.h:130
FNET_NETIF_TYPE_ETHERNET
Ethernet interface.
Definition: fnet_netif.h:49
fnet_netif_ip6_addr_info_t
struct fnet_netif_ip6_addr_info fnet_netif_ip6_addr_info_t
Interface IPv6 address information structure.
fnet_netif_ip6_prefix_t
struct fnet_netif_ip6_prefix fnet_netif_ip6_prefix_t
Interface IPv6 Prefix structure.
fnet_netif_get_scope_id
fnet_scope_id_t fnet_netif_get_scope_id(fnet_netif_desc_t netif_desc)
Retrieves an Scope ID of the specified network interface.
fnet_netif_ip6_neighbor_cache_t
struct fnet_netif_ip6_neighbor_cache fnet_netif_ip6_neighbor_cache_t
Interface IPv6 Neighbor Cache structure.
fnet_netif_get_ip4_addr_type
fnet_netif_ip_addr_type_t fnet_netif_get_ip4_addr_type(fnet_netif_desc_t netif_desc)
Determines the way IPv4 address parameters were obtained.
fnet_netif_ip6_addr_info
Interface IPv6 address information structure.
Definition: fnet_netif.h:128
fnet_netif_ip_addr_type_t
fnet_netif_ip_addr_type_t
Possible IPv6 address types.
Definition: fnet_netif.h:117
fnet_netif_ip6_neighbor_cache
Interface IPv6 Neighbor Cache structure.
Definition: fnet_netif.h:150
fnet_netif_get_default
fnet_netif_desc_t fnet_netif_get_default(void)
Retrieves the default network interface.
fnet_netif_get_ip4_dns
fnet_ip4_addr_t fnet_netif_get_ip4_dns(fnet_netif_desc_t netif_desc)
Retrieves the DNS server IP address of the specified network interface.
fnet_scope_id_t
fnet_uint32_t fnet_scope_id_t
cope zone index type, defining network interface.
Definition: fnet_socket.h:144
fnet_netif_get_ip4_subnet_mask
fnet_ip4_addr_t fnet_netif_get_ip4_subnet_mask(fnet_netif_desc_t netif_desc)
Retrieves a subnet mask of the specified network interface.
fnet_netif_is_initialized
fnet_bool_t fnet_netif_is_initialized(fnet_netif_desc_t netif_desc)
Determines if the network interface is initialized.
fnet_netif_ip6_addr_info::state
fnet_netif_ip6_addr_state_t state
Address current state.
Definition: fnet_netif.h:131
fnet_netif_bind_ip6_addr
fnet_return_t fnet_netif_bind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr, fnet_netif_ip_addr_type_t addr_type)
Binds the IPv6 address to the specified network interface.
fnet_netif_ip6_neighbor_cache::ll_addr
fnet_netif_ll_addr_t ll_addr
Its link-layer address. Actual size is defiined by ll_addr_size.
Definition: fnet_netif.h:153
fnet_netif_ip6_prefix::prefix_length
fnet_size_t prefix_length
Prefix length (in bits). The number of leading bits in the Prefix that are valid. ...
Definition: fnet_netif.h:142
fnet_netif_get_type
fnet_netif_type_t fnet_netif_get_type(fnet_netif_desc_t netif_desc)
Retrieves the type of the specified network interface.
fnet_return_t
fnet_return_t
General return codes, used by most of API functions.
Definition: fnet_stdlib.h:90
fnet_netif_unbind_ip6_addr
fnet_return_t fnet_netif_unbind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr)
Unbinds the IPv6 address from the specified network interface.
fnet_netif_leave_ip6_multicast
void fnet_netif_leave_ip6_multicast(fnet_netif_desc_t netif_desc, fnet_ip6_addr_t *multicast_addr)
Leaves the specified network interface from IPv6 multicast group.
FNET_NETIF_IP6_ADDR_STATE_PREFERRED
Preferred address - (RFC4862) an address assigned to an interface whose use by upper-layer protocols ...
Definition: fnet_netif.h:106
FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE
The address is set using "Auto-IP" link-local autoconfiguration.
Definition: fnet_netif.h:120
fnet_netif_get_ip6_neighbor_cache
fnet_bool_t fnet_netif_get_ip6_neighbor_cache(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_neighbor_cache_t *ip6_neighbor_cache)
Retrieves the n-th IPv6 neighbor cache entry of the specified network interface.
fnet_netif_set_ip4_addr
void fnet_netif_set_ip4_addr(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t ipaddr, fnet_ip4_addr_t subnet_mask)
Sets the IPv4 address of the specified network interface.
fnet_netif_ip6_neighbor_cache::ll_addr_size
fnet_size_t ll_addr_size
Size of link-layer address.
Definition: fnet_netif.h:154
fnet_netif_ip6_prefix::prefix
fnet_ip6_addr_t prefix
Prefix of an IPv6 address.
Definition: fnet_netif.h:141
fnet_size_t
unsigned long fnet_size_t
Unsigned integer type representing the size in bytes.
Definition: fnet_stdlib.h:56
fnet_ip6_addr_t
128-bit IPv6 address type.
Definition: fnet_ip6.h:38
fnet_netif_set_hw_addr
fnet_return_t fnet_netif_set_hw_addr(fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size)
Sets the hardware address of the specified network interface.
fnet_netif_set_default
void fnet_netif_set_default(fnet_netif_desc_t netif_desc)
Assigns the default network interface.
fnet_netif_get_ip6_addr
fnet_bool_t fnet_netif_get_ip6_addr(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_addr_info_t *addr_info)
Retrieves an IPv6 address of the specified network interface.
fnet_netif_get_name
void fnet_netif_get_name(fnet_netif_desc_t netif_desc, fnet_char_t *name, fnet_size_t name_size)
Retrieves a name of the specified network interface.
fnet_netif_statistics::tx_packet
fnet_uint32_t tx_packet
Tx packet count.
Definition: fnet_netif.h:59
fnet_netif_get_ip4_addr
fnet_ip4_addr_t fnet_netif_get_ip4_addr(fnet_netif_desc_t netif_desc)
Retrieves an IPv4 address of the specified network interface.
fnet_netif_init
fnet_return_t fnet_netif_init(fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size)
Initializes network interface and adds it to FNET stack.
fnet_netif_join_ip4_multicast
void fnet_netif_join_ip4_multicast(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr)
Joins the specified network interface to IPv4 multicast group.
fnet_netif_ip6_addr_state_t
fnet_netif_ip6_addr_state_t
Possible IPv6 address states.
Definition: fnet_netif.h:96
fnet_netif_join_ip6_multicast
void fnet_netif_join_ip6_multicast(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *multicast_addr)
Joins the specified network interface to IPv6 multicast group.
fnet_netif_set_ip4_subnet_mask
void fnet_netif_set_ip4_subnet_mask(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t subnet_mask)
Sets the subnet mask of the specified network interface.
fnet_netif_get_by_scope_id
fnet_netif_desc_t fnet_netif_get_by_scope_id(fnet_scope_id_t scope_id)
Looks for a network interface according to the specified Scope ID.
FNET_NETIF_TYPE_LOOPBACK
Loopback interface.
Definition: fnet_netif.h:51
fnet_netif_ip6_prefix
Interface IPv6 Prefix structure.
Definition: fnet_netif.h:139
fnet_netif_clear_ip4_addr_conflict
void fnet_netif_clear_ip4_addr_conflict(fnet_netif_desc_t netif_desc)
Clears IPv4 address conflict flag.
fnet_netif_statistics
Network interface statistics, used by the fnet_netif_get_statistics().
Definition: fnet_netif.h:57
fnet_netif_statistics::rx_packet
fnet_uint32_t rx_packet
Rx packet count.
Definition: fnet_netif.h:60
fnet_netif_get_hw_addr
fnet_return_t fnet_netif_get_hw_addr(fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size)
Retrieves a hardware address of the specified network interface.
FNET_NETIF_IP6_ADDR_STATE_TENTATIVE
Tentative address - (RFC4862) an address whose uniqueness on a link is being verified, prior to its assignment to an interface. A tentative address is not considered assigned to an interface in the usual sense. An interface discards received packets addressed to a tentative address, but accepts Neighbor Discovery packets related to Duplicate Address Detection for the tentative address.
Definition: fnet_netif.h:99
FNET_NETIF_IP_ADDR_TYPE_DHCP
The address is set using DHCP.
Definition: fnet_netif.h:121
fnet_netif_ll_addr_t
fnet_uint8_t fnet_netif_ll_addr_t[FNET_NETIF_LL_ADDR_MAX]
Link-layer address. For example, Ethernet interafce uses the address with size set to 6...
Definition: fnet_netif.h:78
fnet_bool_t
fnet_bool_t
Boolean type.
Definition: fnet_stdlib.h:81
fnet_netif_leave_ip4_multicast
void fnet_netif_leave_ip4_multicast(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr)
Leaves the specified network interface from IPv4 multicast group.
fnet_netif_set_ip4_gateway
void fnet_netif_set_ip4_gateway(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t gw)
Sets the gateway IP address of the specified network interface.
FNET_NETIF_TYPE_WIFI
Wi-Fi interface.
Definition: fnet_netif.h:50
FNET_NETIF_IP6_ADDR_STATE_NOT_USED
Not used.
Definition: fnet_netif.h:98
fnet_netif_set_ip4_dns
void fnet_netif_set_ip4_dns(fnet_netif_desc_t netif_desc, fnet_ip4_addr_t dns)
Sets the DNS server IPv4 address of the specified network interface.
FNET_NETIF_TYPE_OTHER
Unspecified interface.
Definition: fnet_netif.h:48
fnet_netif_get_ip6_dns
fnet_bool_t fnet_netif_get_ip6_dns(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_ip6_addr_t *addr_dns)
Retrieves the n-th DNS IPv6 address of the specified network interface.
fnet_netif_get_by_sockaddr
fnet_netif_desc_t fnet_netif_get_by_sockaddr(const struct fnet_sockaddr *addr)
Looks for a network interface according to the specified socket address.
fnet_netif_get_ip4_gateway
fnet_ip4_addr_t fnet_netif_get_ip4_gateway(fnet_netif_desc_t netif_desc)
Retrieves a gateway IPv4 address of the specified network interface.
fnet_netif_ip6_neighbor_cache::is_router
fnet_bool_t is_router
A flag indicating whether the neighbor is a router (FNET_TRUE) or a host (FNET_FALSE).
Definition: fnet_netif.h:155
fnet_netif_ip6_neighbor_cache::ip_addr
fnet_ip6_addr_t ip_addr
Neighbor�s on-link unicast IP address.
Definition: fnet_netif.h:152
fnet_netif_get_ip6_prefix
fnet_bool_t fnet_netif_get_ip6_prefix(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_prefix_t *ip6_prefix)
Retrieves the n-th IPv6 prefix of the specified network interface.
fnet_index_t
unsigned int fnet_index_t
Unsigned integer type representing the index.
Definition: fnet_stdlib.h:71
fnet_ip4_addr_t
fnet_uint32_t fnet_ip4_addr_t
32-bit IPv4 address type.
Definition: fnet_ip4.h:36
fnet_char_t
char fnet_char_t
Type representing the charecter.
Definition: fnet_stdlib.h:76
fnet_netif_release
void fnet_netif_release(fnet_netif_desc_t netif_desc)
Releases network interface and removes it from FNET stack.
fnet_netif_is_connected
fnet_bool_t fnet_netif_is_connected(fnet_netif_desc_t netif_desc)
Determines the link status of the network interface.
fnet_netif_get_statistics
fnet_return_t fnet_netif_get_statistics(fnet_netif_desc_t netif_desc, struct fnet_netif_statistics *statistics)
Retrieves the network interface statistics.
fnet_netif_get_mtu
fnet_size_t fnet_netif_get_mtu(fnet_netif_desc_t netif_desc)
Retrieves a Maximum Transmission Unit (MTU) of the specified network interface.
fnet_netif_get_by_number
fnet_netif_desc_t fnet_netif_get_by_number(fnet_index_t n)
Looks for a network interface according to its number.
fnet_netif_desc_t
void * fnet_netif_desc_t
Network interface descriptor.
Definition: fnet_netif.h:71
fnet_netif_ip6_addr_info::type
fnet_netif_ip_addr_type_t type
How the address was acquired.
Definition: fnet_netif.h:132
FNET_NETIF_IP_ADDR_TYPE_MANUAL
The address is set manually.
Definition: fnet_netif.h:119
fnet_sockaddr
Socket address structure.
Definition: fnet_socket.h:270
fnet_netif_set_ip4_addr_type
void fnet_netif_set_ip4_addr_type(fnet_netif_desc_t netif_desc, fnet_netif_ip_addr_type_t ipaddr_type)
Sets the way IPv4 address parameters were obtained.
fnet_netif_type_t
fnet_netif_type_t
Network interface types.
Definition: fnet_netif.h:46
fnet_netif_is_ip4_addr_conflict
fnet_bool_t fnet_netif_is_ip4_addr_conflict(fnet_netif_desc_t netif_desc)
Determines if there is IPv4 address conflict.
fnet_netif_get_by_ip4_addr
fnet_netif_desc_t fnet_netif_get_by_ip4_addr(fnet_ip4_addr_t addr)
Looks for a network interface according to the specified IPv4 address.
fnet_netif_set_callback_on_ip4_addr_conflict
void fnet_netif_set_callback_on_ip4_addr_conflict(fnet_netif_callback_ip4_addr_conflict_t callback)
Registers the "IPv4 address conflict" event handler.
fnet_netif_callback_ip4_addr_conflict_t
void(* fnet_netif_callback_ip4_addr_conflict_t)(fnet_netif_desc_t netif)
Event handler callback function prototype, that is called when there is an IP address conflict with a...
Definition: fnet_netif.h:610
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page