XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Enumerations | Functions | Variables
ServalPalWiFI

Interface file for Serval PAL Wifi module. More...

+ Collaboration diagram for ServalPalWiFI:

Files

file  BCDS_ServalPalWiFi.h
 

Data Structures

struct  ServalPalWiFi_StateChangeInfo_S
 

Typedefs

typedef enum ServalPalWiFi_Event_E ServalPalWiFi_Event_T
 Typedef to represent the WiFi event that the PAL needs to be notified. More...
 
typedef int16_t ServalPalWiFi_SocketHandler_T
 Typedef to represent the WiFi socket handle. More...
 
typedef enum ServalPalWiFi_State_E ServalPalWiFi_State_T
 Typedef to represent the WiFi state that the PAL needs to be notified. More...
 
typedef struct
ServalPalWiFi_StateChangeInfo_S 
ServalPalWiFi_StateChangeInfo_T
 

Enumerations

enum  ServalPalWiFi_Event_E
 Enumeration to represent the WiFi events that the PAL needs to be notified. More...
 
enum  ServalPalWiFi_State_E
 Enumeration to represent the WiFi states that the PAL needs to be notified. More...
 

Functions

Retcode_T ServalPalWiFi_Init (void)
 This function initializes TCP and UDP communication via WiFi. More...
 
Retcode_T ServalPalWiFi_NotifyWiFiEvent (ServalPalWiFi_Event_T callbackEvent, void *eventData)
 This function acts as a notify call for the WiFi events. Based on the events received, the event data is made use in PAL. More...
 

Variables

const ServalPalOps_Tcp_TServalPalOps_TcpWiFi
 
const ServalPalOps_Udp_TServalPalOps_UdpWiFi
 

Detailed Description


Data Structure Documentation

struct ServalPalWiFi_StateChangeInfo_S

Data Fields

ServalPalWiFi_SocketHandler_T socketHandler
 
ServalPalWiFi_State_T state
 

Field Documentation

WiFi socket handle

WiFi state

Typedef Documentation

Enumeration Type Documentation

Enumerator
SERVALPALWIFI_CONNECTED 

When the WiFi network is connected

SERVALPALWIFI_DISCONNECTED 

When the WiFi network is disconnected

SERVALPALWIFI_STATE_CHANGE 

When the WiFi state is changed

SERVALPALWIFI_SOCKET_SERVICE 

When the WiFi socket needs to be serviced.

SERVALPALWIFI_DATA_RECEIVED 

When the WiFi has received data

SERVALPALWIFI_EVENT_MAX 

Defines boundary of WiFi events

Enumerator
SERVALPALWIFI_CLOSED 

closed

SERVALPALWIFI_CONNECTING 

connecting

SERVALPALWIFI_OPEN 

open

SERVALPALWIFI_HALF_CLOSED 

closed

SERVALPALWIFI_HALF_OPEN 

half open

SERVALPALWIFI_CLOSING 

closing

SERVALPALWIFI_STATE_MAX 

Defines boundary of WiFi states

Function Documentation

Retcode_T ServalPalWiFi_Init ( void  )
Returns
RETCODE_OK initialization of Wifi has been successful
RETCODE_OUT_OF_RESOURCES Mutex creation has been failed

+ Here is the caller graph for this function:

Retcode_T ServalPalWiFi_NotifyWiFiEvent ( ServalPalWiFi_Event_T  callbackEvent,
void *  eventData 
)
Parameters
[in]callbackEvent- event received from WiFi
[in]eventData- data based on the event that is being notified
| callbackEvent | eventData type |
  • ------------------------------------------------------------—

    | SERVALPALWIFI_CONNECTED | Unused |

| SERVALPALWIFI_DISCONNECTED | Unused |

| SERVALPALWIFI_STATE_CHANGE | ServalPalWiFi_StateChangeInfo_T |

| SERVALPALWIFI_SOCKET_SERVICE | ServalPalWiFi_SocketHandler_T |

| SERVALPALWIFI_DATA_RECEIVED | ServalPalWiFi_SocketHandler_T |

See also
ServalPalWiFi_Event_T, ServalPalWiFi_StateChangeInfo_T, ServalPalWiFi_SocketHandler_T
Returns
RETCODE_OK Event notification has been successful
RETCODE_INVALID_PARAM invalid input parameter has been passed
RETCODE_UNEXPECTED_BEHAVIOR Invalid socket state

+ Here is the caller graph for this function:

Variable Documentation

const ServalPalOps_Tcp_T* ServalPalOps_TcpWiFi

the predefined table of TCP methods for WiFi

const ServalPalOps_Udp_T* ServalPalOps_UdpWiFi

the predefined table of UDP methods for WiFi


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