RtSharedMemory Class

An 8-bit implementation of the abstract Port class.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      IntervalZero.MaxRT.wRTOS.RtApi.IO.RtSharedMemory

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 RtSharedMemory : Stream

 

The RtSharedMemory class exposes the following members.

Constructors

 

Name Description

Public method

RtSharedMemory (Int32)

Initializes a SharedMemory object of a specified size.

Public method

RtSharedMemory (Int32, String)

Initializes a SharedMemory object of a specified size.

Properties

  Name Description

Public property

Address

Gets the base address of the shared memory region. If the shared memory region does not exist for any reason, this returns IntPtr.Zero.

Public property

CanRead

Always returns true for SharedMemory.

(Overrides Stream.CanRead.)

Public property

CanSeek

Always returns true for SharedMemory.

(Overrides Stream.CanSeek.)

Public property

CanTimeout

Always returns false for SharedMemory.

(Overrides Stream.CanTimeout.)

Public property

CanWrite

Always returns true for SharedMemory.

(Overrides Stream.CanWrite.)

Public property

Length

The length (size) of the shared memory region.

(Overrides Stream.Length.)

Public property

Name

The system-wide unique name of a named shared memory region.

Public property

Position

Gets or sets the current position (offset from the base address) in the stream.

(Overrides Stream.Position.)

Public property

ReadTimeout

Throws a NotSupportedException.

(Overrides Stream.ReadTimeout.)

Public property

WriteTimeout

Throws a NotSupportedException.

(Overrides Stream.WriteTimeout.)

Methods

  Name Description
Public method BeginRead
Throws a NotSupportedException.
(Overrides Stream.BeginRead (Byte, Int32, Int32, AsyncCallback, Object).)
Public method BeginWrite
Throws a NotSupportedException.
(Overrides Stream.BeginWrite (Byte, Int32, Int32, AsyncCallback, Object).)
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 all resources used by this Port.
(Overrides Stream.Dispose (Boolean).)
Public method EndRead
Throws a NotSupportedException.
(Overrides Stream.EndRead (IAsyncResult).)
Public method EndWrite
Throws a NotSupportedException.
(Overrides Stream.EndWrite (IAsyncResult).)
Public method Flush
Shared memory access is direct, so Flush does nothing.
(Overrides Stream.Flush.)
Public method Static member OpenExisting
Initializes a new SharedMemory object from an existing named region.
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
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: