Zig 0.17.0-dev (Split by item) 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.
std › Io › Threaded › netListenIpWindows Private Function netListenIpWindows Doc Source Private Function std.Io.Threaded.netListenIpWindows
fn netListenIpWindows (
userdata : ?*anyopaque ,
address : *const IpAddress ,
options : IpAddress .ListenOptions ,
) IpAddress .ListenError !net .Socket Params File Io/Threaded.zig: 11996
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024 fn netListenIpWindows (
userdata : ?*anyopaque ,
address : *const IpAddress ,
options : IpAddress .ListenOptions ,
) IpAddress .ListenError !net .Socket {
if (!have_networking ) return error .NetworkDown ;
const t : *Threaded = @ptrCast (@alignCast (userdata ));
_ = t ;
const family = posixAddressFamily (address );
const socket_handle = try openSocketAfd (family , .{ .mode = options .mode , .protocol = options .protocol });
errdefer windows .CloseHandle (socket_handle );
if (options .reuse_address ) try setSocketOptionAfd (socket_handle , ws2_32 .SOL .SOCKET , ws2_32 .SO .REUSEADDR , true );
const bound_address = try bindSocketIpAfd (socket_handle , address , .Passive );
switch ((try deviceIoControl (&.{
.file = .{ .handle = socket_handle , .flags = .{ .nonblocking = true } },
.code = windows .IOCTL .AFD .START_LISTEN ,
.in = @ptrCast (&windows .AFD .LISTEN_INFO {
.UseSAN = .FALSE ,
.MaximumConnectionQueue = options .kernel_backlog ,
.UseDelayedAcceptance = .FALSE ,
}),
})).u .Status ) {
.SUCCESS => {},
.CANCELLED => unreachable ,
.INSUFFICIENT_RESOURCES => return error .SystemResources ,
else => |status | return windows .unexpectedStatus (status ),
}
return .{ .handle = socket_handle , .address = bound_address };
}