Platforms to show: All Mac Windows Linux Cross-Platform

Back to CFStreamMBS class.

CFStreamMBS.kCFHTTPAuthenticationSchemeBasic as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the authentication schemes available.

CFStreamMBS.kCFHTTPAuthenticationSchemeDigest as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the authentication schemes available.

CFStreamMBS.kCFHTTPVersion1_0 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
HTTP Version 1.0.

CFStreamMBS.kCFHTTPVersion1_1 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
HTTP Version 1.1.

CFStreamMBS.kCFStreamErrorDomainHTTP as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
An error domain used with the socket based streams.

Possible error values:
kCFStreamErrorHTTPParseFailure = -1
kCFStreamErrorHTTPRedirectionLoop = -2
kCFStreamErrorHTTPBadURL = -3

CFStreamMBS.kCFStreamErrorDomainSOCKS as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
SOCKS proxy error domain.

CFStreamMBS.kCFStreamErrorDomainSSL as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
An error domain used with the socket based streams.

Secure stream support.

CFStreamMBS.kCFStreamPropertyAppendToFile as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Whether to append new bytes to an existing file.

Property for file write streams; value should be a CFBoolean.
Set to TRUE to append to a file, rather than to replace its contents.
Requires Mac OS X 10.2

CFStreamMBS.kCFStreamPropertyDataWritten as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
A property name for use with the CFWriteStream class.
Example
dim writestream as CFWriteStreamMBS
dim c as cfobjectmbs
c=writestream.getproperty(writestream.kCFStreamPropertyDataWritten)

Value will be a CFData containing all bytes thusfar written; used to recover the data written to a memory write stream.

CFStreamMBS.kCFStreamPropertyHTTPAttemptPersistentConnection as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value should be a CFBoolean. If this property is set to true, an HTTP stream will look for an appropriate extant persistent connection to use, and if it finds none, will try to create one.

CFStreamMBS.kCFStreamPropertyHTTPFinalURL as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value is the CFURL from the final request; will only differ from the URL in the original request if an autoredirection has occurred.

CFStreamMBS.kCFStreamPropertyHTTPProxy as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Which HTTP Proxy to use.

HTTP proxy information is set the same way as SOCKS proxies.
Call CFReadStream.SetProperty() passing an HTTP stream and the property kCFStreamPropertyHTTPProxy.
The value should be a CFDictionary that includes at least one Host/Port pair from the keys below.
The dictionary returned by SystemConfiguration.framework can also be passed directly as the value

Keys for the dictionary to use:
kCFStreamPropertyHTTPProxyHost
kCFStreamPropertyHTTPProxyPort
kCFStreamPropertyHTTPSProxyHost
kCFStreamPropertyHTTPSProxyPort

CFStreamMBS.kCFStreamPropertyHTTPProxyHost as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the keys for the proxy CFDictionary for a socket based stream.

CFStreamMBS.kCFStreamPropertyHTTPProxyPort as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the keys for the proxy CFDictionary for a socket based stream.

CFStreamMBS.kCFStreamPropertyHTTPResponseHeader as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value is a CFHTTPMessage with 0 bytes data.

CFStreamMBS.kCFStreamPropertyHTTPShouldAutoredirect as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value should be a CFBoolean.

CFStreamMBS.kCFStreamPropertyHTTPSProxyHost as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the keys for the proxy CFDictionary for a socket based stream.

CFStreamMBS.kCFStreamPropertyHTTPSProxyPort as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the keys for the proxy CFDictionary for a socket based stream.

CFStreamMBS.kCFStreamPropertyShouldCloseNativeSocket as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Set the value to kCFBooleanTrue if the stream should close and release the underlying native socket when the stream is released. Set the value to kCFBooleanFalse to keep the native socket from closing and releasing when the stream is released.

If the stream was created with a native socket, the default property setting on the stream is kCFBooleanFalse.

