One Logo Pool Ball
Network · IOS API REFERENCE

NWProtocolQUIC.Metadata

class · iOS 15.0+ · SDK 27.1

class Metadata

Access QUIC stream metadata using NWConnection.metadata, NWConnection.ContentContext.protocolMetadata, NWConnectionGroup.metadata, or NWConnectionGroup.Message.metadata.

Members (17)

get · iOS 15.0+

securityProtocolMetadata

TypeScript
get securityProtocolMetadata(): SDKHandle
Swift declaration
var securityProtocolMetadata: sec_protocol_metadata_t { get }

Access the sec_protocol_metadata_t for a given network protocol metadata instance. See <Security/SecProtocolMetadata.h> for functions to further access security metadata.

get · iOS 15.0+

negotiatedALPN

TypeScript
get negotiatedALPN(): (string) | null
Swift declaration
var negotiatedALPN: String? { get }

Return the negotiated application protocol used when establishing the connection

get · iOS 15.0+

applicationError

TypeScript
get applicationError(): NWProtocolQUIC_ApplicationError
Swift declaration
var applicationError: NWProtocolQUIC.ApplicationError { get set }

The QUIC application error code to send for the connection, or received from the peer.

set · iOS 15.0+

applicationError

TypeScript
set applicationError(value: NWProtocolQUIC_ApplicationError)
Swift declaration
var applicationError: NWProtocolQUIC.ApplicationError { get set }

The QUIC application error code to send for the connection, or received from the peer.

get · iOS 15.0+

streamIdentifier

TypeScript
get streamIdentifier(): number
Swift declaration
var streamIdentifier: UInt64 { get }

The QUIC stream identifier.

get · iOS 15.0+

remoteIdleTimeout

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

Access the idle_timeout value in milliseconds received from the peer in the transport parameters.

get · iOS 16.0+

usableDatagramFrameSize

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

Get the usable size of a datagram frame from a QUIC datagram flow.

get · iOS 15.0+

streamApplicationErrorCode

TypeScript
get streamApplicationErrorCode(): number
Swift declaration
var streamApplicationErrorCode: UInt64 { get set }

The QUIC application error code to send for the stream, or received from the peer.

set · iOS 15.0+

streamApplicationErrorCode

TypeScript
set streamApplicationErrorCode(value: number)
Swift declaration
var streamApplicationErrorCode: UInt64 { get set }

The QUIC application error code to send for the stream, or received from the peer.

get · iOS 15.0+

localMaxStreamsBidirectional

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

The maximum number of bidirectional streams that the peer can create on a QUIC connection.

set · iOS 15.0+

localMaxStreamsBidirectional

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

The maximum number of bidirectional streams that the peer can create on a QUIC connection.

get · iOS 15.0+

localMaxStreamsUnidirectional

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

The maximum number of unidirectional streams that the peer can create on a QUIC connection.

set · iOS 15.0+

localMaxStreamsUnidirectional

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

The maximum number of unidirectional streams that the peer can create on a QUIC connection.

get · iOS 15.0+

remoteMaxStreamsBidirectional

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

Get the maximum number of bidirectional streams advertised by peer that an application is allowed to create. Note that while attempts to create streams above this limit will be blocked until the server increases the limit, these blocked attempts will cause a STREAMS_BLOCKED frame to be sent to the server. This informs the server that the client has more streams it would like to create. As a result, the caller should attempt to create streams over this limit if it desires more streams.

get · iOS 15.0+

remoteMaxStreamsUnidirectional

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

Get the maximum number of unidirectional streams advertised by peer that an application is allowed to create. Note that while attempts to create streams above this limit will be blocked until the server increases the limit, these blocked attempts will cause a STREAMS_BLOCKED frame to be sent to the server. This informs the server that the client has more streams it would like to create. As a result, the caller should attempt to create streams over this limit if it desires more streams.

get · iOS 15.0+

keepAlive

TypeScript
get keepAlive(): NWProtocolQUIC_Metadata_KeepAliveBehavior
Swift declaration
var keepAlive: NWProtocolQUIC.Metadata.KeepAliveBehavior { get set }

Set the QUIC connection keep-alive interval.

set · iOS 15.0+

keepAlive

TypeScript
set keepAlive(value: NWProtocolQUIC_Metadata_KeepAliveBehavior)
Swift declaration
var keepAlive: NWProtocolQUIC.Metadata.KeepAliveBehavior { get set }

Set the QUIC connection keep-alive interval.

Skipped declarations

No declarations were skipped in this snapshot.

All Network types →