Enumerations

The following enumerations are available globally.

  • Endianness refers to the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.

    See more

    Declaration

    Swift

    public enum Endianness
  • Specify what kind of close operation is requested.

    See more

    Declaration

    Swift

    public enum CloseMode
  • SocketOption allows to specify configuration settings that are directly applied to the underlying socket file descriptor.

    Valid options are typically found in the various man pages like man 4 tcp.

    See more

    Declaration

    Swift

    public enum SocketOption : ChannelOption
  • AllocatorOption allows to specify the ByteBufferAllocator to use.

    See more

    Declaration

    Swift

    public enum AllocatorOption : ChannelOption
  • RecvAllocatorOption allows to specify the RecvByteBufferAllocator to use.

    See more

    Declaration

    Swift

    public enum RecvAllocatorOption : ChannelOption
  • AutoReadOption allows to configure if a Channel should automatically call Channel.read again once all data was read from the transport or if the user is responsible to call Channel.read manually.

    See more

    Declaration

    Swift

    public enum AutoReadOption : ChannelOption
  • WriteSpinOption allows users to configure the number of repetitions of a only partially successful write call before considering the Channel not writable. Setting this option to 0 means that we only issue one write call and if that call does not write all the bytes, we consider the Channel not writable.

    See more

    Declaration

    Swift

    public enum WriteSpinOption : ChannelOption
  • MaxMessagesPerReadOption allows to configure the maximum number of read calls to the underlying transport are performed before wait again until there is more to read and be notified.

    See more

    Declaration

    Swift

    public enum MaxMessagesPerReadOption : ChannelOption
  • BacklogOption allows to configure the backlog value as specified in man 2 listen. This is only useful for ServerSocketChannels.

    See more

    Declaration

    Swift

    public enum BacklogOption : ChannelOption
  • WriteBufferWaterMarkOption allows to configure when a Channel should be marked as writable or not. Once the amount of bytes queued in a Channels outbound buffer is larger than WriteBufferWaterMark.high the channel will be marked as non-writable and so Channel.isWritable will return false. Once we were able to write some data out of the outbound buffer and the amount of bytes queued falls below WriteBufferWaterMark.low the Channel will become writable again. Once this happens Channel.writable will return true again. These writability changes are also propagated through the ChannelPipeline and so can be intercepted via ChannelInboundHandler.channelWritabilityChanged.

    See more

    Declaration

    Swift

    public enum WriteBufferWaterMarkOption : ChannelOption
  • ConnectTimeoutOption allows to configure the TimeAmount after which a connect will fail if it was not established in the meantime. May be nil, in which case the connection attempt will never time out.

    See more

    Declaration

    Swift

    public enum ConnectTimeoutOption : ChannelOption
  • AllowRemoteHalfClosureOption allows users to configure whether the Channel will close itself when its remote peer shuts down its send stream, or whether it will remain open. If set to false (the default), the Channel will be closed automatically if the remote peer shuts down its send stream. If set to true, the Channel will not be closed: instead, a ChannelEvent.inboundClosed user event will be sent on the ChannelPipeline, and no more data will be received.

    See more

    Declaration

    Swift

    public enum AllowRemoteHalfClosureOption : ChannelOption
  • State of the current decoding process.

    See more

    Declaration

    Swift

    public enum DecodingState
  • Different Errors that are specific to EventLoop operations / implementations.

    See more

    Declaration

    Swift

    public enum EventLoopError : Error
  • An result for an IO operation that was done on a non-blocking resource.

    See more

    Declaration

    Swift

    public enum IOResult<T> where T : Equatable
  • The IO for which we want to be notified.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "IOEvent was made public by accident, is no longer used internally and will be removed with SwiftNIO 2.0.0")
    public enum IOEvent
  • Undocumented

    See more

    Declaration

    Swift

    public enum SocketAddressError : Error
  • Represent a socket address to which we may want to connect or bind.

    See more

    Declaration

    Swift

    public enum SocketAddress : CustomStringConvertible