Asposecpplib
System::Security::Cryptography::CryptoStream Class Reference

Stream implementation that wraps existing stream with a cryptographic function. 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. More...

Inherits System::IO::Stream.

Public Member Functions

ASPOSECPP_SHARED_API CryptoStream (const SharedPtr< System::IO::Stream > &stream, const SharedPtr< ICryptoTransform > &transform, CryptoStreamMode mode)
 Constructor. More...
 
ASPOSECPP_SHARED_API int Read (ArrayPtr< uint8_t > buffer, int offset, int count) override
 Reads data from stream. More...
 
ASPOSECPP_SHARED_API void Write (ArrayPtr< uint8_t > buffer, int offset, int count) override
 Writes data to stream. More...
 
ASPOSECPP_SHARED_API void Close () override
 Closes connection. More...
 
ASPOSECPP_SHARED_API int64_t Seek (int64_t offset, IO::SeekOrigin origin) override
 Seeks position in stream. Not supported. More...
 
ASPOSECPP_SHARED_API void SetLength (int64_t value) override
 Seeks size of stream. Not supported. More...
 
ASPOSECPP_SHARED_API void Flush () override
 Empties buffer into wrapped stream. Does nothing as transform algorithm can be still waiting for more data. More...
 
ASPOSECPP_SHARED_API void FlushFinalBlock ()
 Writes the data which is still in the buffer to stream. More...
 
ASPOSECPP_SHARED_API void set_Position (int64_t value) override
 Seeks position in stream. Not supported. More...
 
ASPOSECPP_SHARED_API int64_t get_Position () const override
 Gets current position in stream. Not supported. More...
 
ASPOSECPP_SHARED_API int64_t get_Length () const override
 Gets length of stream. Not supported. More...
 
ASPOSECPP_SHARED_API bool get_CanRead () const override
 Checks if stream is readable. More...
 
ASPOSECPP_SHARED_API bool get_CanSeek () const override
 Checks if stream is seekable. More...
 
ASPOSECPP_SHARED_API bool get_CanWrite () const override
 Checks if stream is writable. More...
 
- Public Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API int ReadByte ()
 Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte. More...
 
virtual ASPOSECPP_SHARED_API void WriteByte (uint8_t value)
 Writes the specified unsigned 8-bit integer value to 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::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous read operation. More...
 
virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous write operation. More...
 
virtual ASPOSECPP_SHARED_API int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits until the specified asynchronous read operation completes. More...
 
virtual ASPOSECPP_SHARED_API void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination)
 Copies bytes to the specified stream. More...
 
ASPOSECPP_SHARED_API void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 Copies bytes to the specified stream, using the specified buffer size. More...
 
virtual ASPOSECPP_SHARED_API bool get_CanTimeout () 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 () 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 () 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...
 
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...
 
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 () 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 TypeInfoGetType () 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 ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. 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...
 

Detailed Description

Stream implementation that wraps existing stream with a cryptographic function. 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.

Constructor & Destructor Documentation

◆ CryptoStream()

ASPOSECPP_SHARED_API System::Security::Cryptography::CryptoStream::CryptoStream ( const SharedPtr< System::IO::Stream > &  stream,
const SharedPtr< ICryptoTransform > &  transform,
CryptoStreamMode  mode 
)

Constructor.

Parameters
streamStream to wrap.
transformTransformation function to process data with when sending/reading it to/from stream.
modeStream direction.

Member Function Documentation

◆ Close()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::Close ( )
overridevirtual

Closes connection.

Reimplemented from System::IO::Stream.

◆ Flush()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::Flush ( )
overridevirtual

Empties buffer into wrapped stream. Does nothing as transform algorithm can be still waiting for more data.

Implements System::IO::Stream.

◆ FlushFinalBlock()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::FlushFinalBlock ( )

Writes the data which is still in the buffer to stream.

◆ get_CanRead()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::CryptoStream::get_CanRead ( ) const
overridevirtual

Checks if stream is readable.

Returns
True if stream was created with CryptoStreamMode::Read, false otherwise.

Implements System::IO::Stream.

◆ get_CanSeek()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::CryptoStream::get_CanSeek ( ) const
overridevirtual

Checks if stream is seekable.

Returns
Always returns false.

Implements System::IO::Stream.

◆ get_CanWrite()

ASPOSECPP_SHARED_API bool System::Security::Cryptography::CryptoStream::get_CanWrite ( ) const
overridevirtual

Checks if stream is writable.

Returns
True if stream was created with CryptoStreamMode::Write, false otherwise.

Implements System::IO::Stream.

◆ get_Length()

ASPOSECPP_SHARED_API int64_t System::Security::Cryptography::CryptoStream::get_Length ( ) const
overridevirtual

Gets length of stream. Not supported.

Exceptions
NotSupportedExceptionUnconditionally as operation is not supported.

Implements System::IO::Stream.

◆ get_Position()

ASPOSECPP_SHARED_API int64_t System::Security::Cryptography::CryptoStream::get_Position ( ) const
overridevirtual

Gets current position in stream. Not supported.

Exceptions
NotSupportedExceptionUnconditionally as operation is not supported.

Implements System::IO::Stream.

◆ Read()

ASPOSECPP_SHARED_API int System::Security::Cryptography::CryptoStream::Read ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
overridevirtual

Reads data from stream.

Parameters
bufferDestination data buffer.
offsetOffset in destination buffer.
countNumber of bytes to read.
Returns
Number of bytes being read actually.

Implements System::IO::Stream.

◆ Seek()

ASPOSECPP_SHARED_API int64_t System::Security::Cryptography::CryptoStream::Seek ( int64_t  offset,
IO::SeekOrigin  origin 
)
overridevirtual

Seeks position in stream. Not supported.

Exceptions
NotSupportedExceptionUnconditionally as operation is not supported.

Implements System::IO::Stream.

◆ set_Position()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::set_Position ( int64_t  value)
overridevirtual

Seeks position in stream. Not supported.

Exceptions
NotSupportedExceptionUnconditionally as operation is not supported.

Implements System::IO::Stream.

◆ SetLength()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::SetLength ( int64_t  value)
overridevirtual

Seeks size of stream. Not supported.

Exceptions
NotSupportedExceptionUnconditionally as operation is not supported.

Implements System::IO::Stream.

◆ Write()

ASPOSECPP_SHARED_API void System::Security::Cryptography::CryptoStream::Write ( ArrayPtr< uint8_t >  buffer,
int  offset,
int  count 
)
overridevirtual

Writes data to stream.

Parameters
bufferSource data buffer.
offsetOffset in source buffer.
countNumber of bytes to write.
Returns
Number of bytes being read actually.

Implements System::IO::Stream.