DatagramBootstrap

public final class DatagramBootstrap

A DatagramBootstrap is an easy way to bootstrap a DatagramChannel when creating datagram clients and servers.

Example:

    let group = MultiThreadedEventLoopGroup(numberOfThreads: 1)
    defer {
        try! group.syncShutdownGracefully()
    }
    let bootstrap = DatagramBootstrap(group: group)
        // Enable SO_REUSEADDR.
        .channelOption(ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR), value: 1)
        .channelInitializer { channel in
            channel.pipeline.addHandler(MyChannelHandler())
        }
    let channel = try! bootstrap.bind(host: "127.0.0.1", port: 53).wait()
    /* the Channel is now ready to send/receive datagrams */

    try channel.closeFuture.wait()  // Wait until the channel un-binds.

The DatagramChannel will operate on AddressedEnvelope<ByteBuffer> as inbound and outbound messages.


                    
                    
                    init(group:)

Create a DatagramBootstrap on the EventLoopGroup group.

Declaration

Swift

public init(group: EventLoopGroup)

Parameters


                                group

The EventLoopGroup to use.

Show on GitHub


                    
                    
                    channelInitializer(_:)

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

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 DatagramChannel.

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


                    
                    
                    withBoundSocket(descriptor:)

Use the existing bound socket file descriptor.

Declaration

Swift

public func withBoundSocket(descriptor: CInt) -> EventLoopFuture<Channel>

Parameters


                                descriptor

The Unix file descriptor representing the bound datagram socket.

Show on GitHub


                    
                    
                    bind(host:port:)

Bind the DatagramChannel to host and port.

Declaration

Swift

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

Parameters

`host`	The host to bind on.
`port`	The port to bind on.

Show on GitHub


                    
                    
                    bind(to:)

Bind the DatagramChannel to address.

Declaration

Swift

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

Parameters


                                address

The SocketAddress to bind on.

Show on GitHub


                    
                    
                    bind(unixDomainSocketPath:)

Bind the DatagramChannel to a UNIX Domain Socket.

Declaration

Swift

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

Parameters


                                unixDomainSocketPath

The path of the UNIX Domain Socket to bind on. path must not exist, it will be created by the system.

Show on GitHub