NWParameters

includePeerToPeer

get includePeerToPeer(): boolean

final var includePeerToPeer: Bool { get set }

Allow the inclusion of peer-to-peer interfaces when listening or establishing outbound connections. This parameter will not take effect if a specific interface is required. This parameter is applicable when advertising a Bonjour service on a listener, or connecting to a Bonjour service.

includePeerToPeer

set includePeerToPeer(value: boolean)

final var includePeerToPeer: Bool { get set }

Allow the inclusion of peer-to-peer interfaces when listening or establishing outbound connections. This parameter will not take effect if a specific interface is required. This parameter is applicable when advertising a Bonjour service on a listener, or connecting to a Bonjour service.

parameters

get parameters(): NWParameters

final var parameters: NWParameters { get }

The generated NWParameters.

attribution

get attribution(): NWParameters_Attribution

final var attribution: NWParameters.Attribution { get set }

In order to help differentiate communication with domains requested by the user from those requested by the developer, attribution may be used. Attribution defaults to .developer. Setting attribution to .user indicates that the networking performed using these parameters is directed to content specified by the user, not the developer.

attribution

set attribution(value: NWParameters_Attribution)

final var attribution: NWParameters.Attribution { get set }

In order to help differentiate communication with domains requested by the user from those requested by the developer, attribution may be used. Attribution defaults to .developer. Setting attribution to .user indicates that the networking performed using these parameters is directed to content specified by the user, not the developer.

quicDatagram

static quicDatagram(alpn: Array<string>): NWParameters

final class func quicDatagram(alpn: [String]) -> NWParameters

Create a set of parameters for using QUIC datagrams with specified ALPN set

serviceClass

get serviceClass(): NWParameters_ServiceClass

final var serviceClass: NWParameters.ServiceClass { get set }

serviceClass

set serviceClass(value: NWParameters_ServiceClass)

final var serviceClass: NWParameters.ServiceClass { get set }

allowFastOpen

get allowFastOpen(): boolean

final var allowFastOpen: Bool { get set }

Use fast open for an outbound NWConnection, which may be done at any protocol level. Use of fast open requires that the caller send idempotent data on the connection before the connection may move into ready state. As a side effect, this may implicitly enable fast open for protocols in the stack, even if they did not have fast open explicitly enabled on them (such as the option to enable TCP Fast Open).

allowFastOpen

set allowFastOpen(value: boolean)

final var allowFastOpen: Bool { get set }

Use fast open for an outbound NWConnection, which may be done at any protocol level. Use of fast open requires that the caller send idempotent data on the connection before the connection may move into ready state. As a side effect, this may implicitly enable fast open for protocols in the stack, even if they did not have fast open explicitly enabled on them (such as the option to enable TCP Fast Open).

acceptLocalOnly

get acceptLocalOnly(): boolean

final var acceptLocalOnly: Bool { get set }

Cause an NWListener to only advertise services on the local link, and only accept connections from the local link.

acceptLocalOnly

set acceptLocalOnly(value: boolean)

final var acceptLocalOnly: Bool { get set }

Cause an NWListener to only advertise services on the local link, and only accept connections from the local link.

preferNoProxies

get preferNoProxies(): boolean

final var preferNoProxies: Bool { get set }

If true, a direct connection will be attempted first even if proxies are configured. If the direct connection fails, connecting through the proxies will still be attempted.

preferNoProxies

set preferNoProxies(value: boolean)

final var preferNoProxies: Bool { get set }

If true, a direct connection will be attempted first even if proxies are configured. If the direct connection fails, connecting through the proxies will still be attempted.

debugDescription

get debugDescription(): string

final var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

requiredInterface

get requiredInterface(): (NWInterface) | null

final var requiredInterface: NWInterface? { get set }

Require a connection to use a specific interface, or fail if not available

requiredInterface

set requiredInterface(value: (NWInterface) | null)

final var requiredInterface: NWInterface? { get set }

Require a connection to use a specific interface, or fail if not available

setPrivacyContext

setPrivacyContext(privacyContext: NWParameters_PrivacyContext): void

final func setPrivacyContext(_ privacyContext: NWParameters.PrivacyContext)

Set a privacy context on the parameters, which will be associated with connections and listeners. The privacy context allows using separate caches for different sets of connections, as well as restricting how connection-specific information is logged and shared on the network.

applicationService

static get applicationService(): NWParameters

final class var applicationService: NWParameters { get }

Default set of parameters for applicationService

expiredDNSBehavior

get expiredDNSBehavior(): NWParameters_ExpiredDNSBehavior

