PowerTCP SSH and SFTP for .NET
SessionStream Class Members
Fields  Properties  Methods 


The following tables list the members exposed by SessionStream.

Public Constructors
 NameDescription
Public ConstructorSessionStream ConstructorProvides a stream interface to a Session.  
Top
Public Fields
 NameDescription
Public FieldSessionGets the Session object provided in the constructor.  
Top
Public Properties
 NameDescription
Public PropertyCanReadOverridden.  Gets a value indicating if the session is active.  
Public PropertyCanSeekOverridden.  Gets a value indicating if a seek can be performed on the stream. Always returns false.  
Public PropertyCanTimeoutOverridden.  Gets a value indicating if the stream can timeout. Always returns true.  
Public PropertyCanWriteOverridden.  Gets a value indicating if the stream can be written to.  
Public PropertyDisableInnerExceptions Set to true to disable the use of Exception.InnerException.  
Public PropertyErrorStream Gets the Stream that can be read for error conditions.  
Public PropertyLengthOverridden.  The length of data available on the stream. This method always throws a NotSupportedException.  
Public PropertyPositionOverridden. Gets the position in the stream. Use of this property throws a System.NotSupportedException.  
Public PropertyReadTimeoutOverridden.  Gets or sets the read timeout period for the Stream in milliseconds.  
Public PropertyTag Gets or sets an object that stores any user data.  
Public PropertyWriteTimeoutOverridden.  Gets or sets the write timeout period for the Stream in milliseconds.  
Top
Public Methods
 NameDescription
Public MethodBeginReadBegins an asynchronous read operation. (Consider using System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32) instead.) (Inherited from System.IO.Stream)
Public MethodBeginWriteBegins an asynchronous write operation. (Consider using System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32) instead.) (Inherited from System.IO.Stream)
Public MethodCloseOverridden.  Closes the stream.  
Public MethodCopyToOverloaded. Reads the bytes from the current stream and writes them to another stream. (Inherited from System.IO.Stream)
Public MethodCopyToAsyncOverloaded. Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from System.IO.Stream)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden.  Releases the unmanaged resources used by the Stream and optionally releases the managed resources.  
Public MethodEndReadWaits for the pending asynchronous read to complete. (Consider using System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32) instead.) (Inherited from System.IO.Stream)
Public MethodEndWriteEnds an asynchronous write operation. (Consider using System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32) instead.) (Inherited from System.IO.Stream)
Public MethodFlushOverridden.  Default implementation is no-op. May be overridden by derived classes.  
Public MethodFlushAsyncOverloaded. Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from System.IO.Stream)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodReadOverloaded. Overridden.  Reads session data provided by the SSH-2 host.  
Public MethodReadAsyncOverloaded. 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 System.IO.Stream)
Public MethodReadByteReads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from System.IO.Stream)
Public MethodReadToEnd Receives data until the connection is closed.  
Public MethodSeekOverridden. This method throws a System.NotSupportedException.  
Public MethodSetLengthOverridden.  This method throws a NotSupportedException.  
Public MethodWriteOverloaded. Overridden.  Writes user data to a stream that is received by the SSH-2 host.  
Public MethodWriteAsyncOverloaded. 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 System.IO.Stream)
Public MethodWriteByteWrites a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from System.IO.Stream)
Top
Protected Methods
 NameDescription
Protected MethodCreateWaitHandleAllocates a System.Threading.WaitHandle object. (Inherited from System.IO.Stream)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodObjectInvariantProvides support for a System.Diagnostics.Contracts.Contract. (Inherited from System.IO.Stream)
Top
See Also

Reference

SessionStream Class
Dart.Ssh Namespace


PowerTCP SSH and SFTP for .NET Documentation Version 7.0
© 2023 Dart Communications. All Rights Reserved.
Send comments on this topic