Mac Developer Library

Developer

CoreServices Framework Reference CFStream Socket Additions

Options
Deployment Target:

On This Page
Language:

CFStream Socket Additions

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Swift

import CFNetwork

Objective-C

@import CFNetwork;

This document describes the CFStream functions for working with sockets. It is part of the CFSocketStream API.

Functions

  • Creates readable and writable streams connected to a given CFHost object.

    Declaration

    Swift

    func CFStreamCreatePairWithSocketToCFHost(_ alloc: CFAllocator!, _ host: CFHost!, _ port: Int32, _ readStream: UnsafeMutablePointer<Unmanaged<CFReadStream>?>, _ writeStream: UnsafeMutablePointer<Unmanaged<CFWriteStream>?>)

    Objective-C

    void CFStreamCreatePairWithSocketToCFHost ( CFAllocatorRef alloc, CFHostRef host, SInt32 port, CFReadStreamRef *readStream, CFWriteStreamRef *writeStream );

    Parameters

    alloc

    The allocator to use to allocate memory for the CFReadStream and CFWriteStream objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.

    host

    A CFHost object to which the streams are connected. If unresolved, the host will be resolved prior to connecting.

    port

    The TCP port number to which the socket streams should connect.

    readStream

    Upon return, contains a CFReadStream object connected to the host host on port port, or NULL if there is a failure during creation. If you pass NULL, the function will not create a readable stream. Ownership follows the Create Rule.

    writeStream

    Upon return, contains a CFWriteStream object connected to the host host on port port, or NULL if there is a failure during creation. If you pass NULL, the function will not create a writable stream. Ownership follows the Create Rule.

    Discussion

    The streams do not create a socket or connect to the specified host until you open one of the streams.

    Most properties are shared by both streams. Setting a shared property for one stream automatically sets the property for the other.

    Import Statement

    Objective-C

    @import CFNetwork;

    Swift

    import CFNetwork

    Availability

    Available in OS X v10.3 and later.

  • Creates a pair of streams for a CFNetService.

    Declaration

    Swift

    func CFStreamCreatePairWithSocketToNetService(_ alloc: CFAllocator!, _ service: CFNetService!, _ readstream: UnsafeMutablePointer<Unmanaged<CFReadStream>?>, _ writeStream: UnsafeMutablePointer<Unmanaged<CFWriteStream>?>)

    Objective-C

    void CFStreamCreatePairWithSocketToNetService ( CFAllocatorRef alloc, CFNetServiceRef service, CFReadStreamRef *readStream, CFWriteStreamRef *writeStream );

    Parameters

    alloc

    The allocator to use to allocate memory for the CFReadStream and CFWriteStream objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.

    service

    Reference to the CFNetService to which the streams are to be connected. If the service is not resolved, the service will be resolved before the streams are connected.

    readstream

    Upon return, contains a CFReadStream object connected to the service specified by service, or NULL if there is a failure during creation. If you pass NULL, the function will not create a readable stream. Ownership follows the Create Rule.

    writeStream

    Upon return, contains a CFWriteStream object connected to the service specified by service, or NULL if there is a failure during creation. If you pass NULL, the function will not create a writable stream. Ownership follows the Create Rule.

    Discussion

    The streams do not create a socket, resolve the service, or connect to the service’s host until you open one of the streams.

    Most properties are shared by both streams. Setting a shared property for one stream automatically sets the property for the other.

    Special Considerations

    This function is thread safe.

    Import Statement

    Objective-C

    @import CFNetwork;

    Swift

    import CFNetwork

    Availability

    Available in OS X v10.3 and later.

  • This function gets error codes in the kCFStreamErrorDomainSOCKS domain from the CFStreamError returned by a stream operation.

    Declaration

    Swift

    func CFSocketStreamSOCKSGetError(_ error: UnsafePointer<CFStreamError>) -> Int32

    Objective-C

    SInt32 CFSocketStreamSOCKSGetError ( const CFStreamError *error );

    Parameters

    error

    The error value to decode.

    Discussion

    Error codes in the kCFStreamErrorDomainSOCKS domain can come from multiple parts of the protocol stack, many of which define their own error values as part of outside specifications such as the HTTP specification.

    To avoid confusion from conflicting error numbers, error codes in the kCFStreamErrorDomainSOCKS domain contain two parts: a subdomain, which tells which part of the protocol stack generated the error, and the error code itself.

    Calling CFSocketStreamSOCKSGetError returns the error code itself, which must be interpreted in the context of the result of a call to CFSocketStreamSOCKSGetErrorSubdomain. Possible return values (beyond subdomain-specific values such as client versions and HTTP error codes) are listed in CFStream Errors.

    Import Statement

    Objective-C

    @import CFNetwork;

    Swift

    import CFNetwork

    Availability

    Available in OS X v10.2 and later.

  • Gets the error subdomain associated with errors in the kCFStreamErrorDomainSOCKS domain from the CFStreamError returned by a stream operation.

    Declaration

    Swift

    func CFSocketStreamSOCKSGetErrorSubdomain(_ error: UnsafePointer<CFStreamError>) -> Int32

    Objective-C

    SInt32 CFSocketStreamSOCKSGetErrorSubdomain ( const CFStreamError *error );

    Parameters

    error

    The error value to decode.

    Discussion

    Error codes in the kCFStreamErrorDomainSOCKS domain can come from multiple parts of the protocol stack, many of which define their own error values as part of outside specifications such as the HTTP specification.

    To avoid confusion from conflicting error numbers, error codes in the kCFStreamErrorDomainSOCKS domain contain two parts: a subdomain, which tells which part of the protocol stack generated the error, and the error code itself.

    Calling CFSocketStreamSOCKSGetErrorSubdomain returns an identifier that tells which layer of the protocol stack produced the error. The possible values are listed in Error Subdomains. With this information, you can interpret the error codes returned by CFSocketStreamSOCKSGetError.

    Import Statement

    Objective-C

    @import CFNetwork;

    Swift

    import CFNetwork

    Availability

    Available in OS X v10.2 and later.

