XDK API  3.6.0
Documentation
Files | Typedefs | Enumerations | Functions

This module handles the UDP services. More...

+ Collaboration diagram for UDP:

Files

file  XDK_UDP.h
 

Typedefs

typedef enum UDP_Setup_E UDP_Setup_T
 Typedef to represent the UDP setup feature. More...
 

Enumerations

enum  UDP_Setup_E
 Enum to represent the UDP setup features. More...
 

Functions

Retcode_T UDP_Close (int16_t handle)
 This function will delete the local end-point for communication. More...
 
Retcode_T UDP_Enable (void)
 This will enable the UDP communication. More...
 
Retcode_T UDP_Open (int16_t *handle)
 This will create a local end-point for communication It creates a new socket of UDP socket type and provides the handle to the user for further communication. More...
 
Retcode_T UDP_Send (int16_t handle, uint32_t serverIp, uint16_t serverPort, uint8_t *dataPtr, uint32_t dataLen)
 This will send a message to the server. More...
 
Retcode_T UDP_Setup (UDP_Setup_T setup)
 This will setup the UDP communication. More...
 

Detailed Description

Typedef Documentation

typedef enum UDP_Setup_E UDP_Setup_T

Enumeration Type Documentation

Enumerator
UDP_SETUP_USE_CC31XX_LAYER 
UDP_SETUP_USE_SERVALPAL_LAYER 

Function Documentation

Retcode_T UDP_Close ( int16_t  handle)
Parameters
[in]handleHandle to the UDP socket
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T UDP_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • UDP_Setup must have been successful prior.
  • Do not call this API more than once.

+ Here is the caller graph for this function:

Retcode_T UDP_Open ( int16_t *  handle)
Parameters
in/out]handle Handle to the UDP socket. User must provide the memory.
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T UDP_Send ( int16_t  handle,
uint32_t  serverIp,
uint16_t  serverPort,
uint8_t *  dataPtr,
uint32_t  dataLen 
)
Parameters
[in]handleHandle to the UDP socket
[in]serverIpServer IP Address
[in]serverPortServer Port Number
[in]dataPtrPointer to the buffer containing the message to be sent
[in]dataLenLength of the message to be sent
Returns
RETCODE_OK on success, or an error code otherwise.
Note
Irrespective of send success or not, socket needs to be closed from application

+ Here is the caller graph for this function:

Retcode_T UDP_Setup ( UDP_Setup_T  setup)
Parameters
[in]setupPointer to the UDP setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if UDP feature is to be used.
  • Do not call this API more than once.

+ Here is the caller graph for this function:


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:50 by doxygen 1.8.8