Inherits System::IDisposable.

Inherited by Aspose::Zip::CrcCalculatorStream, Aspose::Zip::ZlibBaseStream, System::IO::BufferedStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::UnmanagedMemoryStream, System::Net::Security::AuthenticatedStream, System::Net::Sockets::NetworkStream, and System::Security::Cryptography::CryptoStream.

Public Types
typedef SharedPtr< Stream >	Ptr
	An alias for a shared pointer to this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. More...

Public Member Functions
virtual ASPOSECPP_SHARED_API int	ReadByte ()

virtual ASPOSECPP_SHARED_API void	WriteByte (uint8_t value)

virtual ASPOSECPP_SHARED_API int	Read (ArrayPtr< uint8_t > buffer, int offset, int count)=0

virtual ASPOSECPP_SHARED_API void	Write (ArrayPtr< uint8_t > buffer, int offset, int count)=0

virtual ASPOSECPP_SHARED_API int64_t	Seek (int64_t offset, SeekOrigin origin)=0

virtual ASPOSECPP_SHARED_API void	SetLength (int64_t value)=0

virtual ASPOSECPP_SHARED_API void	Flush ()=0
	Clears this stream's buffers and writes all buffered data to the underlying storage. More...

virtual void	Close ()
	Closes the stream. More...

virtual ASPOSECPP_SHARED_API void	Dispose () override
	Releases all resources used by the current object and closes the stream. More...

virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResult >	BeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)

virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResult >	BeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)

virtual ASPOSECPP_SHARED_API int	EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)

virtual ASPOSECPP_SHARED_API void	EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)

virtual ASPOSECPP_SHARED_API void	set_Position (int64_t value)=0

virtual ASPOSECPP_SHARED_API int64_t	get_Position () ASPOSE_CONST=0
	Returns the current position of the stream. More...

virtual ASPOSECPP_SHARED_API int64_t	get_Length () ASPOSE_CONST=0
	Returns the length of the stream in bytes. More...

virtual ASPOSECPP_SHARED_API bool	get_CanRead () ASPOSE_CONST=0

virtual ASPOSECPP_SHARED_API bool	get_CanSeek () ASPOSE_CONST=0

virtual ASPOSECPP_SHARED_API bool	get_CanWrite () ASPOSE_CONST=0

virtual ASPOSECPP_SHARED_API bool	get_CanTimeout () ASPOSE_CONST
	Gets a value that determines whether the current stream can time out. More...

virtual ASPOSECPP_SHARED_API void	set_ReadTimeout (int timeout)

virtual ASPOSECPP_SHARED_API int	get_ReadTimeout () ASPOSE_CONST
	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. More...

virtual ASPOSECPP_SHARED_API void	set_WriteTimeout (int timeout)

