Changeset 1131


Ignore:
Timestamp:
Feb 4, 2010, 7:04:26 PM (12 years ago)
Author:
Matthäus Wander
Message:

CStream:

  • minor doc update
Location:
trunk/CrypPluginBase/IO
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/CrypPluginBase/IO/CStream.cs

    r1106 r1131  
    1 using System;
     1/*
     2   Copyright 2010 Matthäus Wander, University of Duisburg-Essen
     3
     4   Licensed under the Apache License, Version 2.0 (the "License");
     5   you may not use this file except in compliance with the License.
     6   You may obtain a copy of the License at
     7
     8       http://www.apache.org/licenses/LICENSE-2.0
     9
     10   Unless required by applicable law or agreed to in writing, software
     11   distributed under the License is distributed on an "AS IS" BASIS,
     12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13   See the License for the specific language governing permissions and
     14   limitations under the License.
     15*/
     16
     17using System;
    218using System.Collections.Generic;
    319using System.Linq;
     
    1127    /// To create a new CStream, please use CStreamWriter.
    1228    ///
    13     /// You MAY create 1 to n readers upon one CStream. They do not interfere.
     29    /// <para>You MAY create 1 to n readers upon one CStream. They do not interfere.
    1430    /// You MAY pass the CStream object safely to other components. They can create new
    15     /// readers, but not modify the stream.
     31    /// readers, but not modify the stream.</para>
    1632    ///
    17     /// For more usage notes, see CStreamWriter and CStreamReader.
     33    /// <para>For more usage notes, see CStreamWriter and CStreamReader.</para>
    1834    /// </summary>
    1935    public class CStream
  • trunk/CrypPluginBase/IO/CStreamReader.cs

    r1106 r1131  
    2929    /// from CStream.
    3030    ///
    31     /// You MAY seek in the CStream to re-use the reader or skip data (beware of seeking too far:
    32     /// will lead to EOF).
    33     /// You SHOULD dispose the reader when you're done using it. If you don't, the GC will release
    34     /// your resources.
    35     /// You SHOULD NOT pass the same reader instance to other components. Concurrent access on
     31    /// <para>You MAY seek in the CStream to re-use the reader or skip data (beware of seeking too far:
     32    /// will lead to EOF).</para>
     33    ///
     34    /// <para>You SHOULD dispose the reader when you're done using it. If you don't, the GC will release
     35    /// your resources.</para>
     36    ///
     37    /// <para>You SHOULD NOT pass the same reader instance to other components. Concurrent access on
    3638    /// the same reader will lead to a probably unwanted behaviour. You MAY however use two different
    37     /// readers on the same CStream. Each reader maintains its own state.
     39    /// readers on the same CStream. Each reader maintains its own state.</para>
    3840    /// </summary>
    3941    public class CStreamReader : Stream, IDisposable
  • trunk/CrypPluginBase/IO/CStreamWriter.cs

    r1106 r1131  
    3232    /// forget old data, therefore you can derive an arbitary number of stream readers at any time.
    3333    ///
    34     /// You SHOULD Flush() the stream when you're writing large data amounts and expect the readers
     34    /// <para>You SHOULD Flush() the stream when you're writing large data amounts and expect the readers
    3535    /// to perform intermediate processing before writing has been finished.
    3636    /// You MUST Close() the stream when you're finished with writing, otherwise the reader will block
    37     /// and wait for more data infinitely.
     37    /// and wait for more data infinitely.</para>
    3838    ///
    39     /// You SHOULD Dispose() the stream when you're done using it (or use the C# "using" keyword) in
    40     /// order to remove the temporary swapfile, however if you forget to, the GC will clean up for you.
     39    /// <para>You SHOULD Dispose() the stream when you're done using it (or use the C# "using" keyword) in
     40    /// order to remove the temporary swapfile, however if you forget to, the GC will clean up for you.</para>
    4141    /// </public>
    4242    public class CStreamWriter : Stream, IDisposable
Note: See TracChangeset for help on using the changeset viewer.