 |
WINC1500 IoT Software APIs
19.5.2
WINC Software API Reference Manual
|
Functions | |
| NMI_API sint16 | sendto (SOCKET sock, void *pvSendBuffer, uint16 u16SendLength, uint16 flags, struct sockaddr *pstrDestAddr, uint8 u8AddrLen) |
Detailed Description
Asynchronous sending function, used to send data on a UDP socket. Called by the application code when there is data required to be sent on a UDP socket handler. The application code is expected to receive data from a successful bounded socket node. The only difference between this function and the similar send function, is the type of socket the data is received on. This function works only with UDP sockets. After the data is sent, the socket callback function registered using registerSocketCallback(), is expected to receive an event of type SOCKET_MSG_SENDTO.
Function Documentation
◆ sendto()
| NMI_API sint16 sendto | ( | SOCKET | sock, |
| void * | pvSendBuffer, | ||
| uint16 | u16SendLength, | ||
| uint16 | flags, | ||
| struct sockaddr * | pstrDestAddr, | ||
| uint8 | u8AddrLen | ||
| ) |
- Parameters
-
[in] sock Socket ID, must hold a non negative value. A negative value will return a socket error SOCK_ERR_INVALID_ARG. Indicating that an invalid argument is passed in. [in] pvSendBuffer Pointer to a buffer holding data to be transmitted. A NULL value will return a socket error SOCK_ERR_INVALID_ARG. Indicating that an invalid argument is passed in. [in] u16SendLength The buffer size in bytes. It must not exceed SOCKET_BUFFER_MAX_LENGTH. [in] flags Not used in the current implementation [in] pstrDestAddr The destination address. [in] u8AddrLen Destination address length in bytes. Not used in the current implementation, only included for BSD compatibility.
- Precondition
- Sockets must be initialized using socketInit.
- Warning
- u16SendLength must not exceed SOCKET_BUFFER_MAX_LENGTH.
Use a valid socket (returned from socket ). A valid buffer pointer must be used (not NULL).
Successful completion of a call to sendto() does not guarantee delivery of the message, A negative return value indicates only locally-detected errors
- Returns
- The function returns SOCK_ERR_NO_ERROR for successful operation and a negative value (indicating the error) otherwise.
Generated on Thu Jan 26 2017 22:15:21 for WINC1500 IoT Software APIs by
1.8.13