Required Instance Propertyswift-nio 2.72.0NIOCore
syncOptions
Returns a view of the Channel
exposing synchronous versions of setOption
and getOption
. The default implementation returns nil
, and Channel
implementations must opt in to support this behavior.
var syncOptions: NIOSynchronousChannelOptions? { get }
Other requirements
View members
Hide members
This section is hidden by default because it contains too many (11) members.
Instance members
var allocator: ByteBufferAllocator
The
Channel
’sByteBuffer
allocator. This is the only supported way of allocatingByteBuffer
s to be used with thisChannel
.var closeFuture: EventLoopFuture<Void>
The
closeFuture
will fire when theChannel
has been closed.var isActive: Bool
Returns if this
Channel
is currently active. Active is defined as the period of time after thechannelActive
and beforechannelInactive
has fired. The main use for this is to know ifchannelActive
orchannelInactive
can be expected next whenhandlerAdded
was received.var isWritable: Bool
Returns if this
Channel
is currently writable.var localAddress: SocketAddress?
The local
SocketAddress
.var parent: Channel?
Channel
s are hierarchical and might have a parentChannel
.Channel
hierarchies are in use for certain protocols such as HTTP/2.var pipeline: ChannelPipeline
The
ChannelPipeline
which handles all I/O events and requests associated with thisChannel
.var remoteAddress: SocketAddress?
The remote peer’s
SocketAddress
.func getOption<Option>(Option
) -> EventLoopFuture<Option.Value> Get the value of
option
for thisChannel
.func setOption<Option>(Option, value: Option.Value
) -> EventLoopFuture<Void> Set
option
tovalue
on thisChannel
.
Show implementation details (1)
Hide implementation details
var _channelCore: ChannelCore
Reach out to the
_ChannelCore
.
Citizens in NIOCore
Default implementations
var syncOptions: NIOSynchronousChannelOptions?
Default implementation:
NIOSynchronousChannelOptions
are not supported.