final var expiredDNSBehavior: NWParameters.ExpiredDNSBehavior { get set }

expiredDNSBehavior

set expiredDNSBehavior(value: NWParameters_ExpiredDNSBehavior)

final var expiredDNSBehavior: NWParameters.ExpiredDNSBehavior { get set }

defaultProtocolStack

get defaultProtocolStack(): NWParameters_ProtocolStack

final var defaultProtocolStack: NWParameters.ProtocolStack { get }

Every NWParameters has a default protocol stack, although it may start out empty.

multipathServiceType

get multipathServiceType(): NWParameters_MultipathServiceType

final var multipathServiceType: NWParameters.MultipathServiceType { get set }

multipathServiceType

set multipathServiceType(value: NWParameters_MultipathServiceType)

final var multipathServiceType: NWParameters.MultipathServiceType { get set }

prohibitedInterfaces

get prohibitedInterfaces(): (Array<NWInterface>) | null

final var prohibitedInterfaces: [NWInterface]? { get set }

Define one or more interfaces that a connection will not be allowed to use

prohibitedInterfaces

set prohibitedInterfaces(value: (Array<NWInterface>) | null)

final var prohibitedInterfaces: [NWInterface]? { get set }

Define one or more interfaces that a connection will not be allowed to use

requiredInterfaceType

get requiredInterfaceType(): NWInterface_InterfaceType

final var requiredInterfaceType: NWInterface.InterfaceType { get set }

Require a connection to use a specific interface type, or fail if not available

requiredInterfaceType

set requiredInterfaceType(value: NWInterface_InterfaceType)

final var requiredInterfaceType: NWInterface.InterfaceType { get set }

Require a connection to use a specific interface type, or fail if not available

requiredLocalEndpoint

get requiredLocalEndpoint(): (NWEndpoint) | null

final var requiredLocalEndpoint: NWEndpoint? { get set }

Force a specific local address to be used. This value is nil by default, in which case the system selects the most appropriate local address and selects a local port.

requiredLocalEndpoint

set requiredLocalEndpoint(value: (NWEndpoint) | null)

final var requiredLocalEndpoint: NWEndpoint? { get set }

Force a specific local address to be used. This value is nil by default, in which case the system selects the most appropriate local address and selects a local port.

prohibitExpensivePaths

get prohibitExpensivePaths(): boolean

final var prohibitExpensivePaths: Bool { get set }

Disallow connection from using interfaces considered expensive

prohibitExpensivePaths

set prohibitExpensivePaths(value: boolean)

final var prohibitExpensivePaths: Bool { get set }

Disallow connection from using interfaces considered expensive

allowLocalEndpointReuse

get allowLocalEndpointReuse(): boolean

final var allowLocalEndpointReuse: Bool { get set }

Allow multiple connections to use the same local address and port (SO_REUSEADDR and SO_REUSEPORT).

allowLocalEndpointReuse

set allowLocalEndpointReuse(value: boolean)

final var allowLocalEndpointReuse: Bool { get set }

Allow multiple connections to use the same local address and port (SO_REUSEADDR and SO_REUSEPORT).

prohibitConstrainedPaths

get prohibitConstrainedPaths(): boolean

final var prohibitConstrainedPaths: Bool { get set }

Disallow connection from using interfaces considered constrained by the system

prohibitConstrainedPaths

set prohibitConstrainedPaths(value: boolean)

final var prohibitConstrainedPaths: Bool { get set }

Disallow connection from using interfaces considered constrained by the system

prohibitedInterfaceTypes

get prohibitedInterfaceTypes(): (Array<NWInterface_InterfaceType>) | null

final var prohibitedInterfaceTypes: [NWInterface.InterfaceType]? { get set }

Define one or more interface types that a connection will not be allowed to use

prohibitedInterfaceTypes

set prohibitedInterfaceTypes(value: (Array<NWInterface_InterfaceType>) | null)

final var prohibitedInterfaceTypes: [NWInterface.InterfaceType]? { get set }

Define one or more interface types that a connection will not be allowed to use

requiresDNSSECValidation

get requiresDNSSECValidation(): boolean

final var requiresDNSSECValidation: Bool { get set }

Require DNSSEC validation when resolving an endpoint before making a connection. DNSSEC validation only takes effect if making a connection to an endpoint that requires domain name resolution, such as: `NWEndpoint.hostPort(host:port:)` `NWEndpoint.url(_:)` 1. If this property is not set or set to false on the parameters, DNSSEC validation will not be required. 2. If this property is set to true and no additional DNSSEC configuration is set on the parameters, the default behavior will be followed: Only DNSSEC secure and DNSSEC insecure resolved result will be used to establish a connection. 3. If this property is set to true and additional DNSSEC configuration is set on the parameters, the behavior specified by that configuration will be followed.

