Type Alias

nw_parameters_t

An object that stores the protocols to use for connections, options for sending data, and network path constraints.

Declaration

typedef NSObject<OS_nw_parameters> *nw_parameters_t;

Topics

Creating Parameters

nw_parameters_create_secure_tcp

Initializes parameters for TLS or TCP connections and listeners.

nw_parameters_create_secure_udp

Initializes parameters for DTLS or UDP connections and listeners.

nw_parameters_configure_protocol_block_t

A block to configure protocol options during the creation of a parameters object.

nw_parameters_create

Initializes parameters for connections, listeners, and browsers with no protocols specified.

nw_parameters_create_custom_ip

Initializes parameters for connections and listeners using a custom IP protocol.

nw_parameters_copy

Peforms a deep copy of a parameters object.

Modifying Protocol Stacks

nw_parameters_copy_default_protocol_stack

Accesses the protocol stack used by connections and listeners.

nw_protocol_stack_t

An ordered set of protocol options that define the protocols that connections and listeners use.

nw_protocol_definition_t

The abstract superclass for identifying a network protocol.

nw_protocol_options_t

The abstract superclass for configuring the options of a network protocol.

Selecting Paths

nw_parameters_set_required_interface_type

Sets an interface type to require on connections and listeners.

nw_parameters_get_required_interface_type

Accesses the interface type required on connections and listeners.

nw_parameters_require_interface

Sets a specific interface to require on connections, listeners, and browsers.

nw_parameters_copy_required_interface

Accesses the interface required on connections, listeners, and browsers.

nw_parameters_set_local_endpoint

Sets a specific local IP address and port to use for connections and listeners.

nw_parameters_copy_local_endpoint

Accesses the local IP address and port used for connections and listeners.

nw_parameters_set_prohibit_constrained

Prevents connections, listeners, and browsers from using network paths marked as constrained by Low Data Mode.

nw_parameters_get_prohibit_constrained

Checks if connections, listeners, and browsers are prevented from using network paths marked as constrained by Low Data Mode.

nw_parameters_set_prohibit_expensive

Prevents connections, listeners, and browsers from using network paths marked as expensive.

nw_parameters_get_prohibit_expensive

Checks if connections, listeners, and browsers are prevented from using network paths marked as expensive.

nw_parameters_prohibit_interface_type

Prevents connections, listeners, and browsers from using a specific interface type.

nw_parameters_clear_prohibited_interface_types

Removes all prohibited interface types.

nw_parameters_iterate_prohibited_interface_types

Examines the list of prohibited interface types.

nw_parameters_iterate_interface_types_block_t

A block that allows inspection of a list of interface types.

nw_parameters_prohibit_interface

Prevents connections and listeners from using a specific interface.

nw_parameters_clear_prohibited_interfaces

Removes all prohibited interface types.

nw_parameters_iterate_prohibited_interfaces

Examines the list of prohibited interfaces.

nw_parameters_iterate_interfaces_block_t

A block that allows inspection of a list of interfaces.

Customizing Connection Options

nw_parameters_set_multipath_service

Enables multipath protocols to allow connections to use multiple interfaces.

nw_parameters_get_multipath_service

Checks if multipath is enabled on a connection.

nw_multipath_service_t

Modes in which a connection can support multipath protocols.

nw_parameters_set_service_class

Sets a level of service quality to use for connections.

nw_parameters_get_service_class

Checks the level of service quality used for connections.

nw_service_class_t

Levels of service quality that can be used with a connection.

nw_parameters_set_fast_open_enabled

Enables sending application data with protocol handshakes.

nw_parameters_get_fast_open_enabled

Checks if sending application data with protocol handshakes is enabled.

nw_parameters_set_expired_dns_behavior

Sets the behavior for how expired DNS answers should be used.

nw_parameters_get_expired_dns_behavior

Checks the behavior for how expired DNS answers should be used.

nw_parameters_expired_dns_behavior_t

Options for configuring how expired DNS answers should be used.

nw_parameters_set_prefer_no_proxy

Sets a Boolean that indicates that connections should ignore proxies when they are enabled on the system.

nw_parameters_get_prefer_no_proxy

Checks if proxies are ignored by default.

nw_parameters_set_include_peer_to_peer

Enables peer-to-peer link technologies for connections and listeners.

nw_parameters_get_include_peer_to_peer

Checks whether a connection is allowed to use peer-to-peer link technologies.

nw_parameters_set_reuse_local_address

Allows reusing local addresses and ports across connections.

nw_parameters_get_reuse_local_address

Checks whether a connection allows reusing local addresses and ports.

nw_parameters_set_local_only

Restricts listeners to only accepting connections from the local link.

nw_parameters_get_local_only

Checks if a listener is restricted to accepting connections from the local link.

See Also

Essentials

nw_endpoint_t

A local or remote endpoint in a network connection.