View on GitHub
Install in Dash
NIOClientTCPBootstrapProtocol Protocol Reference
NIOClientTCPBootstrapProtocol
public protocol NIOClientTCPBootstrapProtocolNIOClientTCPBootstrapProtocol is implemented by various underlying transport mechanisms. Typically,
this will be the BSD Sockets API implemented by ClientBootstrap.
-
Initialize the connected
SocketChannelwithinitializer. The most common task in initializer is to addChannelHandlers to theChannelPipeline.The connected
Channelwill operate onByteBufferas inbound andIODataas outbound messages.Warning
The
handlerclosure may be invoked multiple times so it’s usually the right choice to instantiateChannelHandlers withinhandler. The reasonhandlermay be invoked multiple times is that to successfully set up a connection multiple connections might be setup in the process. Assuming a hostname that resolves to both IPv4 and IPv6 addresses, NIO will follow Happy Eyeballs and race both an IPv4 and an IPv6 connection. It is possible that both connections get fully established before the IPv4 connection will be closed again because the IPv6 connection ‘won the race’. Therefore thechannelInitializermight be called multiple times and it’s important not to share statefulChannelHandlers in more than oneChannel.Declaration
Swift
func channelInitializer(_ handler: @escaping (Channel) -> EventLoopFuture<Void>) -> SelfParameters
handlerA closure that initializes the provided
Channel. -
Sets the protocol handlers that will be added to the front of the
ChannelPipelineright after thechannelInitializerhas been called.Per bootstrap, you can only set the
protocolHandlersonce. Typically,protocolHandlersare used for the TLS implementation. Most notably,NIOClientTCPBootstrap, NIO’s “universal bootstrap” abstraction, usesprotocolHandlersto add the requiredChannelHandlers for many TLS implementations.Declaration
Swift
func protocolHandlers(_ handlers: @escaping () -> [ChannelHandler]) -> Self -
Specifies a
ChannelOptionto be applied to theSocketChannel.Declaration
Swift
func channelOption<Option>(_ option: Option, value: Option.Value) -> Self where Option : ChannelOptionParameters
optionThe option to be applied.
valueThe value for the option.
-
Declaration
Swift
func connectTimeout(_ timeout: TimeAmount) -> SelfParameters
timeoutThe timeout that will apply to the connection attempt.
-
Specify the
hostandportto connect to for the TCPChannelthat will be established.Declaration
Swift
func connect(host: String, port: Int) -> EventLoopFuture<Channel>Parameters
hostThe host to connect to.
portThe port to connect to.
Return Value
An
EventLoopFuture<Channel>to deliver theChannelwhen connected. -
Specify the
addressto connect to for the TCPChannelthat will be established.Declaration
Swift
func connect(to address: SocketAddress) -> EventLoopFuture<Channel>Parameters
addressThe address to connect to.
Return Value
An
EventLoopFuture<Channel>to deliver theChannelwhen connected. -
Specify the
unixDomainSocketpath to connect to for the UDSChannelthat will be established.Declaration
Swift
func connect(unixDomainSocketPath: String) -> EventLoopFuture<Channel>Parameters
unixDomainSocketPathThe Unix domain socket path to connect to.
Return Value
An
EventLoopFuture<Channel>to deliver theChannelwhen connected.