bind(unixDomainSocketPath:cleanupExistingSocketFile:)

Other members in extension

Type members

• init(group: EventLoopGroup)

  Create a ServerBootstrap on the EventLoopGroup group.

• init(group: EventLoopGroup, childGroup: EventLoopGroup)

  Create a ServerBootstrap on the EventLoopGroup group which accepts Channels on childGroup.

• init?(validatingGroup: EventLoopGroup, childGroup: EventLoopGroup?)

  Create a ServerBootstrap on the EventLoopGroup group which accepts Channels on childGroup, validating that the EventLoopGroups are compatible with ServerBootstrap.

Instance members

• func bind<Output>(NIOBSDSocket.Handle, cleanupExistingSocketFile: Bool, serverBackPressureStrategy: NIOAsyncSequenceProducerBackPressureStrategies.HighLowWatermark?, childChannelInitializer: @escaping (Channel) -> EventLoopFuture<Output>) async throws -> NIOAsyncChannel<Output, Never>

  Use the existing bound socket file descriptor.

• func bind(host: String, port: Int) -> EventLoopFuture<Channel>

  Bind the ServerSocketChannel to host and port.

• func bind<Output>(host: String, port: Int, serverBackPressureStrategy: NIOAsyncSequenceProducerBackPressureStrategies.HighLowWatermark?, childChannelInitializer: @escaping (Channel) -> EventLoopFuture<Output>) async throws -> NIOAsyncChannel<Output, Never>

  Bind the ServerSocketChannel to the host and port parameters.

• func bind(to: VsockAddress) -> EventLoopFuture<Channel>

  Bind the ServerSocketChannel to a VSOCK socket.

• func bind(to: SocketAddress) -> EventLoopFuture<Channel>

  Bind the ServerSocketChannel to address.

• func bind<Output>(to: VsockAddress, serverBackPressureStrategy: NIOAsyncSequenceProducerBackPressureStrategies.HighLowWatermark?, childChannelInitializer: @escaping (Channel) -> EventLoopFuture<Output>) async throws -> NIOAsyncChannel<Output, Never>

  Bind the ServerSocketChannel to a VSOCK socket.

• func bind<Output>(to: SocketAddress, serverBackPressureStrategy: NIOAsyncSequenceProducerBackPressureStrategies.HighLowWatermark?, childChannelInitializer: @escaping (Channel) -> EventLoopFuture<Output>) async throws -> NIOAsyncChannel<Output, Never>

  Bind the ServerSocketChannel to the address parameter.

• func bind(unixDomainSocketPath: String) -> EventLoopFuture<Channel>

  Bind the ServerSocketChannel to a UNIX Domain Socket.

• func bind<Output>(unixDomainSocketPath: String, cleanupExistingSocketFile: Bool, serverBackPressureStrategy: NIOAsyncSequenceProducerBackPressureStrategies.HighLowWatermark?, childChannelInitializer: @escaping (Channel) -> EventLoopFuture<Output>) async throws -> NIOAsyncChannel<Output, Never>

  Bind the ServerSocketChannel to a UNIX Domain Socket.

• func bindTimeout(TimeAmount) -> Self

  Specifies a timeout to apply to a bind attempt. Currently unsupported.

• func childChannelInitializer(@escaping (Channel) -> EventLoopFuture<Void>) -> Self

  Initialize the accepted SocketChannels with initializer. The most common task in initializer is to add ChannelHandlers to the ChannelPipeline. Note that if the initializer fails then the error will be fired in the parent channel.

• func childChannelOption<Option>(Option, value: Option.Value) -> Self

  Specifies a ChannelOption to be applied to the accepted SocketChannels.

• func enableMPTCP(Bool) -> Self

  Enables multi-path TCP support.

• func serverChannelInitializer(@escaping (Channel) -> EventLoopFuture<Void>) -> Self

  Initialize the ServerSocketChannel with initializer. The most common task in initializer is to add ChannelHandlers to the ChannelPipeline.

• func serverChannelOption<Option>(Option, value: Option.Value) -> Self

  Specifies a ChannelOption to be applied to the ServerSocketChannel.

• func withBoundSocket(NIOBSDSocket.Handle) -> EventLoopFuture<Channel>

  Use the existing bound socket file descriptor.