SCNetworkConnectionStart(_:_:_:)

Starts the connection process for the specified network connection.

Declaration

func SCNetworkConnectionStart(_ connection: SCNetworkConnection, _ userOptions: CFDictionary?, _ linger: Bool) -> Bool

Parameters

connection:
The network connection to start.
userOptions:
The options with which to start the connection. If userOptions is NULL, the default settings are used. If userOptions are specified, they must be in the same format as network services stored in the system configuration preferences schema. The options override the default settings defined for the service.
For security reasons, not all options can be overridden; the appropriate merging of all settings is done before the connection is established, and inappropriate options are ignored.
linger:
A Boolean value indicating whether the connection can persist when the application no longer has interest in it. A typical application should pass FALSE, in which case the connection is automatically stopped when the reference is released or the application quits. If the application passes TRUE, the application can release the reference or exit and the connection is maintained until a timeout event, until a specific stop request occurs, or until an error occurs.

Return Value

TRUE if the connection was correctly started (the actual connection is not established yet, and the connection status needs to be periodically checked); FALSE if the connection request was not started (use the SCError() function to retrieve the specific error).

Discussion

The connection process is asynchronous and this function returns immediately. The connection status can be obtained by polling or by callback. The connection is made with the default settings from the administrator. Some of the settings can be overridden for the duration of the connection. These are specified in an options dictionary. The options dictionary uses the same format as a network service defined in the system configuration preferences schema.