One Logo Pool Ball
X
Github
Discord

System

Network · IOS API REFERENCE

NWProtocolTCP.Options

class · iOS 12.0+ · SDK 27.1

class Options

Members (31)

get · iOS 12.0+

noOptions

TypeScript
get noOptions(): boolean
Swift declaration
var noOptions: Bool { get set }

A boolean indicating that TCP should use no-options mode (`TCP_NOOPT`).

set · iOS 12.0+

noOptions

TypeScript
set noOptions(value: boolean)
Swift declaration
var noOptions: Bool { get set }

A boolean indicating that TCP should use no-options mode (`TCP_NOOPT`).

get · iOS 12.0+

disableECN

TypeScript
get disableECN(): boolean
Swift declaration
var disableECN: Bool { get set }

A boolean to disable ECN negotiation in TCP.

set · iOS 12.0+

disableECN

TypeScript
set disableECN(value: boolean)
Swift declaration
var disableECN: Bool { get set }

A boolean to disable ECN negotiation in TCP.

get · iOS 12.0+

keepaliveIdle

TypeScript
get keepaliveIdle(): number
Swift declaration
var keepaliveIdle: Int { get set }

The number of seconds of idleness to wait before keepalive probes are sent by TCP (TCP_KEEPALIVE).

set · iOS 12.0+

keepaliveIdle

TypeScript
set keepaliveIdle(value: number)
Swift declaration
var keepaliveIdle: Int { get set }

The number of seconds of idleness to wait before keepalive probes are sent by TCP (TCP_KEEPALIVE).

get · iOS 12.0+

enableFastOpen

TypeScript
get enableFastOpen(): boolean
Swift declaration
var enableFastOpen: Bool { get set }

Configure TCP to enable TCP Fast Open (TFO). This may take effect even when TCP is not the top-level protocol in the protocol stack. For example, if TLS is running over TCP, the Client Hello message may be sent as fast open data. If TCP is the top-level protocol in the stack (the one the application directly interacts with), TFO will be disabled unless the application indicated that it will provide its own fast open data by calling NWParameters.allowFastOpen.

set · iOS 12.0+

enableFastOpen

TypeScript
set enableFastOpen(value: boolean)
Swift declaration
var enableFastOpen: Bool { get set }

Configure TCP to enable TCP Fast Open (TFO). This may take effect even when TCP is not the top-level protocol in the protocol stack. For example, if TLS is running over TCP, the Client Hello message may be sent as fast open data. If TCP is the top-level protocol in the stack (the one the application directly interacts with), TFO will be disabled unless the application indicated that it will provide its own fast open data by calling NWParameters.allowFastOpen.

get · iOS 12.0+

keepaliveCount

TypeScript
get keepaliveCount(): number
Swift declaration
var keepaliveCount: Int { get set }

The number of keepalive probes to send before terminating the connection (TCP_KEEPCNT).

set · iOS 12.0+

keepaliveCount

TypeScript
set keepaliveCount(value: number)
Swift declaration
var keepaliveCount: Int { get set }

The number of keepalive probes to send before terminating the connection (TCP_KEEPCNT).

get · iOS 12.0+

persistTimeout

TypeScript
get persistTimeout(): number
Swift declaration
var persistTimeout: Int { get set }

The TCP persist timeout, in seconds (PERSIST_TIMEOUT). See RFC 6429.

set · iOS 12.0+

persistTimeout

TypeScript
set persistTimeout(value: number)
Swift declaration
var persistTimeout: Int { get set }

The TCP persist timeout, in seconds (PERSIST_TIMEOUT). See RFC 6429.

get · iOS 12.0+

enableKeepalive

TypeScript
get enableKeepalive(): boolean
Swift declaration
var enableKeepalive: Bool { get set }

A boolean indicating that TCP should send keepalives (SO_KEEPALIVE).

set · iOS 12.0+

enableKeepalive

TypeScript
set enableKeepalive(value: boolean)
Swift declaration
var enableKeepalive: Bool { get set }

A boolean indicating that TCP should send keepalives (SO_KEEPALIVE).

get · iOS 12.0+

connectionTimeout