Constants

  • Constants for CFStream property keys

    Declaration

    Swift

    let kCFStreamPropertyShouldCloseNativeSocket: CFString! let kCFStreamPropertySocketNativeHandle: CFString! let kCFStreamPropertySocketSecurityLevel: CFString! let kCFStreamPropertySSLPeerTrust: CFString! let kCFStreamPropertySSLContext: CFString! let kCFStreamPropertySOCKSProxy: CFString! let kCFStreamPropertySSLSettings: CFString! let kCFStreamPropertyProxyLocalBypass: CFString! let kCFStreamPropertySocketRemoteHost: CFString! let kCFStreamPropertySocketRemoteNetService: CFString! let kCFStreamNetworkServiceType: CFString! let kCFStreamPropertyConnectionIsCellular: CFString! let kCFStreamPropertyNoCellular: CFString!

    Objective-C

    const CFStringRef kCFStreamPropertyShouldCloseNativeSocket; const CFStringRef kCFStreamPropertySocketSecurityLevel; const CFStringRef kCFStreamPropertySOCKSProxy; const CFStringRef kCFStreamPropertySSLPeerCertificates; const CFStringRef kCFStreamPropertySSLPeerTrust; const CFStringRef kCFStreamPropertySSLSettings; const CFStringRef kCFStreamPropertySSLContext; const CFStringRef kCFStreamPropertyProxyLocalByPass; const CFStringRef kCFStreamPropertySocketRemoteHost; const CFStringRef kCFStreamPropertySocketRemoteNetService; const CFStringRef kCFStreamNetworkServiceType; const CFStringRef kCFStreamPropertyConnectionIsCellular; const CFStringRef kCFStreamPropertyNoCellular;

    Constants

    • kCFStreamPropertyShouldCloseNativeSocket

      kCFStreamPropertyShouldCloseNativeSocket

      Should Close Native Socket property key.

      If set to kCFBooleanTrue, the stream will close and release the underlying native socket when the stream is released. If set to kCFBooleanFalse, the stream will not close and release the underlying native socket when the stream is released. If a stream is created with a native socket, the default value of this property is kCFBooleanFalse. This property is only available for socket streams. It can be set by calling CFReadStreamSetProperty and CFWriteStreamSetProperty, and it can be copied by CFReadStreamCopyProperty and CFWriteStreamCopyProperty.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySocketNativeHandle

      kCFStreamPropertySocketNativeHandle

      Socket Native Handle property key.

      Causes CFReadStreamCopyProperty or CFWriteStreamCopyProperty to return CFData object that contains the native handle for a socket stream. This property is only available for socket streams.

      Available in OS X v10.1 and later.

    • kCFStreamPropertySocketSecurityLevel

      kCFStreamPropertySocketSecurityLevel

      Socket Security Level property key.

      See CFStream Socket Security Level Constants for specific security level constants to use.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySSLPeerCertificates

      kCFStreamPropertySSLPeerCertificates

      SSL Peer Certificates property key for copy operations, which return a CFArray object containing SecCertificateRef objects.

      For more information, see SSLGetPeerCertificates in Security/SecureTransport.h.

      Available in OS X v10.4 and later.

      Deprecated in OS X v10.6.

    • kCFStreamPropertySSLPeerTrust

      kCFStreamPropertySSLPeerTrust

      SSL Peer Trust property key for copy operations, which return a SecTrustRef object containing the result of the SSL handshake.

      For more information, see SSLCopyPeerTrust in Security/SecureTransport.h.

      Available in OS X v10.5 and later.

    • kCFStreamPropertySSLContext

      kCFStreamPropertySSLContext

      The SSLContextRef object used for read and write operations on a stream.

      Before opening a stream, you can copy the object from this property and configure it using the Secure Transport API. You can also set this property to specify a new SSLContextRef for a stream. The behavior depends on whether the stream has been opened and on whether an SSL context is associated with the stream, as follows:

      • If the stream has not been opened, the specified object replaces any existing context, and is used in the initial stream handshake when the connection is opened.

      • If the stream has been opened without SSL enabled, setting this property initiates an SSL handshake over the existing socket.

      • After the initial SSL handshake occurs, changing the context object is unsupported.

      If an SSL settings dictionary is set for the kCFStreamPropertySSLSettings key, an SSLContextRef object is created internally and configured based on that dictionary. However, if an SSLContextRef object is set afterwards, its configuration takes precedence over the previously configured context.

      Available in OS X v10.9 and later.

    • kCFStreamPropertySOCKSProxy

      kCFStreamPropertySOCKSProxy

      SOCKS proxy property key.

      To set a CFStream object to use a SOCKS proxy, call CFReadStreamSetProperty or CFWriteStreamSetProperty with the property name set to kCFStreamPropertySOCKSProxy and its value set to a CFDictionary object having at minimum a kCFStreamPropertySOCKSProxyHost key and a kCFStreamPropertySOCKSProxyPort key. For information on these keys, see CFStream SOCKS Proxy Key Constants. SystemConfiguration returns a CFDictionary for SOCKS proxies that is usable without modification.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySSLSettings

      kCFStreamPropertySSLSettings

      SSL Settings property key for set operations.

      The key’s value is a CFDictionary object containing security settings. For information on the dictionary’s keys and values, see CFStream Property SSL Settings Constants. By default, there are no security settings.

      Available in OS X v10.4 and later.

    • kCFStreamPropertyProxyLocalBypass

      kCFStreamPropertyProxyLocalBypass

      Proxy Local Bypass property key.

      The key’s value is CFBoolean object whose value indicates whether local hostnames should be subject to proxy handling.

      Available in OS X v10.4 and later.

    • kCFStreamPropertySocketRemoteHost

      kCFStreamPropertySocketRemoteHost

      The key’s value is a CFHostRef for the remote host if it is known. If not, its value is NULL.

      Available in OS X version 10.3 and later.

    • kCFStreamPropertySocketRemoteNetService

      kCFStreamPropertySocketRemoteNetService

      The key’s value is a CFNetServiceRef for the remote network service if it is known. If not, its value is NULL.

      Available in OS X version 10.3 and later.

    • kCFStreamNetworkServiceType

      kCFStreamNetworkServiceType

      The type of service for the stream. Providing the service type allows the system to properly handle certain attributes of the stream, including routing and suspension behavior. Most streams do not need to set this property. See “Stream Service Types” for a list of possible values.

      Available in OS X v10.7 and later.

    • kCFStreamPropertyConnectionIsCellular

      kCFStreamPropertyConnectionIsCellular

      A boolean value indicating whether the stream is connected over a cellular (WWAN) interface. This is a read-only property, and is false until the connection has been established.

      Available in OS X v10.8 and later.

    • kCFStreamPropertyNoCellular

      kCFStreamPropertyNoCellular

      A boolean value indicating that the connection should not be established over a cellular (WWAN) connection. This value can be set only before you open the stream.

      Available in OS X v10.8 and later.

  • Constants for use in a CFDictionary object that is the value of the kCFStreamPropertySSLSettings stream property key.

    Declaration

    Swift

    let kCFStreamSSLLevel: CFString! let kCFStreamSSLValidatesCertificateChain: CFString! let kCFStreamSSLPeerName: CFString! let kCFStreamSSLCertificates: CFString! let kCFStreamSSLIsServer: CFString!

    Objective-C

    const CFStringRef kCFStreamSSLLevel; const CFStringRef kCFStreamSSLAllowsExpiredCertificates; const CFStringRef kCFStreamSSLAllowsExpiredRoots; const CFStringRef kCFStreamSSLAllowsAnyRoot; const CFStringRef kCFStreamSSLValidatesCertificateChain; const CFStringRef kCFStreamSSLPeerName; const CFStringRef kCFStreamSSLCertificates; const CFStringRef kCFStreamSSLIsServer;

    Constants

    • kCFStreamSSLLevel

      kCFStreamSSLLevel

      Security property key whose value specifies the stream’s security level.

      By default, a stream’s security level is kCFStreamSocketSecurityLevelNegotiatedSSL. For other possible values, see CFStream Socket Security Level Constants.

      Available in OS X v10.4 and later.

    • kCFStreamSSLAllowsExpiredCertificates

      kCFStreamSSLAllowsExpiredCertificates

      Security property key whose value indicates whether expired certificates are allowed.

      By default, the value of this key is kCFBooleanFalse (expired certificates are not allowed).

      Available in OS X v10.4 and later.

      Deprecated in OS X v10.6.

    • kCFStreamSSLAllowsExpiredRoots

      kCFStreamSSLAllowsExpiredRoots

      Security property whose value indicates whether expired root certificates are allowed.

      By default, the value of this key is kCFBooleanFalse (expired root certificates are not allowed).

      Available in OS X v10.4 and later.

      Deprecated in OS X v10.6.

    • kCFStreamSSLAllowsAnyRoot

      kCFStreamSSLAllowsAnyRoot

      Security property key whose value indicates whether root certificates should be allowed.

      By default, the value of this key is kCFBooleanFalse (root certificates are not allowed).

      Available in OS X v10.4 and later.

      Deprecated in OS X v10.6.

    • kCFStreamSSLValidatesCertificateChain

      kCFStreamSSLValidatesCertificateChain

      Security property key whose value indicates whether the certificate chain should be validated.

      By default, the value of this key is kCFBooleanTrue (the certificate chain should be validated).

      Available in OS X v10.4 and later.

    • kCFStreamSSLPeerName

      kCFStreamSSLPeerName

      Security property key whose value overrides the name used for certificate verification.

      By default, the host name that was used when the stream was created is used; if no host name was used, no peer name will be used. Set the value of this key to kCFNull to prevent name verification.

      Available in OS X v10.4 and later.

    • kCFStreamSSLCertificates

      kCFStreamSSLCertificates

      Security property key whose value is a CFArray of SecCertificateRefs except for the first element in the array, which is a SecIdentityRef.

      For more information, see SSLSetCertificate() in Security/SecureTransport.h.

      Available in OS X v10.4 and later.

    • kCFStreamSSLIsServer

      kCFStreamSSLIsServer

      Security property key whose value indicates whether the connection is to act as a server in the SSL process.

      By default, the value of this key is kCFBooleanFalse (the connection is not to act as a server). If the value of this key is kCFBooleanTrue, the kCFStreamSSLCertificates key must contain a valid value.

      Available in OS X v10.4 and later.

    Discussion

    This enumeration defines the constants for keys in a CFDictionary object that is the value of the kCFStreamPropertySSLSettings key.

  • Specifies constants for setting the security protocol for a socket stream.

    Declaration

    Objective-C

    typedef enum { kCFStreamSocketSecurityNone = 0, kCFStreamSocketSecuritySSLv2, kCFStreamSocketSecuritySSLv3, kCFStreamSocketSecuritySSLv23, kCFStreamSocketSecurityTLSv1 } CFStreamSocketSecurityProtocol;

    Constants

    • kCFStreamSocketSecurityNone

      kCFStreamSocketSecurityNone

      Specifies that no security protocol be set for a socket stream.

      Use kCFStreamSocketSecurityLevelNone.

      Available in OS X v10.1 and later.

      Deprecated in OS X v10.2.

    • kCFStreamSocketSecuritySSLv2

      kCFStreamSocketSecuritySSLv2

      Specifies that SSL version 2 be set as the security protocol for a socket stream.

      Use kCFStreamSocketSecurityLevelSSLv2.

      Available in OS X v10.1 and later.

      Deprecated in OS X v10.2.

    • kCFStreamSocketSecuritySSLv3

      kCFStreamSocketSecuritySSLv3

      Specifies that SSL version 3 be set as the security protocol for a socket stream.

      Use kCFStreamSocketSecurityLevelSSLv3.

      Available in OS X v10.1 and later.

      Deprecated in OS X v10.2.

    • kCFStreamSocketSecuritySSLv23

      kCFStreamSocketSecuritySSLv23

      Specifies that SSL version 3 be set as the security protocol for a socket stream pair. If that version is not available, specifies that SSL version 2 be set as the security protocol for a socket stream.

      Use kCFStreamSocketSecurityLevelNegotiatedSSL.

      Available in OS X v10.1 and later.

      Deprecated in OS X v10.2.

    • kCFStreamSocketSecurityTLSv1

      kCFStreamSocketSecurityTLSv1

      Specifies that TLS version 1 be set as the security protocol for a socket stream.

      Use kCFStreamSocketSecurityLevelTLSv1.

      Available in OS X v10.1 and later.

      Deprecated in OS X v10.2.

    Discussion

    This enumeration defines constants for setting the security protocol for a socket stream pair when calling CFSocketStreamPairSetSecurityProtocol.

    Import Statement

    Objective-C

    @import CFNetwork;

    Availability

    Available in OS X v10.1 through OS X v10.9.

  • Constants for setting the security level of a socket stream.

    Declaration

    Swift

    let kCFStreamSocketSecurityLevelNone: CFString! let kCFStreamSocketSecurityLevelSSLv2: CFString! let kCFStreamSocketSecurityLevelSSLv3: CFString! let kCFStreamSocketSecurityLevelTLSv1: CFString! let kCFStreamSocketSecurityLevelNegotiatedSSL: CFString!

    Objective-C

    const CFStringRef kCFStreamSocketSecurityLevelNone; const CFStringRef kCFStreamSocketSecurityLevelSSLv2; const CFStringRef kCFStreamSocketSecurityLevelSSLv3; const CFStringRef kCFStreamSocketSecurityLevelTLSv1; const CFStringRef kCFStreamSocketSecurityLevelNegotiatedSSL;

    Constants

    • kCFStreamSocketSecurityLevelNone

      kCFStreamSocketSecurityLevelNone

      Specifies that no security level be set.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSecurityLevelSSLv2

      kCFStreamSocketSecurityLevelSSLv2

      Specifies that SSL version 2 be set as the security protocol for a socket stream.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSecurityLevelSSLv3

      kCFStreamSocketSecurityLevelSSLv3

      Specifies that SSL version 3 be set as the security protocol for a socket stream pair.

      If SSL version 3 is not available, specifies that SSL version 2 be set as the security protocol for a socket stream.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSecurityLevelTLSv1

      kCFStreamSocketSecurityLevelTLSv1

      Specifies that TLS version 1 be set as the security protocol for a socket stream.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSecurityLevelNegotiatedSSL

      kCFStreamSocketSecurityLevelNegotiatedSSL

      Specifies that the highest level security protocol that can be negotiated be set as the security protocol for a socket stream.

      Available in OS X v10.2 and later.

    Discussion

    This enumeration defines the preferred constants for setting the security protocol for a socket stream pair when calling CFReadStreamSetProperty or CFWriteStreamSetProperty.

  • Constants for SOCKS Proxy CFDictionary keys.

    Declaration

    Swift

    let kCFStreamPropertySOCKSProxyHost: CFString! let kCFStreamPropertySOCKSProxyPort: CFString! let kCFStreamPropertySOCKSVersion: CFString! let kCFStreamSocketSOCKSVersion4: CFString! let kCFStreamSocketSOCKSVersion5: CFString! let kCFStreamPropertySOCKSUser: CFString! let kCFStreamPropertySOCKSPassword: CFString!

    Objective-C

    const CFStringRef kCFStreamPropertySOCKSProxyHost; const CFStringRef kCFStreamPropertySOCKSProxyPort; const CFStringRef kCFStreamPropertySOCKSVersion; const CFStringRef kCFStreamSocketSOCKSVersion4; const CFStringRef kCFStreamSocketSOCKSVersion5; const CFStringRef kCFStreamPropertySOCKSUser; const CFStringRef kCFStreamPropertySOCKSPassword;

    Constants

    • kCFStreamPropertySOCKSProxyHost

      kCFStreamPropertySOCKSProxyHost

      Constant for the SOCKS proxy host key.

      This key contains a CFString object that represents the SOCKS proxy host. Defined to match kSCPropNetProxiesSOCKSProxy.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySOCKSProxyPort

      kCFStreamPropertySOCKSProxyPort

      Constant for the SOCKS proxy host port key.

      This key contains a CFNumberRef object of type kCFNumberSInt32Type whose value represents the port on which the proxy listens.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySOCKSVersion

      kCFStreamPropertySOCKSVersion

      Constant for the SOCKS version key.

      Its value must be kCFStreamSocketSOCKSVersion4 or kCFStreamSocketSOCKSVersion5 to set SOCKS4 or SOCKS5, respectively. If this key is not present, SOCKS5 is used by default.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSOCKSVersion4

      kCFStreamSocketSOCKSVersion4

      Constant used in the kCFStreamSockerSOCKSVersion key to specify SOCKS4 as the SOCKS version for the stream.

      Available in OS X v10.2 and later.

    • kCFStreamSocketSOCKSVersion5

      kCFStreamSocketSOCKSVersion5

      Constant used in the kCFStreamSOCKSVersion key to specify SOCKS5 as the SOCKS version for the stream.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySOCKSUser

      kCFStreamPropertySOCKSUser

      Constant for the key required to set a user name.

      The value is a CFString object containing the user’s name.

      Available in OS X v10.2 and later.

    • kCFStreamPropertySOCKSPassword

      kCFStreamPropertySOCKSPassword

      Constant for the key required to set a user’s password.

      The value is a CFString object containing the user’s password.

      Available in OS X v10.2 and later.

    Discussion

    When setting the stream's SOCKS Proxy property, the property’s value is a CFDictionary object containing at minimum the kCFStreamPropertySOCKSProxyHost and kCFStreamPropertySOCKSProxyPort keys. The dictionary may also contain the other keys described in this section.

  • String constants that specify the service type of a stream.

    Declaration

    Swift

    let kCFStreamNetworkServiceTypeVoIP: CFString! let kCFStreamNetworkServiceTypeVideo: CFString! let kCFStreamNetworkServiceTypeBackground: CFString! let kCFStreamNetworkServiceTypeVoice: CFString!

    Objective-C

    CFStringRef const kCFStreamNetworkServiceTypeVoIP; const CFStringRef kCFStreamNetworkServiceTypeVideo; const CFStringRef kCFStreamNetworkServiceTypeBackground; const CFStringRef kCFStreamNetworkServiceTypeVoice;

    Constants

    • kCFStreamNetworkServiceTypeVoIP

      kCFStreamNetworkServiceTypeVoIP

      Specifies that the stream is providing VoIP service.

      Available in OS X v10.7 and later.

    • kCFStreamNetworkServiceTypeVideo

      kCFStreamNetworkServiceTypeVideo

      Specifies that the stream is providing interactive video data.

      Available in OS X v10.7 and later.

    • kCFStreamNetworkServiceTypeBackground

      kCFStreamNetworkServiceTypeBackground

      Specifies that the stream is a background download.

      Available in OS X v10.7 and later.

    • kCFStreamNetworkServiceTypeVoice

      kCFStreamNetworkServiceTypeVoice

      Specifies that the stream is providing interactive voice data.

      Available in OS X v10.7 and later.

  • Error domains specific to CFSocketStream calls.

    Declaration

    Swift

    let kCFStreamErrorDomainSOCKS: Int32 let kCFStreamErrorDomainSSL: Int32 let kCFStreamErrorDomainWinSock: CFIndex

    Objective-C

    extern const int kCFStreamErrorDomainSOCKS; extern const int kCFStreamErrorDomainSSL; extern const CFIndex kCFStreamErrorDomainWinSock;

    Constants

    • kCFStreamErrorDomainSOCKS

      kCFStreamErrorDomainSOCKS

      This domain returns error codes from the SOCKS layer. The errors are described in

      Available in OS X version 10.5 and later.

    • kCFStreamErrorDomainSSL

      kCFStreamErrorDomainSSL

      This domain returns error codes associated with the SSL layer. For a list of error codes, see the header SecureTransport.h in Security.framework.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorDomainWinSock

      kCFStreamErrorDomainWinSock

      When running CFNetwork code on Windows, this domain returns error codes associated with the underlying TCP/IP stack. You should also note that non-networking errors such as ENOMEM are delivered through the POSIX domain. See the header winsock2.h for relevant error codes.

      Available in OS X version 10.5 and later.

    Discussion

    To determine the source of an error, examine the userInfo dictionary included in the CFError object returned by a function call or call CFErrorGetDomain and pass in the CFError object and the domain whose value you want to read.

  • Subdomains used to determine how to interpret an error in the kCFStreamErrorDomainSOCKS domain.

    Declaration

    Objective-C

    enum { kCFStreamErrorSOCKSSubDomainNone = 0, kCFStreamErrorSOCKSSubDomainVersionCode = 1, kCFStreamErrorSOCKS4SubDomainResponse = 2, kCFStreamErrorSOCKS5SubDomainUserPass = 3, kCFStreamErrorSOCKS5SubDomainMethod = 4, kCFStreamErrorSOCKS5SubDomainResponse = 5 };

    Constants

    • kCFStreamErrorSOCKSSubDomainNone

      kCFStreamErrorSOCKSSubDomainNone

      The error code returned is a SOCKS error number.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKSSubDomainVersionCode

      kCFStreamErrorSOCKSSubDomainVersionCode

      The error returned contains the version of SOCKS that the server wishes to use.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS4SubDomainResponse

      kCFStreamErrorSOCKS4SubDomainResponse

      The error returned is the status code that the server returned after the last operation.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS5SubDomainUserPass

      kCFStreamErrorSOCKS5SubDomainUserPass

      This subdomain returns error codes associated with the last authentication attempt.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS5SubDomainMethod

      kCFStreamErrorSOCKS5SubDomainMethod

      This subdomain returns the server’s desired negotiation method.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS5SubDomainResponse

      kCFStreamErrorSOCKS5SubDomainResponse

      This subdomain returns the response code sent by the server when replying to a connection request.

      Available in OS X version 10.5 and later.

    Discussion

    Error codes in the kCFStreamErrorDomainSOCKS domain can come from multiple parts of the protocol stack, many of which define their own error values as part of outside specifications such as the HTTP specification.

    To avoid confusion from conflicting error numbers, error codes in the kCFStreamErrorDomainSOCKS domain contain two parts: a subdomain, which tells which part of the protocol stack generated the error, and the error code itself.

    Calling CFSocketStreamSOCKSGetErrorSubdomain returns an identifier that tells which layer of the protocol stack produced the error. This list of constants contains the possible values that this function will return.

    Calling CFSocketStreamSOCKSGetError returns the actual error code that the subdomain describes.

  • Error codes returned by the kCFStreamErrorDomainSOCKS error domain.

    Declaration

    Swift

    var kCFStreamErrorSOCKS5BadResponseAddr: Int { get } var kCFStreamErrorSOCKS5BadState: Int { get } var kCFStreamErrorSOCKSUnknownClientVersion: Int { get } var kCFStreamErrorSOCKS4RequestFailed: Int { get } var kCFStreamErrorSOCKS4IdentdFailed: Int { get } var kCFStreamErrorSOCKS4IdConflict: Int { get } var kSOCKS5NoAcceptableMethod: Int { get }

    Objective-C

    /* kCFStreamErrorSOCKSSubDomainNone */ enum { kCFStreamErrorSOCKS5BadResponseAddr = 1, kCFStreamErrorSOCKS5BadState = 2, kCFStreamErrorSOCKSUnknownClientVersion = 3 }; /* kCFStreamErrorSOCKS4SubDomainResponse */ enum { kCFStreamErrorSOCKS4RequestFailed = 91, kCFStreamErrorSOCKS4IdentdFailed = 92, kCFStreamErrorSOCKS4IdConflict = 93 }; /* kCFStreamErrorSOCKS5SubDomainMethod */ enum { kSOCKS5NoAcceptableMethod = 0xFF };

    Constants

    • kCFStreamErrorSOCKS5BadResponseAddr

      kCFStreamErrorSOCKS5BadResponseAddr

      The address returned is not of a known type. This error code is only valid for errors in the kCFStreamErrorSOCKSSubDomainNone subdomain.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS5BadState

      kCFStreamErrorSOCKS5BadState

      The stream is not in a state that allows the requested operation. This error code is only valid for errors in the kCFStreamErrorSOCKSSubDomainNone subdomain..

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKSUnknownClientVersion

      kCFStreamErrorSOCKSUnknownClientVersion

      The SOCKS server rejected access because it does not support connections with the requested SOCKS version. SOCKS client version. You can query the kCFSOCKSVersionKey key to find out what version the server requested. This error code is only valid for errors in the kCFStreamErrorSOCKSSubDomainNone subdomain.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS4RequestFailed

      kCFStreamErrorSOCKS4RequestFailed

      Request rejected by the server or request failed. This error is specific to SOCKS4. This error code is only valid for errors in the kCFStreamErrorSOCKS4SubDomainResponse subdomain.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS4IdentdFailed

      kCFStreamErrorSOCKS4IdentdFailed

      Request rejected by the server because it could not connect to the identd daemon on the client. This error is specific to SOCKS4. This error code is only valid for errors in the kCFStreamErrorSOCKS4SubDomainResponse subdomain.

      Available in OS X version 10.5 and later.

    • kCFStreamErrorSOCKS4IdConflict

      kCFStreamErrorSOCKS4IdConflict

      Request rejected by the server because the client program and the identd daemon reported different user IDs. This error is specific to SOCKS4. This error code is only valid for errors in the kCFStreamErrorSOCKS4SubDomainResponse subdomain.

      Available in OS X version 10.5 and later.

    • kSOCKS5NoAcceptableMethod

      kSOCKS5NoAcceptableMethod

      The client and server could not find a mutually agreeable authentication method. This error code is only valid for errors in the kCFStreamErrorSOCKS5SubDomainMethod subdomain.

      Available in OS X version 10.5 and later.

    Discussion

    Error codes in the kCFStreamErrorDomainSOCKS domain can come from multiple parts of the protocol stack, many of which define their own error values as part of outside specifications such as the HTTP specification.

    To avoid confusion from conflicting error numbers, error codes in the kCFStreamErrorDomainSOCKS domain contain two parts: a subdomain, which tells which part of the protocol stack generated the error, and the error code itself.

    Calling CFSocketStreamSOCKSGetErrorSubdomain returns an identifier that tells which layer of the protocol stack produced the error.

    Calling CFSocketStreamSOCKSGetError returns the actual error code that the subdomain describes. This list of constants contains the possible values that this function will return. They must be interpreted within the context of the relevant error subdomain.