requiresDNSSECValidation

set requiresDNSSECValidation(value: boolean)

final var requiresDNSSECValidation: Bool { get set }

Require DNSSEC validation when resolving an endpoint before making a connection. DNSSEC validation only takes effect if making a connection to an endpoint that requires domain name resolution, such as: `NWEndpoint.hostPort(host:port:)` `NWEndpoint.url(_:)` 1. If this property is not set or set to false on the parameters, DNSSEC validation will not be required. 2. If this property is set to true and no additional DNSSEC configuration is set on the parameters, the default behavior will be followed: Only DNSSEC secure and DNSSEC insecure resolved result will be used to establish a connection. 3. If this property is set to true and additional DNSSEC configuration is set on the parameters, the behavior specified by that configuration will be followed.

allowUltraConstrainedPaths

get allowUltraConstrainedPaths(): boolean

final var allowUltraConstrainedPaths: Bool { get set }

Allow connection to use interfaces considered ultra-constrained by the system

allowUltraConstrainedPaths

set allowUltraConstrainedPaths(value: boolean)

final var allowUltraConstrainedPaths: Bool { get set }

Allow connection to use interfaces considered ultra-constrained by the system

tcp

static get tcp(): NWParameters

final class var tcp: NWParameters { get }

Default set of parameters for TCP This is equivalent to calling init(tls:nil, tcp:NWProtocolTCP.Options())

init

static initTlsTcp(tls?: (NWProtocolTLS_Options) | null, tcp?: NWProtocolTCP_Options): NWParameters

convenience init(tls: NWProtocolTLS.Options?, tcp: NWProtocolTCP.Options = NWProtocolTCP.Options())

Creates a parameters object that is configured for TLS and TCP. The caller can use the default configuration for TLS and TCP, or set specific options for each protocol, or disable TLS. - Parameter tls: TLS options or nil for no TLS - Parameter tcp: TCP options. Defaults to NWProtocolTCP.Options() with no options overridden. - Returns: NWParameters object that can be used for creating a connection or listener

tls

static get tls(): NWParameters

final class var tls: NWParameters { get }

Default set of parameters for TLS over TCP This is equivalent to calling init(tls:NWProtocolTLS.Options(), tcp:NWProtocolTCP.Options())

udp

static get udp(): NWParameters

final class var udp: NWParameters { get }

Default set of parameters for UDP This is equivalent to calling init(dtls:nil, udp:NWProtocolUDP.Options())

copy

copy(): NWParameters

final func copy() -> NWParameters

Perform a deep copy of parameters

init

static initDtlsUdp(dtls?: (NWProtocolTLS_Options) | null, udp?: NWProtocolUDP_Options): NWParameters

convenience init(dtls: NWProtocolTLS.Options?, udp: NWProtocolUDP.Options = NWProtocolUDP.Options())

Creates a parameters object that is configured for DTLS and UDP. The caller can use the default configuration for DTLS and UDP, or set specific options for each protocol, or disable TLS. - Parameter dtls: DTLS options or nil for no DTLS - Parameter udp: UDP options. Defaults to NWProtocolUDP.Options() with no options overridden. - Returns: NWParameters object that can be used for create a connection or listener

dtls

static get dtls(): NWParameters

final class var dtls: NWParameters { get }

Default set of parameters for DTLS over UDP This is equivalent to calling init(dtls:NWProtocolTLS.Options(), udp:NWProtocolUDP.Options())

quic

static quic(alpn: Array<string>): NWParameters

final class func quic(alpn: [String]) -> NWParameters

Default set of parameters for QUIC with specified ALPN set This is equivalent to calling init(quic:NWProtocolQUIC.Options(alpn:alpn))

init

static initQuic(quic: NWProtocolQUIC_Options): NWParameters

convenience init(quic: NWProtocolQUIC.Options)

Creates a parameters object that is configured for using QUIC. The caller can use the default configuration for QUIC, or set specific options. - Parameter quic: QUIC options. - Returns: NWParameters object that can be used for create a connection or listener

init

static init(): NWParameters

init()

Creates a generic NWParameters object. Note that in order to use parameters with a NWConnection or a NetworkListener, the parameters must have protocols added into the defaultProtocolStack. Clients using standard protocol configurations should use init(tls:tcp:) or init(dtls:udp:).