TypeScript
get connectionTimeout(): number
Swift declaration
var connectionTimeout: Int { get set }

A timeout for TCP connection establishment, in seconds (TCP_CONNECTIONTIMEOUT).

set · iOS 12.0+

connectionTimeout

TypeScript
set connectionTimeout(value: number)
Swift declaration
var connectionTimeout: Int { get set }

A timeout for TCP connection establishment, in seconds (TCP_CONNECTIONTIMEOUT).

get · iOS 12.0+

keepaliveInterval

TypeScript
get keepaliveInterval(): number
Swift declaration
var keepaliveInterval: Int { get set }

The number of seconds of to wait before resending TCP keepalive probes (TCP_KEEPINTVL).

set · iOS 12.0+

keepaliveInterval

TypeScript
set keepaliveInterval(value: number)
Swift declaration
var keepaliveInterval: Int { get set }

The number of seconds of to wait before resending TCP keepalive probes (TCP_KEEPINTVL).

get · iOS 12.0+

retransmitFinDrop

TypeScript
get retransmitFinDrop(): boolean
Swift declaration
var retransmitFinDrop: Bool { get set }

A boolean to cause TCP to drop its connection after not receiving an ACK after a FIN (TCP_RXT_FINDROP).

set · iOS 12.0+

retransmitFinDrop

TypeScript
set retransmitFinDrop(value: boolean)
Swift declaration
var retransmitFinDrop: Bool { get set }

A boolean to cause TCP to drop its connection after not receiving an ACK after a FIN (TCP_RXT_FINDROP).

get · iOS 12.0+

connectionDropTime

TypeScript
get connectionDropTime(): number
Swift declaration
var connectionDropTime: Int { get set }

A timeout for TCP retransmission attempts, in seconds (TCP_RXT_CONNDROPTIME).

set · iOS 12.0+

connectionDropTime

TypeScript
set connectionDropTime(value: number)
Swift declaration
var connectionDropTime: Int { get set }

A timeout for TCP retransmission attempts, in seconds (TCP_RXT_CONNDROPTIME).

get · iOS 12.0+

maximumSegmentSize

TypeScript
get maximumSegmentSize(): number
Swift declaration
var maximumSegmentSize: Int { get set }

The maximum segment size in bytes (TCP_MAXSEG).

set · iOS 12.0+

maximumSegmentSize

TypeScript
set maximumSegmentSize(value: number)
Swift declaration
var maximumSegmentSize: Int { get set }

The maximum segment size in bytes (TCP_MAXSEG).

get · iOS 12.0+

disableAckStretching

TypeScript
get disableAckStretching(): boolean
Swift declaration
var disableAckStretching: Bool { get set }

A boolean to cause TCP to disable ACK stretching (TCP_SENDMOREACKS).

set · iOS 12.0+

disableAckStretching

TypeScript
set disableAckStretching(value: boolean)
Swift declaration
var disableAckStretching: Bool { get set }

A boolean to cause TCP to disable ACK stretching (TCP_SENDMOREACKS).

get · iOS 12.0+

noPush

TypeScript
get noPush(): boolean
Swift declaration
var noPush: Bool { get set }

A boolean indicating that TCP should use no-push mode (`TCP_NOPUSH`).

set · iOS 12.0+

noPush

TypeScript
set noPush(value: boolean)
Swift declaration
var noPush: Bool { get set }

A boolean indicating that TCP should use no-push mode (`TCP_NOPUSH`).

get · iOS 12.0+

noDelay

TypeScript
get noDelay(): boolean
Swift declaration
var noDelay: Bool { get set }

A boolean indicating that TCP should disable Nagle's algorithm (TCP_NODELAY).

set · iOS 12.0+

noDelay

TypeScript
set noDelay(value: boolean)
Swift declaration
var noDelay: Bool { get set }

A boolean indicating that TCP should disable Nagle's algorithm (TCP_NODELAY).

init · iOS 12.0+

init

TypeScript
static init(): NWProtocolTCP_Options
Swift declaration
init()

Create TCP options to set in an NWParameters.ProtocolStack

Skipped declarations

No declarations were skipped in this snapshot.

All Network types →