NSStream Class

Definition

Abstract class for Foundation Streams.

[Foundation.Register("NSStream", true)]
public class NSStream : Foundation.NSObject
type NSStream = class
    inherit NSObject
Inheritance
NSStream
Derived
Attributes

Remarks

There are a number of properties that can be set on an NSStream by using the indexer on the stream and setting one of the available properties.   This is an abstract class, you will usually consume one of the concrete subclasses NSInputStream or NSOutputStream.

Using Streams

Unless the application is polling for data to become available on the stream, NSStreams can be used as event-driven stream sources. To use a stream, application developers create it and set its Delegate property to point to a NSStreamDelegate instance. This delegate will receive notifications when the connection has opened, when data can be written or read, and when the connection has terminated. Once this is setup, the developer registers the stream with a run loop, and waits for the notifications to be delivered to the delegate. Developers must call the Open method for the stream to start operating.

Constructors

NSStream()

Default constructor that initializes a new instance of this class with no parameters.

NSStream(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSStream(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

DataWrittenToMemoryStream

NSData containing the stream data that you have written so far.

DataWrittenToMemoryStreamKey

Low-level key: Represents the value associated with the constant NSStreamDataWrittenToMemoryStreamKey

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate

An instance of the Foundation.INSStreamDelegate model class which acts as the class delegate.

Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Error

Current stream error (if any).

FileCurrentOffset

Absolute offset of the stream.

FileCurrentOffsetKey

Low-level key: Represents the value associated with the constant NSStreamFileCurrentOffsetKey

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
Item[NSString]

Sets a configuration key on the NSStream.

NetworkServiceType

The low-level service type that this stream is providing.

NetworkServiceTypeBackground

Low-level key: Represents the value associated with the constant NSStreamNetworkServiceTypeBackground

NetworkServiceTypeCallSignaling
NetworkServiceTypeVideo

Low-level key: Represents the value associated with the constant NSStreamNetworkServiceTypeVideo

NetworkServiceTypeVoice

Low-level key: Represents the value associated with the constant NSStreamNetworkServiceTypeVoice

NetworkServiceTypeVoIP

Low-level key: Represents the value associated with the constant NSStreamNetworkServiceTypeVoIP

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
ServiceType

The service type that the stream is providing.

SocketSecurityLevel

Controls the security protocol is used for the connection (none, SSL, TLS, negotiated).

SocketSecurityLevelKey

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelKey

SocketSecurityLevelNegotiatedSsl

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelNegotiatedSSL

SocketSecurityLevelNone

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelNone

SocketSecurityLevelSslV2

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelSSLv2

SocketSecurityLevelSslV3

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelSSLv3

SocketSecurityLevelTlsV1

Low-level key: Represents the value associated with the constant NSStreamSocketSecurityLevelTLSv1

SocketSslErrorDomain

Low-level key: Represents the value associated with the constant NSStreamSocketSSLErrorDomain

SocksErrorDomain

Low-level key: Represents the value associated with the constant NSStreamSOCKSErrorDomain

SocksOptions

Settings for using a SOCKS proxy server.

SocksProxyConfigurationKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyConfigurationKey

SocksProxyHostKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyHostKey

SocksProxyPasswordKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyPasswordKey

SocksProxyPortKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyPortKey

SocksProxyUserKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyUserKey

SocksProxyVersion4

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyVersion4

SocksProxyVersion5

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyVersion5

SocksProxyVersionKey

Low-level key: Represents the value associated with the constant NSStreamSOCKSProxyVersionKey

Status
Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
WeakDelegate

An object that can respond to the delegate protocol for this type

Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)
Obsolete.
(Inherited from NSObject)
BindingInfo(String)
Obsolete.
(Inherited from NSObject)
BindingOptionDescriptions(String)
Obsolete.
(Inherited from NSObject)
BindingValueClass(String)
Obsolete.
(Inherited from NSObject)
Close()

Closes the stream and releases resources associated with it.

CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
CreateBoundPair(NSInputStream, NSOutputStream, nint)
CreatePairWithPeerSocketSignature(AddressFamily, SocketType, ProtocolType, IPEndPoint, NSInputStream, NSOutputStream)
CreatePairWithSocket(CFSocket, NSInputStream, NSOutputStream)
CreatePairWithSocketToHost(IPEndPoint, NSInputStream, NSOutputStream)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSStream object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetBoundStreams(nuint, NSInputStream, NSOutputStream)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String)
Obsolete.
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetProperty(NSString)
GetStreamsToHost(String, nint, NSInputStream, NSOutputStream)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
Open()
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
Schedule(NSRunLoop, NSRunLoopMode)
Schedule(NSRunLoop, String)

Schedules the stream to run on the specified run loop with the specified mode.

SetNativeField(String, NSObject)
Obsolete.
(Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetProperty(NSObject, NSString)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
Obsolete.
(Inherited from NSObject)
Unschedule(NSRunLoop, NSRunLoopMode)
Unschedule(NSRunLoop, String)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Events

OnEvent

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also