View on GitHub
Install in Dash
DatagramBootstrap Class Reference
DatagramBootstrap
public final class DatagramBootstrapA 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.socketOption(.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.
-
Create a
DatagramBootstrapon theEventLoopGroupgroup.The
EventLoopGroupgroupmust be compatible, otherwise the program will crash.DatagramBootstrapis compatible only withMultiThreadedEventLoopGroupas well as theEventLoops returned byMultiThreadedEventLoopGroup.next. Seeinit(validatingGroup:)for a fallible initializer for situations where it’s impossible to tell ahead of time if theEventLoopGroupis compatible or not.Declaration
Swift
public convenience init(group: EventLoopGroup)Parameters
groupThe
EventLoopGroupto use. -
Create a
DatagramBootstrapon theEventLoopGroupgroup, validating thatgroupis compatible.Declaration
Swift
public init?(validatingGroup group: EventLoopGroup)Parameters
groupThe
EventLoopGroupto use. -
Initialize the bound
DatagramChannelwithinitializer. The most common task in initializer is to addChannelHandlers to theChannelPipeline.Declaration
Swift
public func channelInitializer(_ handler: @escaping (Channel) -> EventLoopFuture<Void>) -> SelfParameters
handlerA closure that initializes the provided
Channel. -
Specifies a
ChannelOptionto be applied to theDatagramChannel.Declaration
Swift
@inlinable public func channelOption<Option>(_ option: Option, value: Option.Value) -> Self where Option : ChannelOptionParameters
optionThe option to be applied.
valueThe value for the option.
-
Use the existing bound socket file descriptor.
Declaration
Swift
@available(*, deprecated, renamed: "withBoundSocket(_:﹚") public func withBoundSocket(descriptor: CInt) -> EventLoopFuture<Channel>Parameters
descriptorThe Unix file descriptor representing the bound datagram socket.
-
Use the existing bound socket file descriptor.
Declaration
Swift
public func withBoundSocket(_ socket: NIOBSDSocket.Handle) -> EventLoopFuture<Channel>Parameters
descriptorThe Unix file descriptor representing the bound datagram socket.
-
Bind the
DatagramChanneltohostandport.Declaration
Swift
public func bind(host: String, port: Int) -> EventLoopFuture<Channel>Parameters
hostThe host to bind on.
portThe port to bind on.
-
Bind the
DatagramChanneltoaddress.Declaration
Swift
public func bind(to address: SocketAddress) -> EventLoopFuture<Channel>Parameters
addressThe
SocketAddressto bind on. -
Bind the
DatagramChannelto a UNIX Domain Socket.Declaration
Swift
public func bind(unixDomainSocketPath: String) -> EventLoopFuture<Channel>Parameters
unixDomainSocketPathThe path of the UNIX Domain Socket to bind on.
pathmust not exist, it will be created by the system. -
Bind the
DatagramChannelto a UNIX Domain Socket.Declaration
Swift
public func bind(unixDomainSocketPath: String, cleanupExistingSocketFile: Bool) -> EventLoopFuture<Channel>Parameters
unixDomainSocketPathThe path of the UNIX Domain Socket to bind on.
pathmust not exist, it will be created by the system.cleanupExistingSocketFileWhether to cleanup an existing socket file at
path.