Use the existing connected socket file descriptor.
This declaration has been renamed to ClientBootstrap.withConnectedSocket(_:).
This declaration is deprecated.
func withConnectedSocket(descriptor: CInt) -> EventLoopFuture<any Channel> s8NIOPosix15ClientBootstrapC19withConnectedSocket10descriptor7NIOCore15EventLoopFutureCyAF7Channel_pGs5Int32V_tF What are these?60D39The Unix file descriptor representing the connected stream socket.
an EventLoopFuture<Channel> to deliver the Channel.
import NIOPosixfinal class ClientBootstrapA ClientBootstrap is an easy way to bootstrap a SocketChannel when creating network clients.
func withConnectedSocket(_ socket: NIOBSDSocket.Handle) -> EventLoopFuture<any Channel> Use the existing connected socket file descriptor.
typealias CInt = Int32final class EventLoopFuture<Value>Holder for a result that will be provided later.
protocol Channel : AnyObject, ChannelOutboundInvoker, _NIOPreconcurrencySendableA Channel is easiest thought of as a network socket. But it can be anything that is capable of I/O operations such as read, write, connect, and bind.
convenience init(group: any EventLoopGroup) Create a ClientBootstrap on the EventLoopGroup group.
init?(validatingGroup group: any EventLoopGroup) Create a ClientBootstrap on the EventLoopGroup group, validating that group is compatible.
func bind(to address: SocketAddress) -> ClientBootstrap Bind the SocketChannel to address.
@preconcurrency func channelInitializer(_ handler: @escaping (any Channel) -> EventLoopFuture<Void>) -> Self func channelOption<Option>(_ option: Option, value: Option.Value) -> Self where Option : ChannelOption func connect(host: String, port: Int) -> EventLoopFuture<any Channel> Specify the host and port to connect to for the TCP Channel that will be established.
func connect<Output>(host: String, port: Int, channelInitializer: @escaping (any Channel) -> EventLoopFuture<Output>) async throws -> Output where Output : Sendable Specify the host and port to connect to for the TCP Channel that will be established.
func connect(to address: VsockAddress) -> EventLoopFuture<any Channel> Specify the VSOCK address to connect to for the Channel.
func connect(to address: SocketAddress) -> EventLoopFuture<any Channel> func connect<Output>(to address: SocketAddress, channelInitializer: @escaping (any Channel) -> EventLoopFuture<Output>) async throws -> Output where Output : Sendable Specify the address to connect to for the TCP Channel that will be established.
func connect<Output>(to address: VsockAddress, channelInitializer: @escaping (any Channel) -> EventLoopFuture<Output>) async throws -> Output where Output : Sendable Specify the VSOCK address to connect to for the Channel.
func connect(unixDomainSocketPath: String) -> EventLoopFuture<any Channel> func connect<Output>(unixDomainSocketPath: String, channelInitializer: @escaping (any Channel) -> EventLoopFuture<Output>) async throws -> Output where Output : Sendable Specify the unixDomainSocket path to connect to for the UDS Channel that will be established.
func connectTimeout(_ timeout: TimeAmount) -> Self Specifies a timeout to apply to a connection attempt.
func enableMPTCP(_ value: Bool) -> Self Enables multi-path TCP support.
@preconcurrency func protocolHandlers(_ handlers: @escaping () -> [any ChannelHandler]) -> Self @preconcurrency func resolver(_ resolver: (any Resolver & Sendable)?) -> Self Specifies the Resolver to use or nil if the default should be used.
func withConnectedSocket<Output>(_ socket: NIOBSDSocket.Handle, channelInitializer: @escaping (any Channel) -> EventLoopFuture<Output>) async throws -> Output where Output : Sendable Use the existing connected socket file descriptor.