Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы CoreServices ссылка CFProxySupport

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка CFProxySupport

Наследование


Не применимый

Соответствует


Не применимый

Оператор импорта


Swift

import CFNetwork

Objective C

@import CFNetwork;

CFProxySupport API позволяет Вам использовать в своих интересах глобальные параметры конфигурации прокси в своем приложении.

CFProxySupport функционирует возвращаемые массивы словарей, где каждый словарь описывает единственный прокси. Массивы представляют порядок, в котором нужно попробовать прокси. В целом, если первый перестал работать, и т.д., необходимо попытаться загрузить URL с помощью первого прокси в массиве, попробовать второй прокси.

Каждый словарь прокси имеет запись для kCFProxyTypeKey. Если тип - что-нибудь кроме kCFProxyTypeAutoConfigurationURL, словарь также имеет записи для узла и порта прокси (под kCFProxyHostNameKey и kCFProxyPortNumberKey соответственно). Если тип kCFProxyTypeAutoConfigurationURL, это имеет запись для kCFProxyAutoConfigurationURLKey.

Ключи для имени пользователя и пароля являются дополнительными и присутствуют, только если имя пользователя или пароль могло быть извлечено из информации, переданной в (или от URL самой или из предоставленного словаря прокси). Этот APIs не консультируется ни с какими внешними учетными хранилищами, такими как Цепочка для ключей.

