Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kUdpClient_Send | ( | kUdpClient | client,
|  | kIpAddress | address,
|  | k32u | port,
|  | k64u | timeout,
|  | kBool | clear
| ) |  |

Blocks until the datagram in kUdpClient's internal write buffer is written to the underlying socket (or until a timeout occurs).

The Send method is used to send a datagram that has been written into kUdpClient's internal write buffer. Bytes are written into kUdpClient's internal buffer via the kStream_Write method.

The 'clear' argument determines whether the internal write buffer is reset after sending the message, or whether it retains the datagram for subsequent retransmission.

Parameters

  client | UDP client object.
  address | IP address of the recipient.
  port | Port number of the recipient.
  timeout | Timeout, in microseconds.
  clear | Specifies whether the internal write buffer pointer is updated.

Returns
  Operation status.