The kCFStreamPropertyShouldCloseNativeSocket can be set through CFReadStream.SetProperty or CFWriteStream.SetProperty. The property can be copied through CFReadStream.GetProperty or CFWriteStream.GetProperty.

CFStreamMBS.kCFStreamPropertySocketNativeHandle as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value will be a CFData containing the native handle.

CFStreamMBS.kCFStreamPropertySocketRemoteHostName as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value will be a CFString, or nil if unknown.

CFStreamMBS.kCFStreamPropertySocketRemotePortNumber as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

Value will be a CFNumber, or nil if unknown.

CFStreamMBS.kCFStreamPropertySocketSecurityLevel as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

You set this property to one of the following values:
kCFStreamSocketSecurityLevelSSLv3
kCFStreamSocketSecurityLevelSSLv2
kCFStreamSocketSecurityLevelNone
kCFStreamSocketSecurityLevelNegotiatedSSL
kCFStreamSocketSecurityLevelTLSv1
(this 5 properties return CFStrings which you pass to SetProperty)

CFStreamMBS.kCFStreamPropertySOCKSPassword as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

CFStreamMBS.kCFStreamPropertySOCKSProxy as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

SOCKS Proxy usage
To set a stream to use a SOCKS proxy, call CFReadStream.SetProperty or CFWriteStream.SetProperty with the property name set to kCFStreamPropertySOCKSProxy and the value being a CFDictionary with at least the following two keys: kCFStreamPropertySOCKSProxyHost and kCFStreamPropertySOCKSProxyPort.
The dictionary returned by SystemConfiguration for SOCKS proxies will work without alteration.
The key kCFStreamPropertySOCKSProxyHost should contain a CFStringRef value representing the SOCKS proxy host. The key kCFStreamPropertySOCKSProxyPort should contain a CFNumberRef which itself is of type kCFNumberSInt32Type. This value should represent the port on which the proxy is listening.

By default, SOCKS5 will be used unless there is a kCFStreamPropertySOCKSVersion key in the CFDictionary. Its value must be kCFStreamSocketSOCKSVersion4 or kCFStreamSocketSOCKSVersion5 to set SOCKS4 or SOCKS5, respectively.

To set a user name and/or password, if required, the dictionary must contain the key(s) kCFStreamPropertySOCKSUser and/or kCFStreamPropertySOCKSPassword with the value being the user's name as a CFString and/or the user's password as a CFString, respectively.

kCFStreamPropertySOCKSProxy can be set through CFReadStream.SetProperty or CFWriteStream.SetProperty. The property can be copied through CFReadStream.GetProperty or CFWriteStream.GetProperty.

CFStreamMBS.kCFStreamPropertySOCKSProxyHost as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

CFStreamMBS.kCFStreamPropertySOCKSProxyPort as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

CFStreamMBS.kCFStreamPropertySOCKSUser as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

CFStreamMBS.kCFStreamPropertySOCKSVersion as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for a socket based stream.

CFStreamMBS.kCFStreamSocketSecurityLevelNegotiatedSSL as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property values for a socket based stream.

TLS or SSL with fallback to lower versions; this is what HTTPS does, for instance.

CFStreamMBS.kCFStreamSocketSecurityLevelNone as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property values for a socket based stream.

CFStreamMBS.kCFStreamSocketSecurityLevelSSLv2 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property values for a socket based stream.

CFStreamMBS.kCFStreamSocketSecurityLevelSSLv3 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property values for a socket based stream.

CFStreamMBS.kCFStreamSocketSecurityLevelTLSv1 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property values for a socket based stream.

CFStreamMBS.kCFStreamSocketSOCKSVersion4 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the values used with the kCFStreamPropertySOCKSVersion property for a socket based stream.

CFStreamMBS.kCFStreamSocketSOCKSVersion5 as CFStringMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreFoundation Network MBS MacCF Plugin 3.3 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the values used with the kCFStreamPropertySOCKSVersion property for a socket based stream.

The items on this page are in the following plugins: MBS MacCF Plugin.


The biggest plugin in space...