HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
hbbtv_sif_network.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2014 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 /* pre-processor mechanism so multiple inclusions don't cause compilation error*/
26 
27 #ifndef _HBBTV_SIF_NETWORK_H
28 
29 #define _HBBTV_SIF_NETWORK_H
30 
31 #include "hbbtv_types.h"
32 
33 
34 /*---Constant and macro definitions for public use-----------------------------*/
35 
36 /*---Enumerations for public use-----------------------------------------------*/
37 
38 /*---Global type defs for public use-------------------------------------------*/
39 
40 typedef enum
41 {
42  HBBTV_NW_STATUS_ACTIVE,
43  HBBTV_NW_STATUS_INACTIVE,
44  HBBTV_NW_STATUS_DISABLED
45 } E_HBBTV_NW_STATUS;
46 
47 typedef struct
48 {
49  void *handle;
50 
56 
57 
58 /*---Global Function prototypes for public use---------------------------------*/
59 
68 E_HBBTV_ERR HBBTV_NWGetStatus(E_HBBTV_NW_STATUS *p_status);
69 
79 E_HBBTV_ERR HBBTV_NWGetInterfaceList(S_HBBTV_NW_INTERFACE **list, U32BIT *num);
80 
88 
98 E_HBBTV_ERR HBBTV_NWGetIpAddress(void *handle, S_HBBTV_STRING *ip);
99 
106 BOOLEAN HBBTV_NWGetEnabled(void *handle);
107 
114 BOOLEAN HBBTV_NWGetConnected(void *handle);
115 
116 #endif /* _HBBTV_SIF_NETWORK_H */
BOOLEAN HBBTV_NWGetEnabled(void *handle)
Retrieves the interface enabled/disabled status.
BOOLEAN HBBTV_NWGetConnected(void *handle)
Retrieves the interface connected/disconnected status.
E_HBBTV_ERR HBBTV_NWGetStatus(E_HBBTV_NW_STATUS *p_status)
Retrieves the current status of the broadband network connection. This MUST be a non-blocking functio...
S_HBBTV_STRING mac
Definition: hbbtv_sif_network.h:54
Definition of general purpose types.
E_HBBTV_ERR HBBTV_NWGetIpAddress(void *handle, S_HBBTV_STRING *ip)
Retrieves a string containing the interface IP address. The HbbTV engine will free the string contain...
Definition: hbbtv_sif_network.h:47
void HBBTV_NWReleaseInterfaceList(S_HBBTV_NW_INTERFACE *list, U32BIT num)
Releases data allocated by HBBTV_NWGetInterfaceList (e.g. String data). Always called immediately aft...
Definition: hbbtv_types.h:167
E_HBBTV_ERR HBBTV_NWGetInterfaceList(S_HBBTV_NW_INTERFACE **list, U32BIT *num)
Retrieves the list of avaiable network interfaces. Provided HBBTV_OK is returned, the HbbTV engine wi...