XDK API  3.6.0
Documentation
Files | Data Structures | Macros | Typedefs | Functions

Interface header for network interfaces. More...

+ Collaboration diagram for NetIF:

Files

file  BCDS_NetIF.h
 

Data Structures

struct  ServalPalOps_S
 Table entry element which contains the network interface specific implementation of the below mentioned protocols. More...
 

Macros

#define NETIF_ALL   (UINT8_MAX - 1)
 
#define NETIF_C(x)   x
 
#define NETIF_INVALID   UINT8_MAX
 

Typedefs

typedef uint8_t NetIF_Id_T
 
typedef struct ServalPalOps_S ServalPalOps_T
 
typedef struct ServalPalOps_Tcp_S ServalPalOps_Tcp_T
 
typedef struct ServalPalOps_Udp_S ServalPalOps_Udp_T
 

Functions

uint8_t NetIf_NumNetIf (void)
 Retrieve the number of registered network interfaces. More...
 
void NetIf_OpsDeInit (void)
 Deinitialized the network operations lookup table. More...
 
Retcode_T NetIf_OpsInit (const ServalPalOps_T *OpsTable, uint8_t OpsTableLength)
 Initializes the network operations lookup table. More...
 
bool NetIf_OpsIsInit (void)
 Checks if module is initialized. More...
 

Detailed Description

Implements a table about all available network interfaces and their specific ServalPAL implementations.


Data Structure Documentation

struct ServalPalOps_S

Data Fields

const ServalPalOps_Tcp_TTcpOps
 
const ServalPalOps_Udp_TUdpOps
 

Field Documentation

const ServalPalOps_Tcp_T* TcpOps

TCP implementation

const ServalPalOps_Udp_T* UdpOps

UDP implementation

Macro Definition Documentation

#define NETIF_ALL   (UINT8_MAX - 1)
#define NETIF_C (   x)    x

network interface literal type

#define NETIF_INVALID   UINT8_MAX

network interface literal type

Typedef Documentation

typedef uint8_t NetIF_Id_T
typedef struct ServalPalOps_Tcp_S ServalPalOps_Tcp_T
typedef struct ServalPalOps_Udp_S ServalPalOps_Udp_T

Function Documentation

uint8_t NetIf_NumNetIf ( void  )
Returns
number of registered network interface
void NetIf_OpsDeInit ( void  )
Retcode_T NetIf_OpsInit ( const ServalPalOps_T OpsTable,
uint8_t  OpsTableLength 
)
Note
This method does not copy the OpsTable but only stores the pointer to it, hence the OpsTable should not be allocated on the stack.
Parameters
[in]OpsTablepointer to an array of virtual functions
OpsTableLengthnumber of items in `OpsTable'
Returns
RETCODE_OK initialization of lookup table was successful
RETCODE_NULL_POINTER OpsTable is NULL
RETCODE_INVALID_PARAM invalid OpsTableLength has been passed
bool NetIf_OpsIsInit ( void  )
Returns
#True - Ops table is initialized
#False - Ops table is not initialized

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:52 by doxygen 1.8.8