Embedded TCP/IP stack: fnet_link.h Source File

FNET

previous page next page
fnet_link.h
1 /**************************************************************************
2 *
3 * Copyright 2016-2017 by Andrey Butok. FNET Community.
4 *
5 ***************************************************************************
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 ***************************************************************************/
20 
21 #ifndef _FNET_LINK_H_
22 #define _FNET_LINK_H_
23 
24 #if FNET_CFG_LINK || defined(__DOXYGEN__)
25 
43 /**************************************************************************/
47 typedef fnet_int32_t fnet_link_desc_t;
48 
49 /**************************************************************************/
61 typedef void(*fnet_link_callback_t)(fnet_netif_desc_t netif, fnet_bool_t connected, void *callback_param);
62 
63 /**************************************************************************/
66 struct fnet_link_params
67 {
68  fnet_netif_desc_t netif_desc;
69  fnet_link_callback_t callback;
70  void *callback_param;
71 };
72 
73 /***************************************************************************/
95 fnet_link_desc_t fnet_link_init( struct fnet_link_params *params );
96 
97 /***************************************************************************/
110 void fnet_link_release(fnet_link_desc_t desc);
111 
112 /***************************************************************************/
127 fnet_bool_t fnet_link_is_enabled(fnet_link_desc_t desc);
128 
129 /***************************************************************************/
147 fnet_link_desc_t fnet_link_get_by_netif(fnet_netif_desc_t netif);
148 
151 #endif /* FNET_CFG_LINK || defined(__DOXYGEN__) */
152 
153 #endif /* _FNET_AUTOIP_H_ */
fnet_link_is_enabled
fnet_bool_t fnet_link_is_enabled(fnet_link_desc_t desc)
Detects if the Link-Detection service is enabled or disabled.
fnet_link_get_by_netif
fnet_link_desc_t fnet_link_get_by_netif(fnet_netif_desc_t netif)
Looks for a Link-Detection service assigned to the specified network interface.
fnet_link_params::callback
fnet_link_callback_t callback
Pointer to the callback function defined by fnet_link_callback_t.
Definition: fnet_link.h:69
fnet_link_callback_t
void(* fnet_link_callback_t)(fnet_netif_desc_t netif, fnet_bool_t connected, void *callback_param)
Link-Detection event handler callback function prototype, which is called when a networking interface...
Definition: fnet_link.h:61
fnet_link_desc_t
fnet_int32_t fnet_link_desc_t
Link-Detection service descriptor.
Definition: fnet_link.h:47
fnet_link_params::callback_param
void * callback_param
Optional application-specific parameter. It's passed to the callback function as input parameter...
Definition: fnet_link.h:70
fnet_link_params
Initialization parameters for the fnet_llmnr_init() function.
Definition: fnet_link.h:66
fnet_link_init
fnet_link_desc_t fnet_link_init(struct fnet_link_params *params)
Initializes the Link-Detection service.
fnet_bool_t
fnet_bool_t
Boolean type.
Definition: fnet_stdlib.h:81
fnet_link_release
void fnet_link_release(fnet_link_desc_t desc)
Releases the Link-Detection service.
fnet_netif_desc_t
void * fnet_netif_desc_t
Network interface descriptor.
Definition: fnet_netif.h:71
fnet_link_params::netif_desc
fnet_netif_desc_t netif_desc
Network interface descriptor to be monitored by the Link-Detection service.
Definition: fnet_link.h:68
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page