Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kUdpClient_ReceiveEx | ( | kUdpClient | client,
|  | kIpEndPoint * | endPoint,
|  | kSize * | received,
|  | k64u | timeout,
|  | kSize * | adapterId
| ) |  |

Blocks until a datagram is received into kUdpClient's read buffer (or until a timeout occurs).

The Receive method is used to receive a datagram into kUdpClient's internal read buffer. Once the datagram has been received, the kStream_Read method can be used to read out the datagram.

The kNetworkInfo_FindAdapterById method can be used to translate the unique numeric adapter identifier provided by this method to a network adapter name.

Parameters

  client | UDP client object.
  endPoint | Receives the end point of the sender.
  received | Receives the size of the received datagram.
  timeout | Timeout, in microseconds.
  adapterId | Receives the unique numeric identifier associated with the local network adapter on which the datagram was received (or kSIZE_NULL, if unknown).

Returns
  Operation status.

See also
  kNetworkInfo_FindAdapterById, kNetworkAdapter_Id