Функции

  • Возвращает список прокси, которые должны использоваться для загрузки данного URL.

    Объявление

    Swift

    func CFNetworkCopyProxiesForURL(_ url: CFURL!, _ proxySettings: CFDictionary!) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef CFNetworkCopyProxiesForURL ( CFURLRef url, CFDictionaryRef proxySettings );

    Параметры

    url

    URL Ваше приложение намеревается получить доступ.

    proxySettings

    Словарь, описывающий доступные настройки прокси. Словарь должен быть в формате, возвращенном SystemConfiguration.framework. (См. Ссылку Платформы Конфигурации системы для получения дополнительной информации.)

    Возвращаемое значение

    Возвращает массив словарей. Каждый словарь описывает единственный прокси. Массив упорядочивается оптимально для запроса указанного URL.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

  • Выполняет сценарий автоматической конфигурации прокси для определения лучшего прокси для использования для получения указанного URL.

    Объявление

    Swift

    func CFNetworkCopyProxiesForAutoConfigurationScript(_ proxyAutoConfigurationScript: CFString!, _ targetURL: CFURL!, _ error: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective C

    CFArrayRef CFNetworkCopyProxiesForAutoConfigurationScript ( CFStringRef proxyAutoConfigurationScript, CFURLRef targetURL, CFErrorRef *error );

    Параметры

    proxyAutoConfigurationScript

    A CFString содержа код сценария автоматической конфигурации для выполнения.

    targetURL

    URL Ваше приложение намеревается получить доступ.

    error

    Адрес ошибочной ссылки на объект, перезаписывающейся по возврату, если происходит ошибка.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

  • Загружает сценарий автоматической конфигурации прокси и выполняет его.

    Объявление

    Swift

    func CFNetworkExecuteProxyAutoConfigurationScript(_ proxyAutoConfigurationScript: CFString!, _ targetURL: CFURL!, _ cb: CFProxyAutoConfigurationResultCallback, _ clientContext: UnsafeMutablePointer<CFStreamClientContext>) -> Unmanaged<CFRunLoopSource>!

    Objective C

    CFRunLoopSourceRef CFNetworkExecuteProxyAutoConfigurationScript ( CFStringRef proxyAutoConfigurationScript, CFURLRef targetURL, CFProxyAutoConfigurationResultCallback cb, CFStreamClientContext *clientContext );

    Параметры

    proxyAutoConfigurationScript

    A CFString содержа код сценария автоматической конфигурации, который будет выполняться.

    targetURL

    URL, что Ваше приложение намеревается в конечном счете загрузить использование прокси.

    cb

    Обратный вызов, который вызовут, когда закончено выполнение сценария.

    clientContext

    Потоковый контекст, содержащий клиентскую информацию, возражает и дополнительно сохраняет и выпускает обратные вызовы для того объекта.

    Обсуждение

    Эта функция возвращает источник цикла выполнения, который должна запланировать вызывающая сторона. Как только выполнение сценария завершилось, указанную функцию обратного вызова вызывают.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

  • Загружает сценарий автоматической конфигурации прокси и выполняет его.

    Объявление

    Swift

    func CFNetworkExecuteProxyAutoConfigurationURL(_ proxyAutoConfigURL: CFURL!, _ targetURL: CFURL!, _ cb: CFProxyAutoConfigurationResultCallback, _ clientContext: UnsafeMutablePointer<CFStreamClientContext>) -> Unmanaged<CFRunLoopSource>!

    Objective C

    CFRunLoopSourceRef CFNetworkExecuteProxyAutoConfigurationURL ( CFURLRef proxyAutoConfigURL, CFURLRef targetURL, CFProxyAutoConfigurationResultCallback cb, CFStreamClientContext *clientContext );

    Параметры

    proxyAutoConfigURL

    URL сценария автоматической конфигурации.

    targetURL

    URL, что Ваше приложение намеревается в конечном счете загрузить использование прокси.

    cb

    Обратный вызов, который вызовут, когда закончено выполнение сценария.

    clientContext

    Потоковый контекст, содержащий клиентскую информацию, возражает и дополнительно сохраняет и выпускает обратные вызовы для того объекта.

    Обсуждение

    Эта функция возвращает источник цикла выполнения, который должна запланировать вызывающая сторона. Один раз загрузка и выполнение сценария завершился, указанную функцию обратного вызова вызывают.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвращает CFDictionary, содержащий текущие интернет-настройки прокси в масштабе всей системы.

    Объявление

    Swift

    func CFNetworkCopySystemProxySettings() -> Unmanaged<CFDictionary>!

    Objective C

    CFDictionaryRef CFNetworkCopySystemProxySettings ( void );

    Обсуждение

    Словарь возвратился, содержит пары ключ/значение, представляющие текущие интернет-настройки прокси. Ключи в этом словаре определяются в Глобальных Константах Настроек Прокси.

    Вызывающая сторона ответственна за выпуск возвращенного словаря.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

Обратные вызовы

  • Когда вычисление автоматической конфигурации прокси завершилось, функция обратного вызова вызвала.

    Объявление

    Swift

    typealias CFProxyAutoConfigurationResultCallback = CFunctionPointer<((UnsafeMutablePointer<Void>, CFArray!, CFError!) -> Void)>

    Objective C

    typedef CALLBACK_API_C( void, CFProxyAutoConfigurationResultCallback )( void *client, CFArrayRef proxyList, CFErrorRef error );

    Параметры

    client

    Клиентская ссылка первоначально передала в clientContext параметр CFNetworkExecuteProxyAutoConfigurationScript или CFNetworkExecuteProxyAutoConfigurationURL вызовите, который инициировал этот обратный вызов.

    proxyList

    Список прокси, возвращенных сценарием автоматической конфигурации. Этот список находится в формате, подходящем для передачи CFProxyCopyProxiesForURL (с добавленной гарантией, что никакие записи никогда не будут автоматической конфигурацией записи URL). Если ошибка произойдет, то это значение будет NULL.

    error

    Ошибочный объект, указывающий любую ошибку, которая, возможно, произошла. Если никакая ошибка не произошла, этим значением будет NULL.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в iOS 2.0 и позже.

Константы

  • Ключи для вызовов к свойству функции get/set такой как CFReadStreamSetProperty и CFReadStreamCopyProperty.

    Объявление

    Swift

    let kCFProxyAutoConfigurationHTTPResponseKey: CFString! let kCFProxyAutoConfigurationJavaScriptKey: CFString! let kCFProxyAutoConfigurationURLKey: CFString! let kCFProxyHostNameKey: CFString! let kCFProxyPasswordKey: CFString! let kCFProxyPortNumberKey: CFString! let kCFProxyTypeKey: CFString! let kCFProxyUsernameKey: CFString!

    Objective C

    const CFStringRef kCFProxyAutoConfigurationHTTPResponseKey; const CFStringRef kCFProxyAutoConfigurationJavaScriptKey; const CFStringRef kCFProxyAutoConfigurationURLKey; const CFStringRef kCFProxyHostNameKey; const CFStringRef kCFProxyPasswordKey; const CFStringRef kCFProxyPortNumberKey; const CFStringRef kCFProxyTypeKey; const CFStringRef kCFProxyUsernameKey;

    Константы

    • kCFProxyAutoConfigurationHTTPResponseKey

      A CFHTTPMessageRef значение, найденное в пользовательском информационном словаре ошибки аутентификации, возвратилось к CFNetworkCopyProxiesForAutoConfigurationScript функционируйте или к a CFProxyAutoConfigurationResultCallback обратный вызов.

      Доступный в iOS 2.0 и позже.

    • kCFProxyAutoConfigurationJavaScriptKey

      A CFString значение, содержащее полный источник JavaScript для автоматической конфигурации прокси (PAC) файл. Этот ключ только присутствует для прокси типа kCFProxyAutoConfigurationJavaScript.

      Доступный в iOS 3.0 и позже.

    • kCFProxyAutoConfigurationURLKey

      A CFURL значение, указывающее расположение автоматической конфигурации прокси (PAC) файл. Этот ключ только присутствует для прокси типа kCFProxyTypeAutoConfigurationURL.

      Доступный в iOS 2.0 и позже.

    • kCFProxyHostNameKey

      A CFString значение, содержащее или имя хоста или IP-адрес прокси-сервера.

      Доступный в iOS 2.0 и позже.

    • kCFProxyPasswordKey

      Пароль, который будет использоваться при контакте с прокси. Если пароль может быть определен от информации, переданной в, этот ключ только присутствует. (С внешними учетными хранилищами, такими как цепочка для ключей не консультируются.)

      Доступный в iOS 2.0 и позже.

    • kCFProxyPortNumberKey

      A CFNumber значение, указывающее порт, который должен использоваться для контакта с прокси.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeKey

      Указывает тип прокси. Значение может быть любым из значений, перечисленных в Типах Прокси.

      Доступный в iOS 2.0 и позже.

    • kCFProxyUsernameKey

      Имя пользователя, которое будет использоваться при контакте с прокси. Если имя пользователя может быть определено от информации, переданной в, этот ключ только присутствует. (С внешними учетными хранилищами, такими как цепочка для ключей не консультируются.)

      Доступный в iOS 2.0 и позже.

  • Константы, указывающие тип прокси.

    Объявление

    Swift

    let kCFProxyTypeNone: CFString! let kCFProxyTypeAutoConfigurationURL: CFString! let kCFProxyTypeAutoConfigurationJavaScript: CFString! let kCFProxyTypeFTP: CFString! let kCFProxyTypeHTTP: CFString! let kCFProxyTypeHTTPS: CFString! let kCFProxyTypeSOCKS: CFString!

    Objective C

    const CFStringRef kCFProxyTypeNone; const CFStringRef kCFProxyTypeAutoConfigurationURL; const CFStringRef kCFProxyTypeAutoConfigurationJavaScript; const CFStringRef kCFProxyTypeFTP; const CFStringRef kCFProxyTypeHTTP; const CFStringRef kCFProxyTypeHTTPS; const CFStringRef kCFProxyTypeSOCKS;

    Константы

    • kCFProxyTypeNone

      Указывает, что не должен использоваться никакой прокси.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeAutoConfigurationURL

      Указывает, что прокси определяется файлом автоматической конфигурации в данном URL.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeAutoConfigurationJavaScript

      Указывает, что прокси определяется предоставленным сценарием автоматической конфигурации.

      Доступный в iOS 3.0 и позже.

    • kCFProxyTypeFTP

      Указывает прокси FTP.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeHTTP

      Указывает Прокси HTTP.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeHTTPS

      Указывает прокси HTTPS.

      Доступный в iOS 2.0 и позже.

    • kCFProxyTypeSOCKS

      Указывает прокси SOCKS.

      Доступный в iOS 2.0 и позже.

  • Константы для ключей в глобальном словаре настроек прокси, возвращенном CFNetworkCopySystemProxySettings.

    Объявление

    Swift

    let kCFNetworkProxiesHTTPEnable: CFString! let kCFNetworkProxiesHTTPPort: CFString! let kCFNetworkProxiesHTTPProxy: CFString! let kCFNetworkProxiesProxyAutoConfigEnable: CFString! let kCFNetworkProxiesProxyAutoConfigJavaScript: CFString! let kCFNetworkProxiesProxyAutoConfigURLString: CFString!

    Objective C

    const CFStringRef kCFNetworkProxiesHTTPEnable; const CFStringRef kCFNetworkProxiesHTTPPort; const CFStringRef kCFNetworkProxiesHTTPProxy; const CFStringRef kCFNetworkProxiesProxyAutoConfigEnable; const CFStringRef kCFNetworkProxiesProxyAutoConfigJavaScript; const CFStringRef kCFNetworkProxiesProxyAutoConfigURLString;

    Константы

    • kCFNetworkProxiesHTTPEnable

      Значение является a CFNumber объект, указывающий, включен ли Прокси HTTP. Прокси включен, если ключ присутствует, и присваиваемое значение является ненулевым.

      Доступный в iOS 2.0 и позже.

    • kCFNetworkProxiesHTTPPort

      Значение является a CFNumber объект, содержащий номер порта, связался с Прокси HTTP.

      Доступный в iOS 2.0 и позже.

    • kCFNetworkProxiesHTTPProxy

      Значение является a CFString объект, содержащий имя хоста Прокси HTTP или IP-адрес.

      Доступный в iOS 2.0 и позже.

    • kCFNetworkProxiesProxyAutoConfigEnable

      Значение является a CFNumber объект, указывающий, включена ли автоматическая конфигурация прокси. Автоматическая конфигурация прокси включена, если ключ присутствует, и присваиваемое значение является ненулевым.

      Доступный в iOS 2.0 и позже.

    • kCFNetworkProxiesProxyAutoConfigJavaScript

      Значение является a CFString объект, содержащий полный источник JavaScript ProxyAutoConfig (PAC) файл.

      Доступный в iOS 3.0 и позже.

    • kCFNetworkProxiesProxyAutoConfigURLString

      Значение является a CFString объект, содержащий URL автоматической конфигурации прокси (PAC) файл.

      Доступный в iOS 2.0 и позже.