NIOPipeBootstrap

public final class NIOPipeBootstrap

A NIOPipeBootstrap is an easy way to bootstrap a PipeChannel which uses two (uni-directional) UNIX pipes and makes a Channel out of them.

Example bootstrapping a Channel using stdin and stdout:

let channel = try NIOPipeBootstrap(group: group)
                  .channelInitializer { channel in
                      channel.pipeline.addHandler(MyChannelHandler())
                  }
                  .withPipes(inputDescriptor: STDIN_FILENO, outputDescriptor: STDOUT_FILENO)


                    
                    
                    init(group:)

Create a NIOPipeBootstrap on the EventLoopGroup group.

Declaration

Swift

public init(group: EventLoopGroup)

Parameters


                                group

The EventLoopGroup to use.

Show on GitHub


                    
                    
                    channelInitializer(_:)

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

The connected Channel will operate on ByteBuffer as inbound and outbound messages. Please note that IOData.fileRegion is not supported for PipeChannels because sendfile only works on sockets.

Declaration

Swift

public func channelInitializer(_ handler: @escaping (Channel) -> EventLoopFuture<Void>) -> Self

Parameters


                                handler

A closure that initializes the provided Channel.

Show on GitHub


                    
                    
                    channelOption(_:value:)

Specifies a ChannelOption to be applied to the PipeChannel.

Declaration

Swift

@inlinable
public func channelOption<Option>(_ option: Option, value: Option.Value) -> Self where Option : ChannelOption

Parameters

`option`	The option to be applied.
`value`	The value for the option.

Show on GitHub


                    
                    
                    withPipes(inputDescriptor:outputDescriptor:)

Create the PipeChannel with the provided input and output file descriptors.

Declaration

Swift

public func withPipes(inputDescriptor: CInt, outputDescriptor: CInt) -> EventLoopFuture<Channel>

Parameters

`inputDescriptor`	The Unix file descriptor for the input (ie. the read side).
`outputDescriptor`	The Unix file descriptor for the output (ie. the write side).

Return Value

an EventLoopFuture<Channel> to deliver the Channel.

Show on GitHub