IntervalZero RTX64 Managed Code Framework

RTSharedMemory Class

Encapsulates functionality of RTX64 shared memory.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.IOStream
      IntervalZero.RTX64.RTAPI.IORTSharedMemory

Namespace: IntervalZero.RTX64.RTAPI.IO
Assembly: IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 3.3.0.0 (File version: 3.5.0)

Syntax

public class RTSharedMemory : Stream

Public Class RTSharedMemory
	Inherits Stream

public ref class RTSharedMemory : public Stream

type RTSharedMemory =  
    class
        inherit Stream
    end

The RTSharedMemory type exposes the following members.

Constructors

	Name	Description
	RTSharedMemory(Int32)	Initializes a SharedMemory object of a specified size.
	RTSharedMemory(Int32, String)	Initializes a SharedMemory object of a specified size.

Properties

	Name	Description
	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.
	CanRead	Always returns true for SharedMemory. (Overrides StreamCanRead.)
	CanSeek	Always returns true for SharedMemory. (Overrides StreamCanSeek.)
	CanTimeout	Always returns false for SharedMemory. (Overrides StreamCanTimeout.)
	CanWrite	Always returns true for SharedMemory. (Overrides StreamCanWrite.)
	Length	The length (size) of the shared memory region. (Overrides StreamLength.)
	Name	The system-wide unique name of a named shared memory region.
	Position	Gets or sets the current position (offset from the base address) in the stream. (Overrides StreamPosition.)
	ReadTimeout	Throws a NotSupportedException. (Overrides StreamReadTimeout.)
	WriteTimeout	Throws a NotSupportedException. (Overrides StreamWriteTimeout.)

Methods

	Name	Description
	BeginRead	Throws a NotSupportedException. (Overrides StreamBeginRead(Byte, Int32, Int32, AsyncCallback, Object).)
	BeginWrite	Throws a NotSupportedException. (Overrides StreamBeginWrite(Byte, Int32, Int32, AsyncCallback, Object).)
	Close	Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Overrides StreamClose.)
	Dispose(Boolean)	Releases all resources used by this Port. (Overrides StreamDispose(Boolean).)
	EndRead	Throws a NotSupportedException. (Overrides StreamEndRead(IAsyncResult).)
	EndWrite	Throws a NotSupportedException. (Overrides StreamEndWrite(IAsyncResult).)
	Flush	Shared memory access is direct, so Flush does nothing. (Overrides StreamFlush.)
	OpenExisting	Initializes a new SharedMemory object from an existing named region.
	Read	Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes. (Overrides StreamRead(Byte, Int32, Int32).)
	Seek	Sets the position within the current stream. (Overrides StreamSeek(Int64, SeekOrigin).)
	SetLength	Throws a NotSupportedException. (Overrides StreamSetLength(Int64).)
	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 StreamWrite(Byte, Int32, Int32).)