virtual ASPOSECPP_SHARED_API int	get_WriteTimeout () ASPOSE_CONST
	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. More...

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared refernce counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () ASPOSE_CONST
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (unsigned int argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Static Public Attributes
static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API	Null
	A stream with no underlying storage. More...

Protected Member Functions
virtual ASPOSECPP_SHARED_API void	Dispose (bool disposing)

Additional Inherited Members
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

A base class for a variety of stream implementations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

typedef SharedPtr<Stream> System::IO::Stream::Ptr

An alias for a shared pointer to this class.

Member Function Documentation

◆ BeginRead()

virtual ASPOSECPP_SHARED_API System::SharedPtr<System::IAsyncResult> System::IO::Stream::BeginRead	(	System::ArrayPtr< uint8_t >	buffer,
		int	offset,
		int	count,
		System::AsyncCallback	callback,
		System::SharedPtr< System::Object >	state
	)

virtual

Initiates an asynchronous read operation.

Parameters

buffer	A buffer to read to
offset	A 0-based offset in `buffer` indicating the position from which to start writing the read data
count	The number of bytes to read
callback	A callback to be called when the operation completes
state	User-provided data used to uniquly identify each particular asynchronous read operation

Returns: An IAsyncResult object representing the initiated asynchronous read operation

◆ BeginWrite()

virtual ASPOSECPP_SHARED_API System::SharedPtr<System::IAsyncResult> System::IO::Stream::BeginWrite	(	System::ArrayPtr< uint8_t >	buffer,
		int	offset,
		int	count,
		System::AsyncCallback	callback,
		System::SharedPtr< System::Object >	state
	)

virtual

Initiates an asynchronous write operation.

Parameters

buffer	A buffer containing data to be written
offset	A 0-based offset in `buffer` indicating the position from which the data to write begins
count	The number of bytes to write
callback	A callback to be called when the operation completes
state	User-provided data used to uniquly identify each particular asynchronous write operation

Returns: An IAsyncResult object representing the initiated asynchronous write operation

◆ Close()

virtual void System::IO::Stream::Close ( )

inlinevirtual

Closes the stream.

Reimplemented in System::Net::Security::SslStream, System::IO::MemoryStream, System::IO::FileStream, and System::Security::Cryptography::CryptoStream.

◆ Dispose() [1/2]

virtual ASPOSECPP_SHARED_API void System::IO::Stream::Dispose ( )

overridevirtual

Releases all resources used by the current object and closes the stream.

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

virtual ASPOSECPP_SHARED_API void System::IO::Stream::Dispose ( bool disposing )

protectedvirtual

Releases all resources used by the current object and closes the stream.

Parameters

disposing Specifies whether the stream should be closed.

Reimplemented in System::IO::UnmanagedMemoryStream, and System::Net::Security::SslStream.

◆ EndRead()

virtual ASPOSECPP_SHARED_API int System::IO::Stream::EndRead ( System::SharedPtr< System::IAsyncResult > asyncResult )

virtual

Waits until the specified asynchronous read operation completes.

Parameters

asyncResult An IAsyncResult object that represents an asynchronous read operation

Returns: The number of bytes read during the read operation represented by asyncResult

◆ EndWrite()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::EndWrite ( System::SharedPtr< System::IAsyncResult > asyncResult )

virtual

Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes.

Parameters

asyncResult An IAsyncResult object that represents an asynchronous write operation

◆ Flush()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::Flush ( )

pure virtual

Clears this stream's buffers and writes all buffered data to the underlying storage.

Implemented in System::IO::UnmanagedMemoryStream, System::Net::Security::SslStream, System::IO::FileStream, System::IO::MemoryStream, System::Net::Sockets::NetworkStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ get_CanRead()

virtual ASPOSECPP_SHARED_API bool System::IO::Stream::get_CanRead ( )

pure virtual

Determines if the stream is readable.

Returns: True if the stream is readable; otherwise - false

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, System::IO::FileStream, and System::Net::Sockets::NetworkStream.

◆ get_CanSeek()

virtual ASPOSECPP_SHARED_API bool System::IO::Stream::get_CanSeek ( )

pure virtual

Determines if the stream supports seeking.

Returns: True if the stream supports seeking; otherwise - false

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, System::IO::FileStream, and System::Net::Sockets::NetworkStream.

◆ get_CanTimeout()

virtual ASPOSECPP_SHARED_API bool System::IO::Stream::get_CanTimeout ( )

virtual

Gets a value that determines whether the current stream can time out.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ get_CanWrite()

virtual ASPOSECPP_SHARED_API bool System::IO::Stream::get_CanWrite ( )

pure virtual

Determines if the stream is writable.

Returns: True if the stream is writable; otherwise - false

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, System::IO::FileStream, and System::Net::Sockets::NetworkStream.

◆ get_Length()

virtual ASPOSECPP_SHARED_API int64_t System::IO::Stream::get_Length ( )

pure virtual

Returns the length of the stream in bytes.

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::FileStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, and System::Net::Sockets::NetworkStream.

◆ get_Position()

virtual ASPOSECPP_SHARED_API int64_t System::IO::Stream::get_Position ( )

pure virtual

Returns the current position of the stream.

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::FileStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, and System::Net::Sockets::NetworkStream.

◆ get_ReadTimeout()

virtual ASPOSECPP_SHARED_API int System::IO::Stream::get_ReadTimeout ( )

virtual

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ get_WriteTimeout()

virtual ASPOSECPP_SHARED_API int System::IO::Stream::get_WriteTimeout ( )

virtual

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.

Reimplemented in System::Net::Security::SslStream, and System::Net::Sockets::NetworkStream.

◆ Read()

virtual ASPOSECPP_SHARED_API int System::IO::Stream::Read	(	ArrayPtr< uint8_t >	buffer,
		int	offset,
		int	count
	)

pure virtual

Reads the specified number of bytes from the stream and writes them to the specified byte array.

Parameters

buffer	The byte array to write the read bytes to
offset	A 0-based position in `buffer` to start writing at
count	The number of bytes to read

Returns: The number of bytes read

Implemented in System::IO::MemoryStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ ReadByte()

virtual ASPOSECPP_SHARED_API int System::IO::Stream::ReadByte ( )

virtual

Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte.

Reimplemented in System::IO::FileStream, System::IO::MemoryStream, and System::IO::BufferedStream.

◆ Seek()

virtual ASPOSECPP_SHARED_API int64_t System::IO::Stream::Seek	(	int64_t	offset,
		SeekOrigin	origin
	)

pure virtual

Sets the position of the stream represented by the current object.

Parameters

offset	The byte offset relative to a position specified by `origin`
origin	Specifies the position from which and the direction toward which the offset is calculated

Returns: The new position of the stream

Implemented in System::IO::UnmanagedMemoryStream, System::Net::Security::SslStream, System::IO::FileStream, System::IO::MemoryStream, System::IO::BufferedStream, System::Net::Sockets::NetworkStream, and System::Security::Cryptography::CryptoStream.

◆ set_Position()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::set_Position ( int64_t value )

pure virtual

Sets the stream's position.

Parameters

value The byte offset to set the stream's position to

Implemented in System::IO::UnmanagedMemoryStream, System::IO::MemoryStream, System::Net::Security::SslStream, System::IO::FileStream, System::IO::BufferedStream, System::Security::Cryptography::CryptoStream, and System::Net::Sockets::NetworkStream.

◆ set_ReadTimeout()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::set_ReadTimeout ( int timeout )

virtual

◆ set_WriteTimeout()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::set_WriteTimeout ( int timeout )

virtual

◆ SetLength()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::SetLength ( int64_t value )

pure virtual

Sets the length of the stream represented by the current object.

Parameters

value The length in bytes to set

Implemented in System::IO::UnmanagedMemoryStream, System::IO::FileStream, System::Net::Security::SslStream, System::IO::MemoryStream, System::Net::Sockets::NetworkStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ Write()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::Write	(	ArrayPtr< uint8_t >	buffer,
		int	offset,
		int	count
	)

pure virtual

Writes the specified subrange of bytes from the specified byte array to the stream.

Parameters

buffer	The array containing the bytes to write
offset	A 0-based index of the elemnet in `buffer` at which the subrange to write begins
count	The number of elements in the subrange to write

Implemented in System::IO::MemoryStream, System::IO::BufferedStream, and System::Security::Cryptography::CryptoStream.

◆ WriteByte()

virtual ASPOSECPP_SHARED_API void System::IO::Stream::WriteByte ( uint8_t value )

virtual

Writes the specified unsigned 8-bit integer value to the stream.

Parameters

value The value to write

Reimplemented in System::IO::FileStream, System::IO::MemoryStream, and System::IO::BufferedStream.

Member Data Documentation

◆ Null

const System::SharedPtr<Stream> ASPOSECPP_SHARED_API System::IO::Stream::Null

static

A stream with no underlying storage.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Function Documentation

◆ BeginRead()

◆ BeginWrite()

◆ Close()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ EndRead()

◆ EndWrite()

◆ Flush()

◆ get_CanRead()

◆ get_CanSeek()

◆ get_CanTimeout()

◆ get_CanWrite()

◆ get_Length()

◆ get_Position()

◆ get_ReadTimeout()

◆ get_WriteTimeout()

◆ Read()

◆ ReadByte()

◆ Seek()

◆ set_Position()

◆ set_ReadTimeout()

◆ set_WriteTimeout()

◆ SetLength()

◆ Write()

◆ WriteByte()

Member Data Documentation

◆ Null