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

 CryptoStream (const SharedPtr< System::IO::Stream > &stream, const SharedPtr< ICryptoTransform > &transform, CryptoStreamMode mode)
 Constructor. More...
 
int Read (ArrayPtr< uint8_t > buffer, int offset, int count) override
 Reads data from stream. More...
 
void Write (ArrayPtr< uint8_t > buffer, int offset, int count) override
 Writes data to stream. More...
 
void Close () override
 Closes connection. More...
 
int64_t Seek (int64_t offset, IO::SeekOrigin origin) override
 Seeks position in stream. Not supported. More...
 
void SetLength (int64_t value) override
 Seeks size of stream. Not supported. More...
 
void Flush () override
 Empties buffer into wrapped stream. Does nothing as transform algorithm can be still waiting for more data. More...
 
void FlushFinalBlock ()
 Writes the data which is still in the buffer to stream. More...
 
void set_Position (int64_t value) override
 Seeks position in stream. Not supported. More...
 
int64_t get_Position () const override
 Gets current position in stream. Not supported. More...
 
int64_t get_Length () const override
 Gets length of stream. Not supported. More...
 
bool get_CanRead () const override
 Checks if stream is readable. More...
 
bool get_CanSeek () const override
 Checks if stream is seekable. More...
 
bool get_CanWrite () const override
 Checks if stream is writable. More...
 
- Public Member Functions inherited from System::IO::Stream
virtual 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 void WriteByte (uint8_t value)
 Writes the specified unsigned 8-bit integer value to the stream. More...
 
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)
 Initiates an asynchronous read operation. More...
 
virtual 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 int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits until the specified asynchronous read operation completes. More...
 
virtual void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
void CopyTo (const SharedPtr< Stream > &destination)
 Copies bytes to the specified stream. More...
 
void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 Copies bytes to the specified stream, using the specified buffer size. More...
 
virtual bool get_CanTimeout () const
 Gets a value that determines whether the current stream can time out. More...
 
virtual void set_ReadTimeout (int timeout)
 Sets a value that determines whether the current stream can time out. More...
 
virtual int get_ReadTimeout () const
 Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual void set_WriteTimeout (int timeout)
 Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
virtual int get_WriteTimeout () const
 Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. More...
 
- 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...
 
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 reference counter. 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () 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. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
- 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 ()
 Implements 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< StreamNull
 A stream with no underlying storage. More...
 
- Protected Member Functions inherited from System::IO::Stream
virtual void Dispose (bool disposing)
 Releases all resources used by the current object and closes the stream. More...
 
virtual int32_t ReadImpl (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
 Reads the specified number of bytes from the stream and writes them to the specified buffer. 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()

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()

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

Closes connection.

Reimplemented from System::IO::Stream.

◆ Flush()

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()

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

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

◆ get_CanRead()

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()

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

Checks if stream is seekable.

Returns
Always returns false.

Implements System::IO::Stream.

◆ get_CanWrite()

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()

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()

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()

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()

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()

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()

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()

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.

Implements System::IO::Stream.