AdsStream Class

The class AdsStream is a stream class used for ADS communication.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.IO.MemoryStream
        TwinCAT.Ads.AdsStream
Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public class AdsStream : MemoryStream

VB

Public Class AdsStream
    Inherits MemoryStream

The AdsStream type exposes the following members.

Constructors

 

Name

Description

AdsStream.

Initializes a new instance of the AdsStream class. The instance has an expandable capacity initialized to zero.

AdsStream(.Byte.)

Initializes a new instance of the AdsStream class, based on a byte array.

AdsStream(Int32)

Initializes a new instance of the AdsStream class.

AdsStream(.Byte., Int32, Int32)

Initializes a new instance of the AdsStream class, based on the specified region of a byte array.

Properties

 

Name

Description

CanRead

Gets a value indicating whether the current stream supports reading. (Inherited from MemoryStream.)

CanSeek

Gets a value indicating whether the current stream supports seeking. (Inherited from MemoryStream.)

CanTimeout

Gets a value that determines whether the current stream can time out. (Inherited from Stream.)

CanWrite

Gets a value indicating whether the current stream supports writing. (Inherited from MemoryStream.)

Capacity

Gets or sets the number of bytes allocated for this stream. (Inherited from MemoryStream.)

Length

Gets the length of the stream in bytes. (Inherited from MemoryStream.)

Position

Gets or sets the current position within the stream. (Inherited from MemoryStream.)

ReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)

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

BeginRead

Begins an asynchronous read operation. (Consider using ReadAsync(.Byte., Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.)

BeginWrite

Begins an asynchronous write operation. (Consider using WriteAsync(.Byte., Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.)

Close

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream.)

CopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)

CopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)

CopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)

CopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)

CopyToAsync(Stream, Int32, CancellationToken)

Asynchronously reads all the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from MemoryStream.)

CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)

CreateWaitHandle

Obsolete.

Allocates a WaitHandle object. (Inherited from Stream.)

Dispose.

Releases all resources used by the Stream. (Inherited from Stream.)

Dispose(Boolean)

Releases the unmanaged resources used by the MemoryStream class and optionally releases the managed resources. (Inherited from MemoryStream.)

EndRead

Waits for the pending asynchronous read to complete. (Consider using ReadAsync(.Byte., Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.)

EndWrite

Ends an asynchronous write operation. (Consider using WriteAsync(.Byte., Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.)

Equals

Determines whether the specified object is equal to the current object. (Inherited from Object.)

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Flush

Overrides the Flush. method so that no action is performed. (Inherited from MemoryStream.)

FlushAsync.

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)

FlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, and monitors cancellation requests. (Inherited from MemoryStream.)

GetBuffer

Returns the array of unsigned bytes from which this stream was created. (Inherited from MemoryStream.)

GetHashCode

Serves as the default hash function. (Inherited from Object.)

GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

GetType

Gets the Type of the current instance. (Inherited from Object.)

InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)

MemberwiseClone.

Creates a shallow copy of the current Object. (Inherited from Object.)

MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)

ObjectInvariant

Obsolete.

Provides support for a Contract. (Inherited from Stream.)

Read

Reads a block of bytes from the current stream and writes the data to a buffer. (Inherited from MemoryStream.)

ReadAsync(.Byte., Int32, Int32)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream.)

ReadAsync(.Byte., Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from MemoryStream.)

ReadByte

Reads a byte from the current stream. (Inherited from MemoryStream.)

Seek

Sets the position within the current stream to the specified value. (Inherited from MemoryStream.)

SetLength

Sets the length of the current stream to the specified value. (Inherited from MemoryStream.)

ToArray

Writes the stream contents to a byte array, regardless of the Position property. (Inherited from MemoryStream.)

ToString

Returns a string that represents the current object. (Inherited from Object.)

TryGetBuffer

Returns the array of unsigned bytes from which this stream was created. The return value indicates whether the conversion succeeded. (Inherited from MemoryStream.)

Write

Writes a block of bytes to the current stream using data read from a buffer. (Inherited from MemoryStream.)

WriteAsync(.Byte., Int32, Int32)

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream.)

WriteAsync(.Byte., Int32, Int32, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from MemoryStream.)

WriteByte

Writes a byte to the current stream at the current position. (Inherited from MemoryStream.)

WriteTo

Writes the entire contents of this memory stream to another stream. (Inherited from MemoryStream.)

Fields

 

Name

Description

origin

The origin of the stream.

Reference

TwinCAT.Ads Namespace