Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kSocket_ReadFrom | ( | kSocket | socket,
|  | kIpEndPoint * | endPoint,
|  | void * | buffer,
|  | kSize | size,
|  | kSize * | read
| ) |  |

Reads a datagram.

In blocking mode, this function will block until a datagram is read (or a read timeout occurs).

In non-blocking mode, kSocket_Wait should be used to determine when this function can be called successfully.

Parameters

  socket | Socket object.
  endPoint | The address of the sender.
  buffer | Buffer to receive the datagram.
  size | The maximum number of bytes to return.
  read | The number of bytes that were read.

Returns
  Operation status.