NSInputStream Class

Definition

Namespace:

Foundation

Assembly:

Xamarin.iOS.dll

A read-only input NSStream.

[Foundation.Register("NSInputStream", true)]
public class NSInputStream : Foundation.NSStream

type NSInputStream = class
    inherit NSStream

Inheritance

Object

NSObject

NSStream

NSInputStream

Attributes

RegisterAttribute

Remarks

Subclassing NSInputStream.

NSInputStream is a concrete subclass of NSStream you can use to give read-only access to stream data. For most cases this is sufficient, however if you want more control over the data, you can subclass NSInputStream. If you subclass NSInputStream you must provide an implementation of the following methods:

• M:Foundation.NSInputStream.Read(IntPtr,uint): In this method you must write bytes to the provided buffer. You can use M:System.Runtime.InteropServices.Marshal.Copy(byte[],int,IntPtr,int) to write from a byte array to the provided buffer. Return the number of bytes actually written. :
• GetBuffer(IntPtr, nuint): Return a pointer to a buffer where bytes can be read. You can return false from this method and just implement M:Foundation.NSInputStream.Read(IntPtr,uint). :
• HasBytesAvailable(): Use this method to indicate when your stream has data to be read. :

Providing a toll-free bridged NSInputStream subclass.

The methods required to provide a toll-free bridged NSInputStream subclass are considered private API, and may cause Apple to reject your app from the App Store.

An simple NSInputStream subclass will not work for all API that takes an NSInputStream. This is the case with NSMutableUrlRequest for instance, which actually expects an instance of a CFReadStream object. For this to work our NSInputStream subclass needs to be toll-free bridged to CFReadStream. This is done by overriding the following methods:

• SetCFClientFlags(CFStreamEventType, IntPtr, IntPtr): This method is called to register a client to notify of events in your stream. You must call the base implementation, with the exact arguments passed in. :
• M:Foundation.NSInputStream.ScheduleInCFRunLoop(IntPtr,string): Depending on what you're doing to provide the data, you will need to schedule in a run loop when this method is called. You should not call the base implementation for this method. :
• M:Foundation.NSInputStream.UnscheduleInCFRunLoop(IntPtr,string): This is called when you need to unschedule from a run loop. You should not call the base implementation for this method. :

You must call also M:Foundation.NSInputStream.Notify((valuetype CoreFoundation.CFStreamEventType) to inform the client when you have data available (or when you have any other relevant event), otherwise your input stream won't be read from.

Constructors

NSInputStream()	Default constructor that initializes a new instance of this class with no parameters.
NSInputStream(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
NSInputStream(NSData)
NSInputStream(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
NSInputStream(NSUrl)
NSInputStream(String)

Properties

Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DataWrittenToMemoryStream	NSData containing the stream data that you have written so far. (Inherited from NSStream)
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. (Inherited from NSStream)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
Error	Current stream error (if any). (Inherited from NSStream)
FileCurrentOffset	Absolute offset of the stream. (Inherited from NSStream)
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. (Inherited from NSStream)
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. (Inherited from NSStream)
SocketSecurityLevel	Controls the security protocol is used for the connection (none, SSL, TLS, negotiated). (Inherited from NSStream)
SocksOptions	Settings for using a SOCKS proxy server. (Inherited from NSStream)
Status	(Inherited from NSStream)
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 (Inherited from NSStream)
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)	(Inherited from NSObject)
BindingInfo(String)	(Inherited from NSObject)
BindingOptionDescriptions(String)	(Inherited from NSObject)
BindingValueClass(String)	(Inherited from NSObject)
Close()	Closes the stream and releases resources associated with it. (Inherited from NSStream)
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)
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 NSInputStream 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)
FromData(NSData)
FromFile(String)
FromUrl(NSUrl)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetBuffer(IntPtr, nuint)	This method can return a pointer to a buffer the caller can read data from.
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)	(Inherited from NSStream)
HasBytesAvailable()	Returna a boolean value indicating whether the stream has bytes available to be read.
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(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)
Notify(CFStreamEventType)	Notifies consumers of events in the stream.
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()	(Inherited from NSStream)
PerformSelector(Selector, NSObject, Double, NSString[])	(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, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
Read(Byte[], Int32, nuint)
Read(Byte[], nuint)	Reads data from the stream into the provided buffer.
Read(IntPtr, nuint)	Reads data from the stream into the provided buffer. You should not call this method directly, you should call M:Foundation.NSInputStream.Read(byte[],uint) instead. This method is for NSInputStream subclasses to implement.
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, NSString)	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)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
Schedule(NSRunLoop, NSRunLoopMode)	(Inherited from NSStream)
Schedule(NSRunLoop, String)	Schedules the stream to run on the specified run loop with the specified mode. (Inherited from NSStream)
SetCFClientFlags(CFStreamEventType, IntPtr, IntPtr)	Adds a client for the stream. This method is not supposed to be called by managed code, it will be called by consumers of the stream. When overriding it make sure to call the base implementation.
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetProperty(NSObject, NSString)	(Inherited from NSStream)
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)	(Inherited from NSObject)
Unschedule(NSRunLoop, NSRunLoopMode)	(Inherited from NSStream)
Unschedule(NSRunLoop, String)	(Inherited from NSStream)
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

(Inherited from NSStream)

Extension Methods

GetDebugDescription(INSObjectProtocol)
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.

See also

• Apple documentation for NSInputStream