hbbtv_sif_network.h File Reference

System Interface, Network. More...

#include "hbbtv_types.h"

Go to the source code of this file.

Data Structures
struct	S_HBBTV_NW_INTERFACE

Enumerations
enum	E_HBBTV_NW_STATUS { HBBTV_NW_STATUS_ACTIVE, HBBTV_NW_STATUS_INACTIVE, HBBTV_NW_STATUS_DISABLED }

Functions
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 function, returning results immediately. More...
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 will call HBBTV_NWReleaseInterfaceList to release allocated data on the same task and immediately after it has copied the data. More...
void	HBBTV_NWReleaseInterfaceList (S_HBBTV_NW_INTERFACE *list, U32BIT num)
	Releases data allocated by HBBTV_NWGetInterfaceList (e.g. String data). Always called immediately after the HbbTV engine has copied data. More...
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 contained in the zptr field by calling HBBTV_OSFree. More...
BOOLEAN	HBBTV_NWGetEnabled (void *handle)
	Retrieves the interface enabled/disabled status. More...
BOOLEAN	HBBTV_NWGetConnected (void *handle)
	Retrieves the interface connected/disconnected status. More...

Detailed Description

System Interface, Network.

Date

April 2014

Author

Sergio Panseri

Function Documentation

BOOLEAN HBBTV_NWGetConnected

(

void *

handle

)

Retrieves the interface connected/disconnected status.

Parameters

handle

Handle of the interface as returned in the S_HBBTV_NW_INTERFACE structure by HBBTV_NWGetInterfaceList.

Returns

TRUE if the interface is connected, FALSE if it is disconnected

BOOLEAN HBBTV_NWGetEnabled

(

void *

handle

)

Retrieves the interface enabled/disabled status.

Parameters

handle

Handle of the interface as returned in the S_HBBTV_NW_INTERFACE structure by HBBTV_NWGetInterfaceList.

Returns

TRUE if the interface is enabled, FALSE if it is disabled

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 will call HBBTV_NWReleaseInterfaceList to release allocated data on the same task and immediately after it has copied the data.

Parameters

list	Pointer to the list of pointers
num	Pointer to the number of elements in the returned list

Returns

- HBBTV_OK on success

• HBBTV_ERR_OTHER controlling application specific error

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 contained in the zptr field by calling HBBTV_OSFree.

Parameters

handle	Handle of the interface as returned in the S_HBBTV_NW_INTERFACE structure by HBBTV_NWGetInterfaceList.
ip	String containing the interface's IP address.

Returns

- HBBTV_OK on success

• HBBTV_ERR_OTHER controlling application specific error

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 function, returning results immediately.

Parameters

p_status

Current status of the network connection

Returns

- HBBTV_OK on success

• HBBTV_ERR_BAD_PARAMETER invalid parameter
• HBBTV_ERR_OTHER controlling application specific error

void HBBTV_NWReleaseInterfaceList	(	S_HBBTV_NW_INTERFACE *	list,
		U32BIT	num
	)

Releases data allocated by HBBTV_NWGetInterfaceList (e.g. String data). Always called immediately after the HbbTV engine has copied data.

Parameters

list	list to be released
num	Number of elements in the list