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 › net › HostName › connectMany Public Function connectMany Doc Source Public Function std.Io.net.HostName.connectMany
pub fn connectMany (
host_name : HostName ,
io : Io ,
port : u16 ,
results : *Io .Queue (IpAddress .ConnectError !Stream ),
options : IpAddress .ConnectOptions ,
) LookupError !void Params File Io/net/HostName.zig: 358
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389 pub fn connectMany (
host_name : HostName ,
io : Io ,
port : u16 ,
results : *Io .Queue (IpAddress .ConnectError !Stream ),
options : IpAddress .ConnectOptions ,
) LookupError !void {
defer results .close (io );
var canonical_name_buffer : [max_len ]u8 = undefined ;
var lookup_buffer : [32 ]HostName .LookupResult = undefined ;
var lookup_queue : Io .Queue (LookupResult ) = .init (&lookup_buffer );
var lookup_future = io .async (lookup , .{ host_name , io , &lookup_queue , .{
.port = port ,
.canonical_name_buffer = &canonical_name_buffer ,
} });
defer lookup_future .cancel (io ) catch {};
var group : Io .Group = .init ;
defer group .cancel (io );
while (lookup_queue .getOne (io )) |dns_result | switch (dns_result ) {
.address => |address | group .async (io , enqueueConnection , .{ address , io , results , options }),
.canonical_name => continue ,
} else |err | switch (err ) {
error .Canceled => |e | return e ,
error .Closed => {
try group .await (io );
return lookup_future .await (io );
},
}
}
Asynchronously establishes a connection to all IP addresses associated with a host name, adding them to a results queue upon completion.
error.Canceledwill never be added to the queue, but other errors may be.Closes
resultsbefore return, even on error.Asserts
resultsis not closed until this call returns.