RtMappedMemory Class

This class encapsulates a region of mapped memory and exposes it as a Stream.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IOStream
      IntervalZero.MaxRT.wRTOS.RtApi.IO.RtMappedMemory

Namespace:  IntervalZero.MaxRT.wRTOS.RtApi.IO
Assembly:  IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy
public class RtMappedMemory : Stream, 
    IDisposable

 

The RtMappedMemory class exposes the following members.

Constructors

 

Name Description

Public method

RtMappedMemory (UInt64, Int32, MemoryCachingType)

Creates an instance of a MappedMemory object.

Public method

RtMappedMemory (UInt64, UInt32, MemoryCachingType)

Creates an instance of a MappedMemory object.

Properties

  Name Description
Public property CacheType
Gets the MemoryCachingType of the current MappedMemory instance.
Public property CanRead
Always returns true.
(Overrides Stream.CanRead.)
Public property CanSeek
Always returns true.
(Overrides Stream.CanSeek.)
Public property CanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.)
Public property CanWrite
Always returns true.
(Overrides Stream.CanWrite.)
Public property IsDisposed
Returns true if the instance has been disposed, otherwise false.
Public property Length
Gets the number of bytes mapped (via the constructor).
(Overrides Stream.Length.)
Public property Position
Gets or sets the current position (offset from the base address) in the stream.
(Overrides Stream.Position.)
Public property ReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
Public property WriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)

Methods

  Name Description

Public method

Close

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.

(Overrides Stream.Close.)

Protected method

Dispose(Boolean)

Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.

(Overrides Stream.Dispose (Boolean).)

Public method

Read

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes.

(Overrides Stream.Read (Byte, Int32, Int32).)

Public method

Seek

Sets the position within the current stream.

(Overrides Stream.Seek (Int64, SeekOrigin).)

Public method

SetLength

Not supported. Throws a NotSupportedException.

(Overrides Stream.SetLength (Int64).)

Public method

Write

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

(Overrides Stream.Write (Byte, Int32, Int32).)

See Also: