System::IO::BufferedStream Class Reference

Adds a buffering layer on top of another stream. More...

Inherits System::IO::Stream.

Public Member Functions

 BufferedStream (const SharedPtr< Stream > &stream)
 
 BufferedStream (const SharedPtr< Stream > &stream, int bufferSize)
 
virtual ~BufferedStream ()
 Destructor. More...
 
virtual int ReadByte () override
 
virtual void WriteByte (uint8_t value) override
 
virtual int Read (ArrayPtr< uint8_t > buffer, int offset, int count) override
 
virtual void Write (ArrayPtr< uint8_t > buffer, int offset, int count) override
 
virtual int64_t Seek (int64_t offset, SeekOrigin origin) override
 
virtual void SetLength (int64_t value) override
 
virtual void Flush () override
 Writes the content of the buffer to the underlying stream. More...
 
virtual void set_Position (int64_t value) override
 
virtual int64_t get_Position () ASPOSE_CONST override
 Returns the current position of the stream. More...
 
virtual int64_t get_Length () ASPOSE_CONST override
 Returns the length of the stream. More...
 
virtual bool get_CanRead () ASPOSE_CONST override
 
virtual bool get_CanSeek () ASPOSE_CONST override
 
virtual bool get_CanWrite () ASPOSE_CONST override
 
- Public Member Functions inherited from System::IO::Stream
virtual void Close ()
 Closes the stream. More...
 
virtual void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 
virtual int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 
virtual void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
void SharedRefRemoved ()
 Decrements shared reference count and deletes object if it hits zero. Shouldn't be called directly; instead, use smart pointers or ThisProtector. 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...
 
void FreeOrDetectCycles (int count)
 Reacts on shared reference counter decrement. Shouldn't be called directly, use smart pointers instead. If neccessary, deletes the object. If allowed, initiates loop references lookup. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. TypeInfo structure descibing the type to test current object against. More...
 
void __FreePointers ()
 Resets all smart pointers stored inside this object directly (in fields) or indirectly (in value type fields). Used by memory management systems, shouldn't be called directly. More...
 
virtual 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)
 

Additional Inherited Members

- Public Types inherited from System::IO::Stream
typedef SharedPtr< StreamPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
static void __FreeStaticPointers ()
 Implementation of cleanup_tests option. Deletes shared members of type it is called for. Nothing to delete at this level. More...
 
- Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API Null
 A stream with no underlying storage. More...
 
- Protected Types inherited from System::Object
template<class T >
using supports_free_pointers = decltype(__SupportsFreePointers(std::declval< T * >()))
 Checks if T type supports __FreePointers() method. More...
 
- Protected Member Functions inherited from System::IO::Stream
virtual void Dispose (bool disposing)
 
- Protected Member Functions inherited from System::Object
virtual shared_members_type GetSharedMembers ()
 Gets list of non-null shared pointers. More...
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if<!System::IsSmartPtr< Value >::value &&!System::detail::is_a< Value, std::pair >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::IsSmartPtr< Value >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
- Static Protected Member Functions inherited from System::Object
template<class T , class Check = decltype(std::declval<T*>()->__FreePointers())>
static std::true_type __SupportsFreePointers (T *)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
static std::false_type __SupportsFreePointers (...)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
template<class T >
static std::enable_if< supports_free_pointers< T >::value, void >::type __DoFreePointers (T &t)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&!std::is_const< T >::value, void >::type __DoFreePointers (const T &)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&std::is_const< T >::value, void >::type __DoFreePointers (T &)
 
template<class T >
static std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, void >::type __DoFreePointers (T)
 

Detailed Description

Adds a buffering layer on top of another stream.

Constructor & Destructor Documentation

◆ BufferedStream() [1/2]

System::IO::BufferedStream::BufferedStream ( const SharedPtr< Stream > &  stream)

Constructs an BufferedStream object that wraps the specified stream and uses a 4096 bytes long buffer.

Parameters
streamThe underlying Stream object

◆ BufferedStream() [2/2]

System::IO::BufferedStream::BufferedStream ( const SharedPtr< Stream > &  stream,
int  bufferSize 
)

Constructs an BufferedStream object that wraps the specified stream and uses a buffer of the specified size.

Parameters
streamThe underlying Stream object
bufferSizeThe size of the buffer in bytes

◆ ~BufferedStream()

virtual System::IO::BufferedStream::~BufferedStream ( )
virtual

Destructor.

Member Function Documentation

◆ Flush()

virtual void System::IO::BufferedStream::Flush ( )
overridevirtual

Writes the content of the buffer to the underlying stream.

Implements System::IO::Stream.

◆ get_CanRead()

virtual bool System::IO::BufferedStream::get_CanRead ( )
overridevirtual

Determines if the stream is readable. True if the stream is readable; otherwise - false

Implements System::IO::Stream.

◆ get_CanSeek()

virtual bool System::IO::BufferedStream::get_CanSeek ( )
overridevirtual

Determines if the stream supports seeking. True if the stream supports seeking; otherwise - false

Implements System::IO::Stream.

◆ get_CanWrite()

virtual bool System::IO::BufferedStream::get_CanWrite ( )
overridevirtual

Determines if the stream is writable. True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_Length()

virtual int64_t System::IO::BufferedStream::get_Length ( )
overridevirtual

Returns the length of the stream.

Implements System::IO::Stream.

◆ get_Position()

virtual int64_t System::IO::BufferedStream::get_Position ( )
overridevirtual

Returns the current position of the stream.

Implements System::IO::Stream.

◆ Read()

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

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

Parameters
bufferThe byte array to write the read bytes to
offsetA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
The number of bytes read

Implements System::IO::Stream.

◆ ReadByte()

virtual int System::IO::BufferedStream::ReadByte ( )
overridevirtual

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

Reimplemented from System::IO::Stream.

◆ Seek()

virtual int64_t System::IO::BufferedStream::Seek ( int64_t  offset,
SeekOrigin  origin 
)
overridevirtual

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

Parameters
offsetThe byte offset relative to a position specified by origin
originSpecifies the position from which and the direction toward which the offset is calculated
Returns
The new position of the stream

Implements System::IO::Stream.

◆ set_Position()

virtual void System::IO::BufferedStream::set_Position ( int64_t  value)
overridevirtual

Flushes the buffer to the underlying stream and then sets the stream's position.

Parameters
valueThe byte offset to set the stream's position to

Implements System::IO::Stream.

◆ SetLength()

virtual void System::IO::BufferedStream::SetLength ( int64_t  value)
overridevirtual

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

Parameters
valueThe length in bytes to set

Implements System::IO::Stream.

◆ Write()

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

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

Parameters
bufferThe array containing the bytes to write
offsetA 0-based index of the elemnet in buffer at which the subrange to write begins
countThe number of elements in the subrange to write

Implements System::IO::Stream.

◆ WriteByte()

virtual void System::IO::BufferedStream::WriteByte ( uint8_t  value)
overridevirtual

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

Parameters
valueThe value to write

Reimplemented from System::IO::Stream.