CryptoStream

CryptoStream


Provides a streaming mechanism for ciphering data.


Implements:

IObject 
Stream 

Public:

Types:

NameDescription
 CryptoStreamMode Specifies mode of a cryptographic stream.  

Properties:

NameDescription
 CanRead (get) Gets if the stream can be read from.  
 CanSeek (get) Gets if the stream can seek.  
 CanTimeout (get) Gets if the Stream can timeout.  
 CanWrite (get) Gets if the stream can be written to.  
 Length (get) Gets the length of the current stream.  
 Position (get) Gets the current position within the stream.  
 Position (let) Gets the current position within the stream.  
 ReadTimeout (get) Gets the amount of time must pass before a Read timeout occurs.  
 ReadTimeout (let) Sets the timeout period for Read operations.  
 WriteTimeout (get) Gets the timeout period for a Write operation.  
 WriteTimeout (let) Sets the timeout period for a Write operation.  

Methods:

NameDescription
 BeginRead Begins an Asynchronous read operation (currently is only synchronous)  
 BeginWrite Begins an asynchronous buffer write. Currently the CryptoStream class does not support asynchronous buffer writing.  
 CloseStream Closes the underlying Stream.  
 CopyTo Reads the bytes from the current stream and writes them to another stream.  
 EndRead Signifies the end of an asynchronous read from the stream.  
 EndWrite Signifies the end of an asynchronous write to the stream.  
 Equals Returns a boolean indicating if the value and this object instance are the same instance.  
 Flush Flushes the buffers of the underlying stream.  
 FlushFinalBlock Flushes the remaining data to the underlying stream.  
 GetHashCode Returns a psuedo-unique number used to help identify this object in memory. The current method is to return the value obtained from ObjPtr. If a different method needs to be impelmented then change the method here in this function.

An override might be necessary if the hashcode should be derived from a value contained within the class.  

 ReadBlock Reads a sequence of bytes from the current CryptoStream and advances the position within the stream by the number of bytes read.  
 ReadByte Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.  
 SeekPosition Seeks a new position within the stream.  
 SetLength Sets the length of the current stream.  
 ToString Returns a string representation of this object instance. The default method simply returns the application name and class name in which this class resides.

A Person class may return the persons name instead.  

 WriteBlock Writes a sequence of bytes to the current CryptoStream and advances the current position within this stream by the number of bytes written.  
 WriteByte Writes a single byte to the Stream.  

Remarks

A CryptoStream can be written to or read from in the same manner as other stream objects. A CryptoStream is designed to be used in a daisy-chain fashion, allowing for multiple transformations to be applied as a single process.

By supplying another Stream object to the NewCryptoStream constructor, an automatic daisy-chaining of the two streams is created. The Stream does not have to be another CryptoStream object. It can be any object implementing the Stream interface.

See Also

Project CorLib Overview

Class CryptoStream Overview

Constructors