Instance Propertyswift-nio 2.84.0NIOCore
protocolFamily
SocketAddresses.swift:171This declaration has been renamed to SocketAddress.protocol.
This declaration is deprecated.
var protocolFamily: Int32 { get }This declaration has been renamed to SocketAddress.protocol.
This declaration is deprecated.
var protocolFamily: Int32 { get }import NIOCoreThe core abstractions that make up SwiftNIO.
enum SocketAddressRepresent a socket address to which we may want to connect or bind.
var `protocol`: NIOBSDSocket.ProtocolFamily { get }Returns the protocol family as defined in man 2 socket of this SocketAddress.
@frozen struct Int32A 32-bit signed integer value type.
init(_ addr: sockaddr_in) Creates a new IPv4 SocketAddress.
init(_ addr: sockaddr_un) Creates a new Unix Domain Socket SocketAddress.
init(_ addr: sockaddr_in6) Creates a new IPv6 SocketAddress.
init(_ addr: sockaddr_in, host: String) Creates a new IPv4 SocketAddress.
init(_ addr: sockaddr_in6, host: String) Creates a new IPv6 SocketAddress.
init(ipAddress: String, port: Int) throws Create a new SocketAddress for an IP address in string form.
init(packedIPAddress: ByteBuffer, port: Int) throws Create a new SocketAddress for an IP address in ByteBuffer form.
init(unixDomainSocketPath: String) throws Creates a new UDS SocketAddress.
static func makeAddressResolvingHost(_ host: String, port: Int) throws -> SocketAddress Creates a new SocketAddress for the given host (which will be resolved) and port.
var description: String { get }A human-readable description of this SocketAddress. Mostly useful for logging.
var ipAddress: String? { get }Get the IP address as a string
var isMulticast: Bool { get }Whether this SocketAddress corresponds to a multicast address.
var pathname: String? { get }Get the pathname of a UNIX domain socket as a string
var port: Int? { get set }Get and set the port associated with the address, if defined. When setting to nil the port will default to 0 for compatible sockets. The rationale for this is that both nil and 0 can be interpreted as “no preference”. Setting a non-nil value for a unix domain socket is invalid and will result in a fatal error.
static func == (lhs: SocketAddress, rhs: SocketAddress) -> Bool func hash(into hasher: inout Hasher) func withSockAddr<T>(_ body: (UnsafePointer<sockaddr>, Int) throws -> T) rethrows -> T Calls the given function with a pointer to a sockaddr structure and the associated size of that structure.
struct IPv4AddressA single IPv4 address for SocketAddress.
struct IPv6AddressA single IPv6 address for SocketAddress.
struct UnixSocketAddressA single Unix socket address for SocketAddress.