Zig 0.17.0-dev (Split by item)

?

× Shortcut keys

?: Show these tips

S: Focus search field

Esc: Clear focus & close tips

U: Jump to source code

↑: Move up in search results

↓: Move down in search results

↵: Go to active search result

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function

sendTimeout

Doc Source

Public Function

std.Io.net.Socket.sendTimeout

pub fn sendTimeout(
        s: *const Socket,
        io: Io,
        dest: *const IpAddress,
        data: []const u8,
        timeout: Io.Timeout,
    ) SendTimeoutError!void

Params

s: *const Socket
io: Io
dest: *const IpAddress
data: []const u8
timeout: Io.Timeout

File

Io/net.zig:1112

    pub fn sendTimeout(
        s: *const Socket,
        io: Io,
        dest: *const IpAddress,
        data: []const u8,
        timeout: Io.Timeout,
    ) SendTimeoutError!void {
        var message: OutgoingMessage = .{ .address = dest, .data_ptr = data.ptr, .data_len = data.len };
        const maybe_err, const count = (try io.operateTimeout(.{ .net_send = .{
            .socket_handle = s.handle,
            .messages = (&message)[0..1],
            .flags = .{},
        } }, timeout)).net_send;
        if (maybe_err) |err| return err;
        assert(1 == count);
        if (message.data_len != data.len) return error.MessageOversize;
    }