20983 lines
1.1 MiB
Executable File
20983 lines
1.1 MiB
Executable File
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>Renci.SshNet</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="M:Renci.SshNet.Abstractions.CryptoAbstraction.GenerateRandom(System.Int32)">
|
||
<summary>
|
||
Generates a <see cref="T:System.Byte"/> array of the specified length, and fills it with a
|
||
cryptographically strong random sequence of values.
|
||
</summary>
|
||
<param name="length">The length of the array generate.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.SocketAbstraction.ReadByte(System.Net.Sockets.Socket,System.TimeSpan)">
|
||
<summary>
|
||
Reads a byte from the specified <see cref="T:System.Net.Sockets.Socket"/>.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="timeout">Specifies the amount of time after which the call will time out.</param>
|
||
<returns>
|
||
The byte read, or <c>-1</c> if the socket was closed.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read operation timed out.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">The read failed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.SocketAbstraction.SendByte(System.Net.Sockets.Socket,System.Byte)">
|
||
<summary>
|
||
Sends a byte using the specified <see cref="T:System.Net.Sockets.Socket"/>.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to write to.</param>
|
||
<param name="value">The value to send.</param>
|
||
<exception cref="T:System.Net.Sockets.SocketException">The write failed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)">
|
||
<summary>
|
||
Receives data from a bound <see cref="T:System.Net.Sockets.Socket"/>.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="size">The number of bytes to receive.</param>
|
||
<param name="timeout">Specifies the amount of time after which the call will time out.</param>
|
||
<returns>
|
||
The bytes received.
|
||
</returns>
|
||
<remarks>
|
||
If no data is available for reading, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> method will
|
||
block until data is available or the time-out value is exceeded. If the time-out value is exceeded, the
|
||
<see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> call will throw a <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/>.
|
||
If you are in non-blocking mode, and there is no data available in the in the protocol stack buffer, the
|
||
<see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Int32,System.TimeSpan)"/> method will complete immediately and throw a <see cref="T:System.Net.Sockets.SocketException"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)">
|
||
<summary>
|
||
Receives data from a bound <see cref="T:System.Net.Sockets.Socket"/> into a receive buffer.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="buffer">An array of type <see cref="T:System.Byte"/> that is the storage location for the received data. </param>
|
||
<param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param>
|
||
<param name="size">The number of bytes to receive.</param>
|
||
<param name="readTimeout">The maximum time to wait until <paramref name="size"/> bytes have been received.</param>
|
||
<returns>
|
||
The number of bytes received.
|
||
</returns>
|
||
<remarks>
|
||
<para>
|
||
If no data is available for reading, the <see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"/> method will
|
||
block until data is available or the time-out value is exceeded. If the time-out value is exceeded, the
|
||
<see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"/> call will throw a <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/>.
|
||
</para>
|
||
<para>
|
||
If you are in non-blocking mode, and there is no data available in the in the protocol stack buffer, the
|
||
<see cref="M:Renci.SshNet.Abstractions.SocketAbstraction.Read(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)"/> method will complete immediately and throw a <see cref="T:System.Net.Sockets.SocketException"/>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.ThreadAbstraction.ExecuteThreadLongRunning(System.Action)">
|
||
<summary>
|
||
Creates and starts a long-running <see cref="T:System.Threading.Tasks.Task"/> for the specified <see cref="T:System.Action"/>.
|
||
</summary>
|
||
<param name="action">The <see cref="T:System.Action"/> to start.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="action"/> is <see langword="null"/>.</exception>
|
||
<returns>
|
||
A task that represents the execution of the specified <see cref="T:System.Action"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Abstractions.ThreadAbstraction.ExecuteThread(System.Action)">
|
||
<summary>
|
||
Executes the specified action in a separate thread.
|
||
</summary>
|
||
<param name="action">The action to execute.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.AuthenticationMethod">
|
||
<summary>
|
||
Base class for all supported authentication methods.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.AuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
<value>
|
||
The name of the authentication method.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.AuthenticationMethod.Username">
|
||
<summary>
|
||
Gets connection username.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.AuthenticationMethod.AllowedAuthentications">
|
||
<summary>
|
||
Gets or sets the list of allowed authentications.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.AuthenticationMethod.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.AuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.AuthenticationMethod.Authenticate(Renci.SshNet.Session)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>
|
||
The result of the authentication process.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.AuthenticationMethod.Renci#SshNet#IAuthenticationMethod#Authenticate(Renci.SshNet.ISession)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>
|
||
The result of the authentication process.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.AuthenticationMethod.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing">
|
||
<see langword="true"/> to release both managed and unmanaged resources;
|
||
<see langword="false"/> to release only unmanaged resources.
|
||
</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.AuthenticationMethod.Dispose">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.AuthenticationResult">
|
||
<summary>
|
||
Represents possible authentication methods results.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.AuthenticationResult.Success">
|
||
<summary>
|
||
Authentication was successful.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.AuthenticationResult.PartialSuccess">
|
||
<summary>
|
||
Authentication completed with partial success.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.AuthenticationResult.Failure">
|
||
<summary>
|
||
Authentication failed.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.BaseClient">
|
||
<summary>
|
||
Serves as base class for client implementations, provides common client functionality.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.BaseClient._ownsConnectionInfo">
|
||
<summary>
|
||
Holds value indicating whether the connection info is owned by this client.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.BaseClient.Session">
|
||
<summary>
|
||
Gets the current session.
|
||
</summary>
|
||
<value>
|
||
The current session.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.BaseClient.ServiceFactory">
|
||
<summary>
|
||
Gets the factory for creating new services.
|
||
</summary>
|
||
<value>
|
||
The factory for creating new services.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.BaseClient.ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>
|
||
The connection info.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.BaseClient.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether this client is connected to the server.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this client is connected; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.BaseClient.KeepAliveInterval">
|
||
<summary>
|
||
Gets or sets the keep-alive interval.
|
||
</summary>
|
||
<value>
|
||
The keep-alive interval. Specify negative one (-1) milliseconds to disable the
|
||
keep-alive. This is the default value.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="E:Renci.SshNet.BaseClient.ErrorOccurred">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.BaseClient.HostKeyReceived">
|
||
<summary>
|
||
Occurs when host key received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.BaseClient.ServerIdentificationReceived">
|
||
<summary>
|
||
Occurs when server identification received.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.BaseClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.BaseClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.Connect">
|
||
<summary>
|
||
Connects client to the server.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.ConnectAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects client to the server.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous connect operation.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.Disconnect">
|
||
<summary>
|
||
Disconnects client from the server.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.SendKeepAlive">
|
||
<summary>
|
||
Sends a keep-alive message to the server.
|
||
</summary>
|
||
<remarks>
|
||
Use <see cref="P:Renci.SshNet.BaseClient.KeepAliveInterval"/> to configure the client to send a keep-alive at regular
|
||
intervals.
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.OnConnecting">
|
||
<summary>
|
||
Called when client is connecting to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.OnConnected">
|
||
<summary>
|
||
Called when client is connected to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.OnDisconnected">
|
||
<summary>
|
||
Called when client is disconnected from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.CheckDisposed">
|
||
<summary>
|
||
Check if the current instance is disposed.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The current instance is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.StopKeepAliveTimer">
|
||
<summary>
|
||
Stops the keep-alive timer, and waits until all timer callbacks have been
|
||
executed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.StartKeepAliveTimer">
|
||
<summary>
|
||
Starts the keep-alive timer.
|
||
</summary>
|
||
<remarks>
|
||
When <see cref="P:Renci.SshNet.BaseClient.KeepAliveInterval"/> is negative one (-1) milliseconds, then
|
||
the timer will not be started.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.CreateKeepAliveTimer(System.TimeSpan,System.TimeSpan)">
|
||
<summary>
|
||
Creates a <see cref="T:System.Threading.Timer"/> with the specified due time and interval.
|
||
</summary>
|
||
<param name="dueTime">The amount of time to delay before the keep-alive message is first sent. Specify negative one (-1) milliseconds to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param>
|
||
<param name="period">The time interval between attempts to send a keep-alive message. Specify negative one (-1) milliseconds to disable periodic signaling.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Timer"/> with the specified due time and interval.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.DisposeSession">
|
||
<summary>
|
||
Disposes the SSH session, and assigns <see langword="null"/> to <see cref="P:Renci.SshNet.BaseClient.Session"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.BaseClient.IsSessionConnected">
|
||
<summary>
|
||
Returns a value indicating whether the SSH session is established.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if the SSH session is established; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.Channel">
|
||
<summary>
|
||
Represents base class for SSH channel implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.Channel._closeMessageSent">
|
||
<summary>
|
||
Holds a value indicating whether the SSH_MSG_CHANNEL_CLOSE has been sent to the remote party.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> when a SSH_MSG_CHANNEL_CLOSE message has been sent to the other party;
|
||
otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.Channel._closeMessageReceived">
|
||
<summary>
|
||
Holds a value indicating whether a SSH_MSG_CHANNEL_CLOSE has been received from the other
|
||
party.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> when a SSH_MSG_CHANNEL_CLOSE message has been received from the other party;
|
||
otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.Channel._eofMessageReceived">
|
||
<summary>
|
||
Holds a value indicating whether the SSH_MSG_CHANNEL_EOF has been received from the other party.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> when a SSH_MSG_CHANNEL_EOF message has been received from the other party;
|
||
otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.Channel._eofMessageSent">
|
||
<summary>
|
||
Holds a value indicating whether the SSH_MSG_CHANNEL_EOF has been sent to the remote party.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> when a SSH_MSG_CHANNEL_EOF message has been sent to the remote party;
|
||
otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.Exception">
|
||
<summary>
|
||
Occurs when an exception is thrown when processing channel messages.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.Channel"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.Session">
|
||
<summary>
|
||
Gets the session.
|
||
</summary>
|
||
<value>
|
||
The session.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel.
|
||
</summary>
|
||
<value>
|
||
The type of the channel.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.LocalChannelNumber">
|
||
<summary>
|
||
Gets the local channel number.
|
||
</summary>
|
||
<value>
|
||
The local channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.LocalPacketSize">
|
||
<summary>
|
||
Gets the maximum size of a data packet that we can receive using the channel.
|
||
</summary>
|
||
<value>
|
||
The maximum size of a packet.
|
||
</value>
|
||
<remarks>
|
||
<para>
|
||
This is the maximum size (in bytes) we support for the data (payload) of a
|
||
<c>SSH_MSG_CHANNEL_DATA</c> message we receive.
|
||
</para>
|
||
<para>
|
||
We currently do not enforce this limit.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.LocalWindowSize">
|
||
<summary>
|
||
Gets the size of the local window.
|
||
</summary>
|
||
<value>
|
||
The size of the local window.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.RemoteChannelNumber">
|
||
<summary>
|
||
Gets the remote channel number.
|
||
</summary>
|
||
<value>
|
||
The remote channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.RemotePacketSize">
|
||
<summary>
|
||
Gets the maximum size of a data packet that we can send using the channel.
|
||
</summary>
|
||
<value>
|
||
The maximum size of data that can be sent using a <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/>
|
||
on the current channel.
|
||
</value>
|
||
<exception cref="T:System.InvalidOperationException">The channel has not been opened, or the open has not yet been confirmed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.RemoteWindowSize">
|
||
<summary>
|
||
Gets the window size of the remote server.
|
||
</summary>
|
||
<value>
|
||
The size of the server window.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.IsOpen">
|
||
<summary>
|
||
Gets or sets a value indicating whether this channel is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this channel is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.DataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.ExtendedDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.EndOfData">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelEofMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.Closed">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.RequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.RequestSucceeded">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.Channel.RequestFailed">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether the session is connected.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the session is connected; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>The connection info.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.Channel.SessionSemaphore">
|
||
<summary>
|
||
Gets the session semaphore to control number of session channels.
|
||
</summary>
|
||
<value>The session semaphore.</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.InitializeRemoteInfo(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes the information on the remote channel.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="remoteWindowSize">The remote window size.</param>
|
||
<param name="remotePacketSize">The remote packet size.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.SendData(System.Byte[])">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_DATA message with the specified payload.
|
||
</summary>
|
||
<param name="data">The payload to send.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.SendData(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_DATA message with the specified payload.
|
||
</summary>
|
||
<param name="data">An array of <see cref="T:System.Byte"/> containing the payload to send.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="data"/> at which to begin taking data from.</param>
|
||
<param name="size">The number of bytes of <paramref name="data"/> to send.</param>
|
||
<remarks>
|
||
<para>
|
||
When the size of the data to send exceeds the maximum packet size or the remote window
|
||
size does not allow the full data to be sent, then this method will send the data in
|
||
multiple chunks and will wait for the remote window size to be adjusted when it's zero.
|
||
</para>
|
||
<para>
|
||
This is done to support SSH servers will a small window size that do not aggressively
|
||
increase their window size. We need to take into account that there may be SSH servers
|
||
that only increase their window size when it has reached zero.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnWindowAdjust(System.UInt32)">
|
||
<summary>
|
||
Called when channel window need to be adjust.
|
||
</summary>
|
||
<param name="bytesToAdd">The bytes to add.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnData(System.ArraySegment{System.Byte})">
|
||
<summary>
|
||
Called when channel data is received.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnExtendedData(System.Byte[],System.UInt32)">
|
||
<summary>
|
||
Called when channel extended data is received.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
<param name="dataTypeCode">The data type code.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnEof">
|
||
<summary>
|
||
Called when channel has no more data to receive.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnClose">
|
||
<summary>
|
||
Called when channel is closed by the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnRequest(Renci.SshNet.Messages.Connection.RequestInfo)">
|
||
<summary>
|
||
Called when channel request received.
|
||
</summary>
|
||
<param name="info">Channel request information.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnSuccess">
|
||
<summary>
|
||
Called when channel request was successful.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnFailure">
|
||
<summary>
|
||
Called when channel request failed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.RaiseExceptionEvent(System.Exception)">
|
||
<summary>
|
||
Raises <see cref="E:Renci.SshNet.Channels.Channel.Exception"/> event.
|
||
</summary>
|
||
<param name="exception">The exception.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.TrySendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<returns>
|
||
<see langword="true"/> if the message was sent to the server; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
<remarks>
|
||
This methods returns <see langword="false"/> when the attempt to send the message results in a
|
||
<see cref="T:System.Net.Sockets.SocketException"/> or a <see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.SendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends SSH message to the server.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.SendEof">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_EOF message to the remote server.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The channel is closed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.WaitOnHandle(System.Threading.WaitHandle)">
|
||
<summary>
|
||
Waits for the handle to be signaled or for an error to occurs.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.Close">
|
||
<summary>
|
||
Closes the channel, waiting for the SSH_MSG_CHANNEL_CLOSE message to be received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.OnChannelException(System.Exception)">
|
||
<summary>
|
||
Called when an <see cref="E:Renci.SshNet.Channels.Channel.Exception"/> occurs while processing a channel message.
|
||
</summary>
|
||
<param name="ex">The <see cref="E:Renci.SshNet.Channels.Channel.Exception"/>.</param>
|
||
<remarks>
|
||
This method will in turn invoke <see cref="M:Renci.SshNet.Channels.Channel.OnErrorOccurred(System.Exception)"/>, and
|
||
raise the <see cref="E:Renci.SshNet.Channels.Channel.Exception"/> event.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.GetDataLengthThatCanBeSentInMessage(System.Int32)">
|
||
<summary>
|
||
Determines the length of data that currently can be sent in a single message.
|
||
</summary>
|
||
<param name="messageLength">The length of the message that must be sent.</param>
|
||
<returns>
|
||
The actual data length that currently can be sent.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.Channel.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.ChannelDirectTcpip">
|
||
<summary>
|
||
Implements "direct-tcpip" SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.ChannelDirectTcpip"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.ChannelDirectTcpip.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel.
|
||
</summary>
|
||
<value>
|
||
The type of the channel.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.ForwardedPort_Closing(System.Object,System.EventArgs)">
|
||
<summary>
|
||
Occurs as the forwarded port is being stopped.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.Bind">
|
||
<summary>
|
||
Binds channel to remote host.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.CloseSocket">
|
||
<summary>
|
||
Closes the socket, hereby interrupting the blocking receive in <see cref="M:Renci.SshNet.Channels.ChannelDirectTcpip.Bind"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.ShutdownSocket(System.Net.Sockets.SocketShutdown)">
|
||
<summary>
|
||
Shuts down the socket.
|
||
</summary>
|
||
<param name="how">One of the <see cref="T:System.Net.Sockets.SocketShutdown"/> values that specifies the operation that will no longer be allowed.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.Close">
|
||
<summary>
|
||
Closes the channel, waiting for the SSH_MSG_CHANNEL_CLOSE message to be received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.OnData(System.ArraySegment{System.Byte})">
|
||
<summary>
|
||
Called when channel data is received.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.OnOpenConfirmation(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Called when channel is opened by the server.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="initialWindowSize">Initial size of the window.</param>
|
||
<param name="maximumPacketSize">Maximum size of the packet.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.OnEof">
|
||
<summary>
|
||
Called when channel has no more data to receive.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.OnErrorOccurred(System.Exception)">
|
||
<summary>
|
||
Called whenever an unhandled <see cref="T:System.Exception"/> occurs in <see cref="T:Renci.SshNet.Session"/> causing
|
||
the message loop to be interrupted, or when an exception occurred processing a channel message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelDirectTcpip.OnDisconnected">
|
||
<summary>
|
||
Called when the server wants to terminate the connection immediately.
|
||
</summary>
|
||
<remarks>
|
||
The sender MUST NOT send or receive any data after this message, and
|
||
the recipient MUST NOT accept any data after receiving this message.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.ChannelForwardedTcpip">
|
||
<summary>
|
||
Implements "forwarded-tcpip" SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.ChannelForwardedTcpip"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="remoteWindowSize">The window size of the remote party.</param>
|
||
<param name="remotePacketSize">The maximum size of a data packet that we can send to the remote party.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.ChannelForwardedTcpip.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel.
|
||
</summary>
|
||
<value>
|
||
The type of the channel.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.Bind(System.Net.IPEndPoint,Renci.SshNet.IForwardedPort)">
|
||
<summary>
|
||
Binds the channel to the specified endpoint.
|
||
</summary>
|
||
<param name="remoteEndpoint">The endpoint to connect to.</param>
|
||
<param name="forwardedPort">The forwarded port for which the channel is opened.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.ForwardedPort_Closing(System.Object,System.EventArgs)">
|
||
<summary>
|
||
Occurs as the forwarded port is being stopped.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.ShutdownSocket(System.Net.Sockets.SocketShutdown)">
|
||
<summary>
|
||
Shuts down the socket.
|
||
</summary>
|
||
<param name="how">One of the <see cref="T:System.Net.Sockets.SocketShutdown"/> values that specifies the operation that will no longer be allowed.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.CloseSocket">
|
||
<summary>
|
||
Closes the socket, hereby interrupting the blocking receive in <see cref="M:Renci.SshNet.Channels.ChannelForwardedTcpip.Bind(System.Net.IPEndPoint,Renci.SshNet.IForwardedPort)"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.Close">
|
||
<summary>
|
||
Closes the channel waiting for the SSH_MSG_CHANNEL_CLOSE message to be received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelForwardedTcpip.OnData(System.ArraySegment{System.Byte})">
|
||
<summary>
|
||
Called when channel data is received.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.ChannelSession">
|
||
<summary>
|
||
Implements Session SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelSession._failedOpenAttempts">
|
||
<summary>
|
||
Counts failed channel open attempts.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelSession._sessionSemaphoreObtained">
|
||
<summary>
|
||
Holds a value indicating whether the session semaphore has been obtained by the current
|
||
channel.
|
||
</summary>
|
||
<value>
|
||
<c>0</c> when the session semaphore has not been obtained or has already been released,
|
||
and <c>1</c> when the session has been obtained and still needs to be released.
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelSession._channelOpenResponseWaitHandle">
|
||
<summary>
|
||
Wait handle to signal when response was received to open the channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.ChannelSession"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.ChannelSession.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel.
|
||
</summary>
|
||
<value>
|
||
The type of the channel.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.Open">
|
||
<summary>
|
||
Opens the channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.OnOpenConfirmation(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Called when channel is opened by the server.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="initialWindowSize">Initial size of the window.</param>
|
||
<param name="maximumPacketSize">Maximum size of the packet.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.OnOpenFailure(System.UInt32,System.String,System.String)">
|
||
<summary>
|
||
Called when channel failed to open.
|
||
</summary>
|
||
<param name="reasonCode">The reason code.</param>
|
||
<param name="description">The description.</param>
|
||
<param name="language">The language.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendPseudoTerminalRequest(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Sends the pseudo terminal request.
|
||
</summary>
|
||
<param name="environmentVariable">The environment variable.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendX11ForwardingRequest(System.Boolean,System.String,System.Byte[],System.UInt32)">
|
||
<summary>
|
||
Sends the X11 forwarding request.
|
||
</summary>
|
||
<param name="isSingleConnection">if set to <see langword="true"/> the it is single connection.</param>
|
||
<param name="protocol">The protocol.</param>
|
||
<param name="cookie">The cookie.</param>
|
||
<param name="screenNumber">The screen number.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendEnvironmentVariableRequest(System.String,System.String)">
|
||
<summary>
|
||
Sends the environment variable request.
|
||
</summary>
|
||
<param name="variableName">Name of the variable.</param>
|
||
<param name="variableValue">The variable value.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendShellRequest">
|
||
<summary>
|
||
Sends the shell request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendExecRequest(System.String)">
|
||
<summary>
|
||
Sends the exec request.
|
||
</summary>
|
||
<param name="command">The command.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendBreakRequest(System.UInt32)">
|
||
<summary>
|
||
Sends the exec request.
|
||
</summary>
|
||
<param name="breakLength">Length of the break.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendSubsystemRequest(System.String)">
|
||
<summary>
|
||
Sends the subsystem request.
|
||
</summary>
|
||
<param name="subsystem">The subsystem.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendWindowChangeRequest(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Sends the window change request.
|
||
</summary>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendLocalFlowRequest(System.Boolean)">
|
||
<summary>
|
||
Sends the local flow request.
|
||
</summary>
|
||
<param name="clientCanDo">if set to <see langword="true"/> [client can do].</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendSignalRequest(System.String)">
|
||
<summary>
|
||
Sends the signal request.
|
||
</summary>
|
||
<param name="signalName">Name of the signal.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendEndOfWriteRequest">
|
||
<summary>
|
||
Sends eow@openssh.com request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendKeepAliveRequest">
|
||
<summary>
|
||
Sends keepalive@openssh.com request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.OnSuccess">
|
||
<summary>
|
||
Called when channel request was successful.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.OnFailure">
|
||
<summary>
|
||
Called when channel request failed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.SendChannelOpenMessage">
|
||
<summary>
|
||
Sends the channel open message.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The operation timed out.</exception>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
<remarks>
|
||
<para>
|
||
When a session semaphore for this instance has not yet been obtained by this or any other thread,
|
||
the thread will block until such a semaphore is available and send a <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/>
|
||
to the remote host.
|
||
</para>
|
||
<para>
|
||
Note that the session semaphore is released in any of the following cases:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>A <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> is received for the channel being opened.</description>
|
||
</item>
|
||
<item>
|
||
<description>The remote host does not respond to the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> within the configured <see cref="P:Renci.SshNet.ConnectionInfo.Timeout"/>.</description>
|
||
</item>
|
||
<item>
|
||
<description>The remote host closes the channel.</description>
|
||
</item>
|
||
<item>
|
||
<description>The <see cref="T:Renci.SshNet.Channels.ChannelSession"/> is disposed.</description>
|
||
</item>
|
||
<item>
|
||
<description>A socket error occurs sending a message to the remote host.</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
<para>
|
||
If the session semaphore was already obtained for this instance (and not released), then this method
|
||
immediately returns control to the caller. This should only happen when another thread has obtain the
|
||
session semaphore and already sent the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/>, but the remote host did not
|
||
confirmed or rejected attempt to open the channel.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ChannelSession.ReleaseSemaphore">
|
||
<summary>
|
||
Releases the session semaphore.
|
||
</summary>
|
||
<remarks>
|
||
When the session semaphore has already been released, or was never obtained by
|
||
this instance, then this method does nothing.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.ChannelTypes">
|
||
<summary>
|
||
Lists channel types as defined by the protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelTypes.Session">
|
||
<summary>
|
||
Session.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelTypes.X11">
|
||
<summary>
|
||
X11.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelTypes.ForwardedTcpip">
|
||
<summary>
|
||
Forwarded-tcpip.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Channels.ChannelTypes.DirectTcpip">
|
||
<summary>
|
||
Direct-tcpip.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ClientChannel.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.ClientChannel"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.ClientChannel.OpenConfirmed">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.ClientChannel.OpenFailed">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ClientChannel.OnOpenConfirmation(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Called when channel is opened by the server.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="initialWindowSize">Initial size of the window.</param>
|
||
<param name="maximumPacketSize">Maximum size of the packet.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ClientChannel.SendMessage(Renci.SshNet.Messages.Connection.ChannelOpenMessage)">
|
||
<summary>
|
||
Send message to open a channel.
|
||
</summary>
|
||
<param name="message">Message to send.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The operation timed out.</exception>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ClientChannel.OnOpenFailure(System.UInt32,System.String,System.String)">
|
||
<summary>
|
||
Called when channel failed to open.
|
||
</summary>
|
||
<param name="reasonCode">The reason code.</param>
|
||
<param name="description">The description.</param>
|
||
<param name="language">The language.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ClientChannel.UnsubscribeFromSessionEvents(Renci.SshNet.ISession)">
|
||
<summary>
|
||
Unsubscribes the current <see cref="T:Renci.SshNet.Channels.ClientChannel"/> from session events.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<remarks>
|
||
Does nothing when <paramref name="session"/> is <see langword="null"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.IChannel">
|
||
<summary>
|
||
Represents SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannel.DataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannel.Exception">
|
||
<summary>
|
||
Occurs when an exception is thrown when processing channel messages.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannel.ExtendedDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannel.RequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannel.Closed">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> is received.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannel.LocalChannelNumber">
|
||
<summary>
|
||
Gets the local channel number.
|
||
</summary>
|
||
<value>
|
||
The local channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannel.LocalPacketSize">
|
||
<summary>
|
||
Gets the maximum size of a data packet that we can receive using the channel.
|
||
</summary>
|
||
<value>
|
||
The maximum size of a packet.
|
||
</value>
|
||
<remarks>
|
||
<para>
|
||
This is the maximum size (in bytes) we support for the data (payload) of a
|
||
<c>SSH_MSG_CHANNEL_DATA</c> message we receive.
|
||
</para>
|
||
<para>
|
||
We currently do not enforce this limit.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannel.RemoteChannelNumber">
|
||
<summary>
|
||
Gets the remote channel number.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannel.RemotePacketSize">
|
||
<summary>
|
||
Gets the maximum size of a data packet that can be sent using the channel.
|
||
</summary>
|
||
<value>
|
||
The maximum size of data that can be sent using a <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/>
|
||
on the current channel.
|
||
</value>
|
||
<exception cref="T:System.InvalidOperationException">The channel has not been opened, or the open has not yet been confirmed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannel.IsOpen">
|
||
<summary>
|
||
Gets a value indicating whether this channel is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this channel is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannel.SendData(System.Byte[])">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_DATA message with the specified payload.
|
||
</summary>
|
||
<param name="data">The payload to send.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannel.SendData(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_DATA message with the specified payload.
|
||
</summary>
|
||
<param name="data">An array of <see cref="T:System.Byte"/> containing the payload to send.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="data"/> at which to begin taking data from.</param>
|
||
<param name="size">The number of bytes of <paramref name="data"/> to send.</param>
|
||
<remarks>
|
||
<para>
|
||
When the size of the data to send exceeds the maximum packet size or the remote window
|
||
size does not allow the full data to be sent, then this method will send the data in
|
||
multiple chunks and will wait for the remote window size to be adjusted when it's zero.
|
||
</para>
|
||
<para>
|
||
This is done to support SSH servers will a small window size that do not aggressively
|
||
increase their window size. We need to take into account that there may be SSH servers
|
||
that only increase their window size when it has reached zero.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannel.SendEof">
|
||
<summary>
|
||
Sends a SSH_MSG_CHANNEL_EOF message to the remote server.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The channel is closed.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.IChannelDirectTcpip">
|
||
<summary>
|
||
A "direct-tcpip" SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannelDirectTcpip.Exception">
|
||
<summary>
|
||
Occurs when an exception is thrown while processing channel messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannelDirectTcpip.IsOpen">
|
||
<summary>
|
||
Gets a value indicating whether this channel is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this channel is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Channels.IChannelDirectTcpip.LocalChannelNumber">
|
||
<summary>
|
||
Gets the local channel number.
|
||
</summary>
|
||
<value>
|
||
The local channel number.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelDirectTcpip.Open(System.String,System.UInt32,Renci.SshNet.IForwardedPort,System.Net.Sockets.Socket)">
|
||
<summary>
|
||
Opens a channel for a locally forwarded TCP/IP port.
|
||
</summary>
|
||
<param name="remoteHost">The name of the remote host to forward to.</param>
|
||
<param name="port">The port of the remote hosts to forward to.</param>
|
||
<param name="forwardedPort">The forwarded port for which the channel is opened.</param>
|
||
<param name="socket">The socket to receive requests from, and send responses from the remote host to.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelDirectTcpip.Bind">
|
||
<summary>
|
||
Binds the channel to the remote host.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.IChannelForwardedTcpip">
|
||
<summary>
|
||
A "forwarded-tcpip" SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Channels.IChannelForwardedTcpip.Exception">
|
||
<summary>
|
||
Occurs when an exception is thrown while processing channel messages.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelForwardedTcpip.Bind(System.Net.IPEndPoint,Renci.SshNet.IForwardedPort)">
|
||
<summary>
|
||
Binds the channel to the specified endpoint.
|
||
</summary>
|
||
<param name="remoteEndpoint">The endpoint to connect to.</param>
|
||
<param name="forwardedPort">The forwarded port for which the channel is opened.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Channels.IChannelSession">
|
||
<summary>
|
||
Session SSH channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.Open">
|
||
<summary>
|
||
Opens the channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendPseudoTerminalRequest(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Sends the pseudo terminal request.
|
||
</summary>
|
||
<param name="environmentVariable">The environment variable.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendX11ForwardingRequest(System.Boolean,System.String,System.Byte[],System.UInt32)">
|
||
<summary>
|
||
Sends the X11 forwarding request.
|
||
</summary>
|
||
<param name="isSingleConnection">if set to <see langword="true"/> the it is single connection.</param>
|
||
<param name="protocol">The protocol.</param>
|
||
<param name="cookie">The cookie.</param>
|
||
<param name="screenNumber">The screen number.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendEnvironmentVariableRequest(System.String,System.String)">
|
||
<summary>
|
||
Sends the environment variable request.
|
||
</summary>
|
||
<param name="variableName">Name of the variable.</param>
|
||
<param name="variableValue">The variable value.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendShellRequest">
|
||
<summary>
|
||
Sends the shell request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendExecRequest(System.String)">
|
||
<summary>
|
||
Sends the exec request.
|
||
</summary>
|
||
<param name="command">The command.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendBreakRequest(System.UInt32)">
|
||
<summary>
|
||
Sends the exec request.
|
||
</summary>
|
||
<param name="breakLength">Length of the break.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendSubsystemRequest(System.String)">
|
||
<summary>
|
||
Sends the subsystem request.
|
||
</summary>
|
||
<param name="subsystem">The subsystem.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendWindowChangeRequest(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Sends the window change request.
|
||
</summary>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendLocalFlowRequest(System.Boolean)">
|
||
<summary>
|
||
Sends the local flow request.
|
||
</summary>
|
||
<param name="clientCanDo">if set to <see langword="true"/> [client can do].</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendSignalRequest(System.String)">
|
||
<summary>
|
||
Sends the signal request.
|
||
</summary>
|
||
<param name="signalName">Name of the signal.</param>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendEndOfWriteRequest">
|
||
<summary>
|
||
Sends eow@openssh.com request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.IChannelSession.SendKeepAliveRequest">
|
||
<summary>
|
||
Sends keepalive@openssh.com request.
|
||
</summary>
|
||
<returns>
|
||
<see langword="true"/> if request was successful; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Channels.ServerChannel.#ctor(Renci.SshNet.ISession,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Channels.ServerChannel"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="localWindowSize">Size of the window.</param>
|
||
<param name="localPacketSize">Size of the packet.</param>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="remoteWindowSize">The window size of the remote party.</param>
|
||
<param name="remotePacketSize">The maximum size of a data packet that we can send to the remote party.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.CipherInfo">
|
||
<summary>
|
||
Holds information about key size and cipher to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.CipherInfo.KeySize">
|
||
<summary>
|
||
Gets the size of the key.
|
||
</summary>
|
||
<value>
|
||
The size of the key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.CipherInfo.IsAead">
|
||
<summary>
|
||
Gets a value indicating whether the cipher is AEAD (Authenticated Encryption with Associated data).
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.CipherInfo.Cipher">
|
||
<summary>
|
||
Gets the cipher.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.CipherInfo.#ctor(System.Int32,System.Func{System.Byte[],System.Byte[],Renci.SshNet.Security.Cryptography.Cipher},System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.CipherInfo"/> class.
|
||
</summary>
|
||
<param name="keySize">Size of the key.</param>
|
||
<param name="cipher">The cipher.</param>
|
||
<param name="isAead"><see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ClientAuthentication">
|
||
<summary>
|
||
Represents a mechanism to authenticate a given client.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.#ctor(System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ClientAuthentication"/> class.
|
||
</summary>
|
||
<param name="partialSuccessLimit">The number of times an authentication attempt with any given <see cref="T:Renci.SshNet.IAuthenticationMethod"/> can result in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/> before it is disregarded.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="partialSuccessLimit"/> is less than one.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ClientAuthentication.PartialSuccessLimit">
|
||
<summary>
|
||
Gets the number of times an authentication attempt with any given <see cref="T:Renci.SshNet.IAuthenticationMethod"/> can
|
||
result in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/> before it is disregarded.
|
||
</summary>
|
||
<value>
|
||
The number of times an authentication attempt with any given <see cref="T:Renci.SshNet.IAuthenticationMethod"/> can result
|
||
in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/> before it is disregarded.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.Authenticate(Renci.SshNet.IConnectionInfoInternal,Renci.SshNet.ISession)">
|
||
<summary>
|
||
Attempts to perform authentication for a given <see cref="T:Renci.SshNet.ISession"/> using the
|
||
<see cref="P:Renci.SshNet.IConnectionInfoInternal.AuthenticationMethods"/> of the specified
|
||
<see cref="T:Renci.SshNet.IConnectionInfoInternal"/>.
|
||
</summary>
|
||
<param name="connectionInfo">A <see cref="T:Renci.SshNet.IConnectionInfoInternal"/> to use for authenticating.</param>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> for which to perform authentication.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> or <paramref name="session"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Failed to authenticate the client.</exception>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ClientAuthentication.AuthenticationState._authenticationMethodPartialSuccessRegister">
|
||
<summary>
|
||
Records if a given <see cref="T:Renci.SshNet.IAuthenticationMethod"/> has been tried, and how many times this resulted
|
||
in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/>.
|
||
</summary>
|
||
<remarks>
|
||
When there's no entry for a given <see cref="T:Renci.SshNet.IAuthenticationMethod"/>, then it was never tried.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ClientAuthentication.AuthenticationState._failedAuthenticationMethods">
|
||
<summary>
|
||
Holds the list of authentications methods that failed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.AuthenticationState.RecordFailure(Renci.SshNet.IAuthenticationMethod)">
|
||
<summary>
|
||
Records a <see cref="F:Renci.SshNet.AuthenticationResult.Failure"/> authentication attempt for the specified
|
||
<see cref="T:Renci.SshNet.IAuthenticationMethod"/> .
|
||
</summary>
|
||
<param name="authenticationMethod">An <see cref="T:Renci.SshNet.IAuthenticationMethod"/> for which to record the result of an authentication attempt.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.AuthenticationState.RecordPartialSuccess(Renci.SshNet.IAuthenticationMethod)">
|
||
<summary>
|
||
Records a <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/> authentication attempt for the specified
|
||
<see cref="T:Renci.SshNet.IAuthenticationMethod"/> .
|
||
</summary>
|
||
<param name="authenticationMethod">An <see cref="T:Renci.SshNet.IAuthenticationMethod"/> for which to record the result of an authentication attempt.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.AuthenticationState.GetPartialSuccessCount(Renci.SshNet.IAuthenticationMethod)">
|
||
<summary>
|
||
Returns the number of times an authentication attempt with the specified <see cref="T:Renci.SshNet.IAuthenticationMethod"/>
|
||
has resulted in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/>.
|
||
</summary>
|
||
<param name="authenticationMethod">An <see cref="T:Renci.SshNet.IAuthenticationMethod"/>.</param>
|
||
<returns>
|
||
The number of times an authentication attempt with the specified <see cref="T:Renci.SshNet.IAuthenticationMethod"/>
|
||
has resulted in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.AuthenticationState.GetSupportedAuthenticationMethods(System.String[])">
|
||
<summary>
|
||
Returns a list of supported authentication methods that match one of the specified allowed authentication
|
||
methods.
|
||
</summary>
|
||
<param name="allowedAuthenticationMethods">A list of allowed authentication methods.</param>
|
||
<returns>
|
||
A list of supported authentication methods that match one of the specified allowed authentication methods.
|
||
</returns>
|
||
<remarks>
|
||
The authentication methods are returned in the order in which they were specified in the list that was
|
||
used to initialize the current <see cref="T:Renci.SshNet.ClientAuthentication.AuthenticationState"/> instance.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ClientAuthentication.AuthenticationState.GetActiveAuthenticationMethods(System.Collections.Generic.List{Renci.SshNet.IAuthenticationMethod})">
|
||
<summary>
|
||
Returns the authentication methods from the specified list that have not yet failed.
|
||
</summary>
|
||
<param name="matchingAuthenticationMethods">A list of authentication methods.</param>
|
||
<returns>
|
||
The authentication methods from <paramref name="matchingAuthenticationMethods"/> that have not yet failed.
|
||
</returns>
|
||
<remarks>
|
||
<para>
|
||
This method first returns the authentication methods that have not yet been executed, and only then
|
||
returns those for which an authentication attempt resulted in a <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/>.
|
||
</para>
|
||
<para>
|
||
Any <see cref="T:Renci.SshNet.IAuthenticationMethod"/> that has failed is skipped.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AsyncResult">
|
||
<summary>
|
||
Base class to encapsulates the results of an asynchronous operation.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AsyncResult"/> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AsyncResult.EndInvokeCalled">
|
||
<summary>
|
||
Gets a value indicating whether <see cref="M:Renci.SshNet.Common.AsyncResult.EndInvoke"/> has been called on the current <see cref="T:Renci.SshNet.Common.AsyncResult"/>.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if <see cref="M:Renci.SshNet.Common.AsyncResult.EndInvoke"/> has been called on the current <see cref="T:Renci.SshNet.Common.AsyncResult"/>;
|
||
otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult.SetAsCompleted(System.Exception,System.Boolean)">
|
||
<summary>
|
||
Marks asynchronous operation as completed.
|
||
</summary>
|
||
<param name="exception">The exception.</param>
|
||
<param name="completedSynchronously">If set to <see langword="true"/>, completed synchronously.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult.EndInvoke">
|
||
<summary>
|
||
Waits until the asynchronous operation completes, and then returns.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AsyncResult.AsyncState">
|
||
<summary>
|
||
Gets a user-defined object that qualifies or contains information about an asynchronous operation.
|
||
</summary>
|
||
<value>
|
||
A user-defined object that qualifies or contains information about an asynchronous operation.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AsyncResult.CompletedSynchronously">
|
||
<summary>
|
||
Gets a value indicating whether the asynchronous operation completed synchronously.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the asynchronous operation completed synchronously; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AsyncResult.AsyncWaitHandle">
|
||
<summary>
|
||
Gets a <see cref="T:System.Threading.WaitHandle"/> that is used to wait for an asynchronous operation to complete.
|
||
</summary>
|
||
<value>
|
||
A <see cref="T:System.Threading.WaitHandle"/> that is used to wait for an asynchronous operation to complete.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AsyncResult.IsCompleted">
|
||
<summary>
|
||
Gets a value indicating whether the asynchronous operation has completed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the operation is complete; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AsyncResult`1">
|
||
<summary>
|
||
Base class to encapsulates the results of an asynchronous operation that returns result.
|
||
</summary>
|
||
<typeparam name="TResult">The type of the result.</typeparam>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult`1.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AsyncResult`1"/> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult`1.SetAsCompleted(`0,System.Boolean)">
|
||
<summary>
|
||
Marks asynchronous operation as completed.
|
||
</summary>
|
||
<param name="result">The result.</param>
|
||
<param name="completedSynchronously">if set to <see langword="true"/> [completed synchronously].</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AsyncResult`1.EndInvoke">
|
||
<summary>
|
||
Waits until the asynchronous operation completes, and then returns the value generated by the asynchronous operation.
|
||
</summary>
|
||
<returns>
|
||
The invocation result.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AuthenticationBannerEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.ConnectionInfo.AuthenticationBanner"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationBannerEventArgs.BannerMessage">
|
||
<summary>
|
||
Gets banner message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationBannerEventArgs.Language">
|
||
<summary>
|
||
Gets banner language.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AuthenticationBannerEventArgs.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AuthenticationBannerEventArgs"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<param name="message">Banner message.</param>
|
||
<param name="language">Banner language.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AuthenticationEventArgs">
|
||
<summary>
|
||
Base class for authentication events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AuthenticationEventArgs.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AuthenticationEventArgs"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationEventArgs.Username">
|
||
<summary>
|
||
Gets the username.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AuthenticationPasswordChangeEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.PasswordConnectionInfo.PasswordExpired"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AuthenticationPasswordChangeEventArgs.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AuthenticationPasswordChangeEventArgs"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPasswordChangeEventArgs.NewPassword">
|
||
<summary>
|
||
Gets or sets the new password.
|
||
</summary>
|
||
<value>
|
||
The new password.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AuthenticationPrompt">
|
||
<summary>
|
||
Provides prompt information when <see cref="E:Renci.SshNet.KeyboardInteractiveConnectionInfo.AuthenticationPrompt"/> is raised.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AuthenticationPrompt.#ctor(System.Int32,System.Boolean,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AuthenticationPrompt"/> class.
|
||
</summary>
|
||
<param name="id">The sequence id.</param>
|
||
<param name="isEchoed">if set to <see langword="true"/> the user input should be echoed.</param>
|
||
<param name="request">The request.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPrompt.Id">
|
||
<summary>
|
||
Gets the prompt sequence id.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPrompt.IsEchoed">
|
||
<summary>
|
||
Gets a value indicating whether the user input should be echoed as characters are typed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the user input should be echoed as characters are typed; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPrompt.Request">
|
||
<summary>
|
||
Gets server information request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPrompt.Response">
|
||
<summary>
|
||
Gets or sets server information response.
|
||
</summary>
|
||
<value>
|
||
The response.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.AuthenticationPromptEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.KeyboardInteractiveConnectionInfo.AuthenticationPrompt"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.AuthenticationPromptEventArgs.#ctor(System.String,System.String,System.String,System.Collections.Generic.IReadOnlyList{Renci.SshNet.Common.AuthenticationPrompt})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.AuthenticationPromptEventArgs"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<param name="instruction">The instruction.</param>
|
||
<param name="language">The language.</param>
|
||
<param name="prompts">The information request prompts.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPromptEventArgs.Language">
|
||
<summary>
|
||
Gets prompt language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPromptEventArgs.Instruction">
|
||
<summary>
|
||
Gets prompt instruction.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.AuthenticationPromptEventArgs.Prompts">
|
||
<summary>
|
||
Gets server information request prompts.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelDataEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.Channels.Channel.DataReceived"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelDataEventArgs.#ctor(System.UInt32,System.ArraySegment{System.Byte})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelDataEventArgs"/> class.
|
||
</summary>
|
||
<param name="channelNumber">Channel number.</param>
|
||
<param name="data">Channel data.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelDataEventArgs.Data">
|
||
<summary>
|
||
Gets channel data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelEventArgs">
|
||
<summary>
|
||
Base class for all channel related events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelEventArgs.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelEventArgs"/> class.
|
||
</summary>
|
||
<param name="channelNumber">The channel number.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelEventArgs.ChannelNumber">
|
||
<summary>
|
||
Gets the channel number.
|
||
</summary>
|
||
<value>
|
||
The channel number.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelExtendedDataEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.Channels.Channel.ExtendedDataReceived"/> events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelExtendedDataEventArgs.#ctor(System.UInt32,System.Byte[],System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelExtendedDataEventArgs"/> class.
|
||
</summary>
|
||
<param name="channelNumber">Channel number.</param>
|
||
<param name="data">Channel data.</param>
|
||
<param name="dataTypeCode">Channel data type code.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelExtendedDataEventArgs.DataTypeCode">
|
||
<summary>
|
||
Gets the data type code.
|
||
</summary>
|
||
<value>
|
||
The data type code.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelInputStream">
|
||
<summary>
|
||
ChannelInputStream is a one direction stream intended for channel data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.ChannelInputStream._channel">
|
||
<summary>
|
||
Channel to send data to.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.ChannelInputStream._totalPosition">
|
||
<summary>
|
||
Total bytes passed through the stream.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.ChannelInputStream._isDisposed">
|
||
<summary>
|
||
Indicates whether the current instance was disposed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.Flush">
|
||
<summary>
|
||
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
|
||
</summary>
|
||
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
||
<remarks>
|
||
Once flushed, any subsequent read operations no longer block until requested bytes are available. Any write operation reactivates blocking
|
||
reads.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<summary>
|
||
When overridden in a derived class, sets the position within the current stream.
|
||
</summary>
|
||
<returns>
|
||
The new position within the current stream.
|
||
</returns>
|
||
<param name="offset">A byte offset relative to the origin parameter.</param>
|
||
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
|
||
<exception cref="T:System.NotSupportedException">The stream does not support seeking, such as if the stream is constructed from a pipe or console output.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.SetLength(System.Int64)">
|
||
<summary>
|
||
When overridden in a derived class, sets the length of the current stream.
|
||
</summary>
|
||
<param name="value">The desired length of the current stream in bytes.</param>
|
||
<exception cref="T:System.NotSupportedException">The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
|
||
</summary>
|
||
<returns>
|
||
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero if the stream is closed or end of the stream has been reached.
|
||
</returns>
|
||
<param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.</param>
|
||
<param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from the current stream.</param>
|
||
<param name="count">The maximum number of bytes to be read from the current stream.</param>
|
||
<exception cref="T:System.ArgumentException">The sum of offset and count is larger than the buffer length.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
||
<exception cref="T:System.NotSupportedException">The stream does not support reading.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null" />.</exception>
|
||
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
|
||
</summary>
|
||
<param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.</param>
|
||
<param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
|
||
<param name="count">The number of bytes to be written to the current stream.</param>
|
||
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
|
||
<exception cref="T:System.NotSupportedException">The stream does not support writing.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null" />.</exception>
|
||
<exception cref="T:System.ArgumentException">The sum of offset and count is greater than the buffer length.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelInputStream.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelInputStream.CanRead">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports reading.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the stream supports reading; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelInputStream.CanSeek">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports seeking.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the stream supports seeking; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelInputStream.CanWrite">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports writing.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the stream supports writing; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelInputStream.Length">
|
||
<summary>
|
||
Throws <see cref="T:System.NotSupportedException"/>.
|
||
</summary>
|
||
<exception cref="T:System.NotSupportedException">Always.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelInputStream.Position">
|
||
<summary>
|
||
Gets the position within the current stream.
|
||
</summary>
|
||
<value>
|
||
The current position within the stream.
|
||
</value>
|
||
<exception cref="T:System.NotSupportedException">The setter is called.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelOpenConfirmedEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.Channels.ClientChannel.OpenConfirmed"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelOpenConfirmedEventArgs.#ctor(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelOpenConfirmedEventArgs"/> class.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
<param name="initialWindowSize">The initial window size.</param>
|
||
<param name="maximumPacketSize">The maximum packet size.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelOpenConfirmedEventArgs.InitialWindowSize">
|
||
<summary>
|
||
Gets the initial size of the window.
|
||
</summary>
|
||
<value>
|
||
The initial size of the window.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelOpenConfirmedEventArgs.MaximumPacketSize">
|
||
<summary>
|
||
Gets the maximum size of the packet.
|
||
</summary>
|
||
<value>
|
||
The maximum size of the packet.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelOpenFailedEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.Channels.ClientChannel.OpenFailed"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelOpenFailedEventArgs.#ctor(System.UInt32,System.UInt32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelOpenFailedEventArgs"/> class.
|
||
</summary>
|
||
<param name="channelNumber">Channel number.</param>
|
||
<param name="reasonCode">Failure reason code.</param>
|
||
<param name="description">Failure description.</param>
|
||
<param name="language">Failure language.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelOpenFailedEventArgs.ReasonCode">
|
||
<summary>
|
||
Gets failure reason code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelOpenFailedEventArgs.Description">
|
||
<summary>
|
||
Gets failure description.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelOpenFailedEventArgs.Language">
|
||
<summary>
|
||
Gets failure language.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ChannelRequestEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.Channels.Channel.RequestReceived"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ChannelRequestEventArgs.#ctor(Renci.SshNet.Messages.Connection.RequestInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ChannelRequestEventArgs"/> class.
|
||
</summary>
|
||
<param name="info">Request information.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="info"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ChannelRequestEventArgs.Info">
|
||
<summary>
|
||
Gets the request information.
|
||
</summary>
|
||
<value>
|
||
The request information.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ExceptionEventArgs">
|
||
<summary>
|
||
Provides data for the ErrorOccurred events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ExceptionEventArgs.#ctor(System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ExceptionEventArgs"/> class.
|
||
</summary>
|
||
<param name="exception">An System.Exception that represents the error that occurred.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ExceptionEventArgs.Exception">
|
||
<summary>
|
||
Gets the <see cref="P:Renci.SshNet.Common.ExceptionEventArgs.Exception"/> that represents the error that occurred.
|
||
</summary>
|
||
<value>
|
||
The <see cref="P:Renci.SshNet.Common.ExceptionEventArgs.Exception"/> that represents the error that occurred.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.Extensions">
|
||
<summary>
|
||
Collection of different extension methods.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.ToBigInteger2(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:System.Numerics.BigInteger"/> structure using the SSH BigNum2 Format.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.SetIgnoringObjectDisposed(System.Threading.EventWaitHandle)">
|
||
<summary>
|
||
Sets a wait handle, swallowing any resulting <see cref="T:System.ObjectDisposedException"/>.
|
||
Used in cases where set and dispose may race.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle to set.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.Take(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Returns a specified number of contiguous bytes from a given offset.
|
||
</summary>
|
||
<param name="value">The array to return a number of bytes from.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="value"/> at which to begin taking bytes.</param>
|
||
<param name="count">The number of bytes to take from <paramref name="value"/>.</param>
|
||
<returns>
|
||
A <see cref="T:System.Byte"/> array that contains the specified number of bytes at the specified offset
|
||
of the input array.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
When <paramref name="offset"/> is zero and <paramref name="count"/> equals the length of <paramref name="value"/>,
|
||
then <paramref name="value"/> is returned.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.Take(System.Byte[],System.Int32)">
|
||
<summary>
|
||
Returns a specified number of contiguous bytes from the start of the specified byte array.
|
||
</summary>
|
||
<param name="value">The array to return a number of bytes from.</param>
|
||
<param name="count">The number of bytes to take from <paramref name="value"/>.</param>
|
||
<returns>
|
||
A <see cref="T:System.Byte"/> array that contains the specified number of bytes at the start of the input array.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
When <paramref name="count"/> equals the length of <paramref name="value"/>, then <paramref name="value"/>
|
||
is returned.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.TrimLeadingZeros(System.Byte[])">
|
||
<summary>
|
||
Trims the leading zero from a byte array.
|
||
</summary>
|
||
<param name="value">The value.</param>
|
||
<returns>
|
||
<paramref name="value"/> without leading zeros.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.Extensions.Pad(System.Byte[],System.Int32)">
|
||
<summary>
|
||
Pads with leading zeros if needed.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
<param name="length">The length to pad to.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.HostKeyEventArgs">
|
||
<summary>
|
||
Provides data for the HostKeyReceived event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.CanTrust">
|
||
<summary>
|
||
Gets or sets a value indicating whether host key can be trusted.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if host key can be trusted; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.HostKey">
|
||
<summary>
|
||
Gets the host key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.HostKeyName">
|
||
<summary>
|
||
Gets the host key name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.FingerPrint">
|
||
<summary>
|
||
Gets the MD5 fingerprint.
|
||
</summary>
|
||
<value>
|
||
MD5 fingerprint as byte array.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.FingerPrintSHA256">
|
||
<summary>
|
||
Gets the SHA256 fingerprint of the host key in the same format as the ssh command,
|
||
i.e. non-padded base64, but without the <c>SHA256:</c> prefix.
|
||
</summary>
|
||
<example><c>ohD8VZEXGWo6Ez8GSEJQ9WpafgLFsOfLOtGGQCQo6Og</c>.</example>
|
||
<value>
|
||
Base64 encoded SHA256 fingerprint with padding (equals sign) removed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.FingerPrintMD5">
|
||
<summary>
|
||
Gets the MD5 fingerprint of the host key in the same format as the ssh command,
|
||
i.e. hexadecimal bytes separated by colons, but without the <c>MD5:</c> prefix.
|
||
</summary>
|
||
<example><c>97:70:33:82:fd:29:3a:73:39:af:6a:07:ad:f8:80:49</c>.</example>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.KeyLength">
|
||
<summary>
|
||
Gets the length of the key in bits.
|
||
</summary>
|
||
<value>
|
||
The length of the key in bits.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.HostKeyEventArgs.Certificate">
|
||
<summary>
|
||
Gets the certificate presented by the host, or <see langword="null"/> if the host
|
||
did not present a certificate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.HostKeyEventArgs.#ctor(Renci.SshNet.Security.KeyHostAlgorithm)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.HostKeyEventArgs"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.NetConfServerException">
|
||
<summary>
|
||
The exception that is thrown when there is something wrong with the server capabilities.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.NetConfServerException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.NetConfServerException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.NetConfServerException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.NetConfServerException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.NetConfServerException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.NetConfServerException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.PipeStream">
|
||
<summary>
|
||
PipeStream is a thread-safe read/write data stream for use between two threads in a
|
||
single-producer/single-consumer type problem.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<summary>
|
||
This method always throws <see cref="T:System.NotSupportedException"/>.
|
||
</summary>
|
||
<param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
|
||
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
|
||
<returns>Never.</returns>
|
||
<exception cref="T:System.NotSupportedException">Always.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.SetLength(System.Int64)">
|
||
<summary>
|
||
This method always throws <see cref="T:System.NotSupportedException"/>.
|
||
</summary>
|
||
<param name="value">The desired length of the current stream in bytes.</param>
|
||
<exception cref="T:System.NotSupportedException">Always.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Read(System.Span{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.ReadByte">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Write(System.ReadOnlySpan{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.WriteByte(System.Byte)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.EndWrite(System.IAsyncResult)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Flush">
|
||
<summary>
|
||
This method does nothing.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.FlushAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
This method does nothing.
|
||
</summary>
|
||
<param name="cancellationToken">Unobserved cancellation token.</param>
|
||
<returns><see cref="P:System.Threading.Tasks.Task.CompletedTask"/>.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PipeStream.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PipeStream.CanRead">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports reading.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/>.
|
||
</value>
|
||
<remarks>
|
||
It is safe to read from <see cref="T:Renci.SshNet.Common.PipeStream"/> even after disposal.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PipeStream.CanSeek">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports seeking.
|
||
</summary>
|
||
<value>
|
||
<see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PipeStream.CanWrite">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports writing.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this stream has not been disposed and the underlying channel
|
||
is still open, otherwise <see langword="false"/>.
|
||
</value>
|
||
<remarks>
|
||
A value of <see langword="true"/> does not necessarily mean a write will succeed. It is possible
|
||
that the stream is disposed by another thread between a call to <see cref="P:Renci.SshNet.Common.PipeStream.CanWrite"/> and the call to write.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PipeStream.Length">
|
||
<summary>
|
||
Gets the number of bytes currently available for reading.
|
||
</summary>
|
||
<value>A long value representing the length of the stream in bytes.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PipeStream.Position">
|
||
<summary>
|
||
This property always returns 0, and throws <see cref="T:System.NotSupportedException"/>
|
||
when calling the setter.
|
||
</summary>
|
||
<value>
|
||
0.
|
||
</value>
|
||
<exception cref="T:System.NotSupportedException">The setter is called.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.PortForwardEventArgs">
|
||
<summary>
|
||
Provides data for <see cref="E:Renci.SshNet.ForwardedPort.RequestReceived"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PortForwardEventArgs.#ctor(System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.PortForwardEventArgs"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is not within <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PortForwardEventArgs.OriginatorHost">
|
||
<summary>
|
||
Gets request originator host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PortForwardEventArgs.OriginatorPort">
|
||
<summary>
|
||
Gets request originator port.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.PosixPath">
|
||
<summary>
|
||
Represents a POSIX path.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PosixPath.Directory">
|
||
<summary>
|
||
Gets the directory of the path.
|
||
</summary>
|
||
<value>
|
||
The directory of the path.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.PosixPath.File">
|
||
<summary>
|
||
Gets the file part of the path.
|
||
</summary>
|
||
<value>
|
||
The file part of the path, or <see langword="null"/> if the path represents a directory.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PosixPath.CreateAbsoluteOrRelativeFilePath(System.String)">
|
||
<summary>
|
||
Create a <see cref="T:Renci.SshNet.Common.PosixPath"/> from the specified path.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Common.PosixPath"/> created from the specified path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is empty ("").</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PosixPath.GetFileName(System.String)">
|
||
<summary>
|
||
Gets the file name part of a given POSIX path.
|
||
</summary>
|
||
<param name="path">The POSIX path to get the file name for.</param>
|
||
<returns>
|
||
The file name part of <paramref name="path"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
<para>
|
||
If <paramref name="path"/> contains no forward slash, then <paramref name="path"/>
|
||
is returned.
|
||
</para>
|
||
<para>
|
||
If path has a trailing slash, <see cref="M:Renci.SshNet.Common.PosixPath.GetFileName(System.String)"/> return a zero-length string.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.PosixPath.GetDirectoryName(System.String)">
|
||
<summary>
|
||
Gets the directory name part of a given POSIX path.
|
||
</summary>
|
||
<param name="path">The POSIX path to get the directory name for.</param>
|
||
<returns>
|
||
The directory part of the specified <paramref name="path"/>, or <c>.</c> if <paramref name="path"/>
|
||
does not contain any directory information.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ProxyException">
|
||
<summary>
|
||
The exception that is thrown when a proxy connection cannot be established.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ProxyException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ProxyException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ProxyException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ProxyException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ProxyException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ProxyException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ScpDownloadEventArgs">
|
||
<summary>
|
||
Provides data for the Downloading event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ScpDownloadEventArgs.#ctor(System.String,System.Int64,System.Int64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ScpDownloadEventArgs"/> class.
|
||
</summary>
|
||
<param name="filename">The downloaded filename.</param>
|
||
<param name="size">The downloaded file size.</param>
|
||
<param name="downloaded">The number of downloaded bytes so far.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpDownloadEventArgs.Filename">
|
||
<summary>
|
||
Gets the downloaded filename.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpDownloadEventArgs.Size">
|
||
<summary>
|
||
Gets the downloaded file size.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpDownloadEventArgs.Downloaded">
|
||
<summary>
|
||
Gets number of downloaded bytes so far.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ScpException">
|
||
<summary>
|
||
The exception that is thrown when an SCP error occurs.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ScpException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ScpException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ScpException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ScpException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ScpException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ScpException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ScpUploadEventArgs">
|
||
<summary>
|
||
Provides data for the Uploading event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ScpUploadEventArgs.#ctor(System.String,System.Int64,System.Int64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ScpUploadEventArgs"/> class.
|
||
</summary>
|
||
<param name="filename">The uploaded filename.</param>
|
||
<param name="size">The uploaded file size.</param>
|
||
<param name="uploaded">The number of uploaded bytes so far.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpUploadEventArgs.Filename">
|
||
<summary>
|
||
Gets the uploaded filename.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpUploadEventArgs.Size">
|
||
<summary>
|
||
Gets the uploaded file size.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ScpUploadEventArgs.Uploaded">
|
||
<summary>
|
||
Gets number of uploaded bytes so far.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SftpException">
|
||
<summary>
|
||
The exception that is thrown when an error occurs in the SFTP layer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SftpException.StatusCode">
|
||
<summary>
|
||
Gets the status code that is associated with this exception.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpException.#ctor(Renci.SshNet.Sftp.StatusCode)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpException"/> class.
|
||
</summary>
|
||
<param name="statusCode">The status code that indicates the error that occurred.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpException.#ctor(Renci.SshNet.Sftp.StatusCode,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpException"/> class.
|
||
</summary>
|
||
<param name="statusCode">The status code that indicates the error that occurred.</param>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpException.#ctor(Renci.SshNet.Sftp.StatusCode,System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpException"/> class.
|
||
</summary>
|
||
<param name="statusCode">The status code that indicates the error that occurred.</param>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SftpPathNotFoundException">
|
||
<summary>
|
||
The exception that is thrown when file or directory is not found.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SftpPathNotFoundException.Path">
|
||
<summary>
|
||
Gets the path that cannot be found.
|
||
</summary>
|
||
<value>
|
||
The path that cannot be found, or <see langword="null"/> if no path was
|
||
passed to the constructor for this instance.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPathNotFoundException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPathNotFoundException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPathNotFoundException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPathNotFoundException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPathNotFoundException.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPathNotFoundException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPathNotFoundException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPathNotFoundException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPathNotFoundException.#ctor(System.String,System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPathNotFoundException"/> class.
|
||
</summary>
|
||
<param name="message">The error message that explains the reason for the exception.</param>
|
||
<param name="path">The path that cannot be found.</param>
|
||
<param name="innerException">The exception that is the cause of the current exception.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SftpPermissionDeniedException">
|
||
<summary>
|
||
The exception that is thrown when operation permission is denied.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPermissionDeniedException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPermissionDeniedException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPermissionDeniedException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPermissionDeniedException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SftpPermissionDeniedException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SftpPermissionDeniedException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.ShellDataEventArgs">
|
||
<summary>
|
||
Provides data for Shell DataReceived event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ShellDataEventArgs.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ShellDataEventArgs"/> class.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.ShellDataEventArgs.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.ShellDataEventArgs"/> class.
|
||
</summary>
|
||
<param name="line">The line.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ShellDataEventArgs.Data">
|
||
<summary>
|
||
Gets the data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.ShellDataEventArgs.Line">
|
||
<summary>
|
||
Gets the line data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshAuthenticationException">
|
||
<summary>
|
||
The exception that is thrown when authentication failed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshAuthenticationException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshAuthenticationException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshAuthenticationException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshAuthenticationException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshAuthenticationException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshAuthenticationException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="innerException">The inner exception.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshConnectionException">
|
||
<summary>
|
||
The exception that is thrown when connection was terminated.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshConnectionException.DisconnectReason">
|
||
<summary>
|
||
Gets the disconnect reason if provided by the server or client. Otherwise None.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshConnectionException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshConnectionException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshConnectionException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshConnectionException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshConnectionException.#ctor(System.String,Renci.SshNet.Messages.Transport.DisconnectReason)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshConnectionException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="disconnectReasonCode">The disconnect reason code.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshConnectionException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshConnectionException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="inner">The inner.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshConnectionException.#ctor(System.String,Renci.SshNet.Messages.Transport.DisconnectReason,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshConnectionException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="disconnectReasonCode">The disconnect reason code.</param>
|
||
<param name="inner">The inner.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshData">
|
||
<summary>
|
||
Base ssh data serialization type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshData.DataStream">
|
||
<summary>
|
||
Gets the underlying <see cref="T:Renci.SshNet.Common.SshDataStream"/> that is used for reading and writing SSH data.
|
||
</summary>
|
||
<value>
|
||
The underlying <see cref="T:Renci.SshNet.Common.SshDataStream"/> that is used for reading and writing SSH data.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshData.IsEndOfData">
|
||
<summary>
|
||
Gets a value indicating whether all data from the buffer has been read.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this instance is end of data; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshData.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.GetBytes">
|
||
<summary>
|
||
Gets data bytes array.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:System.Byte"/> array representation of data structure.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.WriteBytes(Renci.SshNet.Common.SshDataStream)">
|
||
<summary>
|
||
Writes the current message to the specified <see cref="T:Renci.SshNet.Common.SshDataStream"/>.
|
||
</summary>
|
||
<param name="stream">The <see cref="T:Renci.SshNet.Common.SshDataStream"/> to write the message to.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Load(System.Byte[])">
|
||
<summary>
|
||
Loads data from specified bytes.
|
||
</summary>
|
||
<param name="data">Bytes array.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Load(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Loads data from the specified buffer.
|
||
</summary>
|
||
<param name="data">Bytes array.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="data"/> at which to begin reading SSH data.</param>
|
||
<param name="count">The number of bytes to load.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadBytes">
|
||
<summary>
|
||
Reads all data left in internal buffer at current position.
|
||
</summary>
|
||
<returns>
|
||
An array of bytes containing the remaining data in the internal buffer.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadBytes(System.Int32)">
|
||
<summary>
|
||
Reads next specified number of bytes data type from internal buffer.
|
||
</summary>
|
||
<param name="length">Number of bytes to read.</param>
|
||
<returns>
|
||
An array of bytes that was read from the internal buffer.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="length"/> is greater than the number of bytes available to be read.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadByte">
|
||
<summary>
|
||
Reads next byte data type from internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.Byte"/> read.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Attempt to read past the end of the stream.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadBoolean">
|
||
<summary>
|
||
Reads the next <see cref="T:System.Boolean"/> from the internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.Boolean"/> that was read.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Attempt to read past the end of the stream.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadUInt16">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt16"/> from the internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt16"/> that was read.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Attempt to read past the end of the stream.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadUInt32">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt32"/> from the internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt32"/> that was read.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Attempt to read past the end of the stream.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadUInt64">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt64"/> from the internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt64"/> that was read.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Attempt to read past the end of the stream.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadString(System.Text.Encoding)">
|
||
<summary>
|
||
Reads the next <see cref="T:System.String"/> from the internal buffer using the specified encoding.
|
||
</summary>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<returns>
|
||
The <see cref="T:System.String"/> that was read.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadBinary">
|
||
<summary>
|
||
Reads a length-prefixed byte array from the internal buffer.
|
||
</summary>
|
||
<returns>
|
||
The bytes read.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadBinarySegment">
|
||
<summary>
|
||
Reads a length-prefixed byte array from the internal buffer,
|
||
returned as a view over the buffer.
|
||
</summary>
|
||
<remarks>
|
||
When using this method, consider whether the underlying buffer is shared
|
||
or reused, and whether the returned <see cref="T:System.ArraySegment`1"/> may
|
||
exist beyond the lifetime for which it is valid to be used.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadNamesList">
|
||
<summary>
|
||
Reads next name-list data type from internal buffer.
|
||
</summary>
|
||
<returns>
|
||
String array or read data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.ReadExtensionPair">
|
||
<summary>
|
||
Reads next extension-pair data type from internal buffer.
|
||
</summary>
|
||
<returns>
|
||
Extensions pair dictionary.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Byte[])">
|
||
<summary>
|
||
Writes bytes array data into internal buffer.
|
||
</summary>
|
||
<param name="data">Byte array data to write.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Writes a sequence of bytes to the current SSH data stream and advances the current position
|
||
within this stream by the number of bytes written.
|
||
</summary>
|
||
<param name="buffer">An array of bytes. This method write <paramref name="count"/> bytes from buffer to the current SSH data stream.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="buffer"/> at which to begin writing bytes to the SSH data stream.</param>
|
||
<param name="count">The number of bytes to be written to the current SSH data stream.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> or <paramref name="count"/> is negative.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Byte)">
|
||
<summary>
|
||
Writes <see cref="T:System.Byte"/> data into internal buffer.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.Byte"/> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Boolean)">
|
||
<summary>
|
||
Writes <see cref="T:System.Boolean"/> into internal buffer.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.Boolean" /> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.UInt32)">
|
||
<summary>
|
||
Writes <see cref="T:System.UInt32"/> data into internal buffer.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.UInt32"/> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.UInt64)">
|
||
<summary>
|
||
Writes <see cref="T:System.UInt64" /> data into internal buffer.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.UInt64"/> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.String)">
|
||
<summary>
|
||
Writes <see cref="T:System.String"/> data into internal buffer using default encoding.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.String"/> data to write.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Writes <see cref="T:System.String"/> data into internal buffer using the specified encoding.
|
||
</summary>
|
||
<param name="data"><see cref="T:System.String"/> data to write.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Numerics.BigInteger)">
|
||
<summary>
|
||
Writes mpint data into internal buffer.
|
||
</summary>
|
||
<param name="data">mpint data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.String[])">
|
||
<summary>
|
||
Writes name-list data into internal buffer.
|
||
</summary>
|
||
<param name="data">name-list data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.Write(System.Collections.Generic.IDictionary{System.String,System.String})">
|
||
<summary>
|
||
Writes extension-pair data into internal buffer.
|
||
</summary>
|
||
<param name="data">extension-pair data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.WriteBinaryString(System.Byte[])">
|
||
<summary>
|
||
Writes data into internal buffer.
|
||
</summary>
|
||
<param name="buffer">The data to write.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshData.WriteBinary(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Writes data into internal buffer.
|
||
</summary>
|
||
<param name="buffer">An array of bytes. This method write <paramref name="count"/> bytes from buffer to the current SSH data stream.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin writing bytes to the SSH data stream.</param>
|
||
<param name="count">The number of bytes to be written to the current SSH data stream.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> or <paramref name="count"/> is negative.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshDataStream">
|
||
<summary>
|
||
Specialized <see cref="T:System.IO.MemoryStream"/> for reading and writing data SSH data.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.#ctor(System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshDataStream"/> class with an expandable capacity initialized
|
||
as specified.
|
||
</summary>
|
||
<param name="capacity">The initial size of the internal array in bytes.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshDataStream"/> class for the specified byte array.
|
||
</summary>
|
||
<param name="buffer">The array of unsigned bytes from which to create the current stream.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.#ctor(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshDataStream"/> class for the specified byte array.
|
||
</summary>
|
||
<param name="buffer">The array of unsigned bytes from which to create the current stream.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="buffer"/> at which to begin reading SSH data.</param>
|
||
<param name="count">The number of bytes to load.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshDataStream.IsEndOfData">
|
||
<summary>
|
||
Gets a value indicating whether all data from the SSH data stream has been read.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this instance is end of data; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.Write(System.UInt32)">
|
||
<summary>
|
||
Writes an <see cref="T:System.UInt32"/> to the SSH data stream.
|
||
</summary>
|
||
<param name="value"><see cref="T:System.UInt32"/> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.Write(System.UInt64)">
|
||
<summary>
|
||
Writes an <see cref="T:System.UInt64"/> to the SSH data stream.
|
||
</summary>
|
||
<param name="value"><see cref="T:System.UInt64"/> data to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.Write(System.Numerics.BigInteger)">
|
||
<summary>
|
||
Writes a <see cref="T:System.Numerics.BigInteger"/> into the SSH data stream.
|
||
</summary>
|
||
<param name="data">The <see cref="T:System.Numerics.BigInteger" /> to write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.Write(System.Byte[])">
|
||
<summary>
|
||
Writes bytes array data into the SSH data stream.
|
||
</summary>
|
||
<param name="data">Byte array data to write.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.Write(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Writes string data to the SSH data stream using the specified encoding.
|
||
</summary>
|
||
<param name="s">The string data to write.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="s"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadBinary">
|
||
<summary>
|
||
Reads a length-prefixed byte array from the SSH data stream.
|
||
</summary>
|
||
<returns>
|
||
The byte array read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadBinarySegment">
|
||
<summary>
|
||
Reads a length-prefixed byte array from the SSH data stream,
|
||
returned as a view over the underlying buffer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.GetRemainingBuffer">
|
||
<summary>
|
||
Gets a view over the remaining data in the underlying buffer.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.WriteBinary(System.Byte[])">
|
||
<summary>
|
||
Writes a buffer preceded by its length into the SSH data stream.
|
||
</summary>
|
||
<param name="buffer">The data to write.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.WriteBinary(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Writes a buffer preceded by its length into the SSH data stream.
|
||
</summary>
|
||
<param name="buffer">An array of bytes. This method write <paramref name="count"/> bytes from buffer to the current SSH data stream.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin writing bytes to the SSH data stream.</param>
|
||
<param name="count">The number of bytes to be written to the current SSH data stream.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> or <paramref name="count"/> is negative.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadBigInt">
|
||
<summary>
|
||
Reads a <see cref="T:System.Numerics.BigInteger"/> from the SSH data stream.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.Numerics.BigInteger"/> read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadUInt16">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt16"/> data type from the SSH data stream.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt16"/> read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadUInt32">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt32"/> data type from the SSH data stream.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt32"/> read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadUInt64">
|
||
<summary>
|
||
Reads the next <see cref="T:System.UInt64"/> data type from the SSH data stream.
|
||
</summary>
|
||
<returns>
|
||
The <see cref="T:System.UInt64"/> read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadString(System.Text.Encoding)">
|
||
<summary>
|
||
Reads the next <see cref="T:System.String"/> data type from the SSH data stream.
|
||
</summary>
|
||
<param name="encoding">The character encoding to use. Defaults to <see cref="P:System.Text.Encoding.UTF8"/>.</param>
|
||
<returns>
|
||
The <see cref="T:System.String"/> read from the SSH data stream.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ToArray">
|
||
<summary>
|
||
Retrieves the stream contents as a byte array, regardless of the <see cref="P:System.IO.MemoryStream.Position"/>.
|
||
</summary>
|
||
<returns>
|
||
This method returns the contents of the <see cref="T:Renci.SshNet.Common.SshDataStream"/> as a byte array.
|
||
</returns>
|
||
<remarks>
|
||
If the current instance was constructed on a provided byte array, a copy of the section of the array
|
||
to which this instance has access is returned.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshDataStream.ReadBytes(System.Int32)">
|
||
<summary>
|
||
Reads next specified number of bytes data type from internal buffer.
|
||
</summary>
|
||
<param name="length">Number of bytes to read.</param>
|
||
<returns>
|
||
An array of bytes that was read from the internal buffer.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="length"/> is greater than the internal buffer size.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshException">
|
||
<summary>
|
||
The exception that is thrown when an SSH exception occurs.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshException"/> class.
|
||
</summary>
|
||
<inheritdoc cref="M:System.Exception.#ctor(System.String,System.Exception)" path="/param"/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshIdentificationEventArgs">
|
||
<summary>
|
||
Provides data for the ServerIdentificationReceived events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshIdentificationEventArgs.#ctor(Renci.SshNet.Connection.SshIdentification)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshIdentificationEventArgs"/> class.
|
||
</summary>
|
||
<param name="sshIdentification">The SSH identification.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Common.SshIdentificationEventArgs.SshIdentification">
|
||
<summary>
|
||
Gets the SSH identification.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshOperationTimeoutException">
|
||
<summary>
|
||
The exception that is thrown when operation is timed out.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshOperationTimeoutException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshOperationTimeoutException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshOperationTimeoutException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshOperationTimeoutException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="innerException">The inner exception.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException">
|
||
<summary>
|
||
The exception that is thrown when pass phrase for key file is empty or <see langword="null"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException.#ctor(System.String,System.Exception)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Common.SshPassPhraseNullOrEmptyException"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<param name="innerException">The inner exception.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.TerminalModes">
|
||
<summary>
|
||
Specifies the initial assignments of the opcode values that are used in the 'encoded terminal modes' value.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.TTY_OP_END">
|
||
<summary>
|
||
Indicates end of options.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VINTR">
|
||
<summary>
|
||
Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VQUIT">
|
||
<summary>
|
||
The quit character (sends SIGQUIT signal on POSIX systems).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VERASE">
|
||
<summary>
|
||
Erase the character to left of the cursor.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VKILL">
|
||
<summary>
|
||
Kill the current input line.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VEOF">
|
||
<summary>
|
||
End-of-file character (sends EOF from the terminal).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VEOL">
|
||
<summary>
|
||
End-of-line character in addition to carriage return and/or linefeed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VEOL2">
|
||
<summary>
|
||
Additional end-of-line character.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VSTART">
|
||
<summary>
|
||
Continues paused output (normally control-Q).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VSTOP">
|
||
<summary>
|
||
Pauses output (normally control-S).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VSUSP">
|
||
<summary>
|
||
Suspends the current program.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VDSUSP">
|
||
<summary>
|
||
Another suspend character.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VREPRINT">
|
||
<summary>
|
||
Reprints the current input line.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VWERASE">
|
||
<summary>
|
||
Erases a word left of cursor.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VLNEXT">
|
||
<summary>
|
||
Enter the next character typed literally, even if it is a special character.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VFLUSH">
|
||
<summary>
|
||
Character to flush output.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VSWTCH">
|
||
<summary>
|
||
Switch to a different shell layer.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VSTATUS">
|
||
<summary>
|
||
Prints system status line (load, command, pid, etc).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.VDISCARD">
|
||
<summary>
|
||
Toggles the flushing of terminal output.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IGNPAR">
|
||
<summary>
|
||
The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.PARMRK">
|
||
<summary>
|
||
Mark parity and framing errors.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.INPCK">
|
||
<summary>
|
||
Enable checking of parity errors.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ISTRIP">
|
||
<summary>
|
||
Strip 8th bit off characters.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.INLCR">
|
||
<summary>
|
||
Map NL into CR on input.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IGNCR">
|
||
<summary>
|
||
Ignore CR on input.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ICRNL">
|
||
<summary>
|
||
Map CR to NL on input.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IUCLC">
|
||
<summary>
|
||
Translate uppercase characters to lowercase.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IXON">
|
||
<summary>
|
||
Enable output flow control.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IXANY">
|
||
<summary>
|
||
Any char will restart after stop.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IXOFF">
|
||
<summary>
|
||
Enable input flow control.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IMAXBEL">
|
||
<summary>
|
||
Ring bell on input queue full.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IUTF8">
|
||
<summary>
|
||
Terminal input and output is assumed to be encoded in UTF-8.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ISIG">
|
||
<summary>
|
||
Enable signals INTR, QUIT, [D]SUSP.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ICANON">
|
||
<summary>
|
||
Canonicalize input lines.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.XCASE">
|
||
<summary>
|
||
Enable input and output of uppercase characters by preceding their lowercase equivalents with "\".
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHO">
|
||
<summary>
|
||
Enable echoing.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHOE">
|
||
<summary>
|
||
Visually erase chars.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHOK">
|
||
<summary>
|
||
Kill character discards current line.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHONL">
|
||
<summary>
|
||
Echo NL even if ECHO is off.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.NOFLSH">
|
||
<summary>
|
||
Don't flush after interrupt.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.TOSTOP">
|
||
<summary>
|
||
Stop background jobs from output.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.IEXTEN">
|
||
<summary>
|
||
Enable extensions.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHOCTL">
|
||
<summary>
|
||
Echo control characters as ^(Char).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ECHOKE">
|
||
<summary>
|
||
Visual erase for line kill.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.PENDIN">
|
||
<summary>
|
||
Retype pending input.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.OPOST">
|
||
<summary>
|
||
Enable output processing.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.OLCUC">
|
||
<summary>
|
||
Convert lowercase to uppercase.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ONLCR">
|
||
<summary>
|
||
Map NL to CR-NL.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.OCRNL">
|
||
<summary>
|
||
Translate carriage return to newline (output).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ONOCR">
|
||
<summary>
|
||
Translate newline to carriage return-newline (output).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.ONLRET">
|
||
<summary>
|
||
Newline performs a carriage return (output).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.CS7">
|
||
<summary>
|
||
7 bit mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.CS8">
|
||
<summary>
|
||
8 bit mode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.PARENB">
|
||
<summary>
|
||
Parity enable.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.PARODD">
|
||
<summary>
|
||
Odd parity, else even.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.TTY_OP_ISPEED">
|
||
<summary>
|
||
Specifies the input baud rate in bits per second.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Common.TerminalModes.TTY_OP_OSPEED">
|
||
<summary>
|
||
Specifies the output baud rate in bits per second.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Common.TimeSpanExtensions">
|
||
<summary>
|
||
Provides extension methods for <see cref="T:System.TimeSpan"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.TimeSpanExtensions.AsTimeout(System.TimeSpan,System.String)">
|
||
<summary>
|
||
Returns the specified <paramref name="timeSpan"/> as a valid timeout in milliseconds.
|
||
</summary>
|
||
<param name="timeSpan">The <see cref="T:System.TimeSpan"/> to ensure validity.</param>
|
||
<param name="paramName">The name of the calling member.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||
Thrown when <paramref name="timeSpan"/> does not represent a value between -1 and <see cref="F:System.Int32.MaxValue"/>, inclusive.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Common.TimeSpanExtensions.EnsureValidTimeout(System.TimeSpan,System.String)">
|
||
<summary>
|
||
Ensures that the specified <paramref name="timeSpan"/> represents a valid timeout in milliseconds.
|
||
</summary>
|
||
<param name="timeSpan">The <see cref="T:System.TimeSpan"/> to ensure validity.</param>
|
||
<param name="paramName">The name of the calling member.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||
Thrown when <paramref name="timeSpan"/> does not represent a value between -1 and <see cref="F:System.Int32.MaxValue"/>, inclusive.
|
||
</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Compression.Compressor">
|
||
<summary>
|
||
Represents base class for compression algorithm implementation.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.#ctor(System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Compression.Compressor"/> class.
|
||
</summary>
|
||
<param name="delayedCompression">
|
||
<see langword="false"/> to start compression after receiving SSH_MSG_NEWKEYS.
|
||
<see langword="true"/> to delay compression until SSH_MSG_USERAUTH_SUCCESS is received.
|
||
See <see href="https://www.openssh.com/txt/draft-miller-secsh-compression-delayed-00.txt"/>.
|
||
</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Init(Renci.SshNet.Session)">
|
||
<summary>
|
||
Initializes the algorithm.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Compress(System.Byte[])">
|
||
<summary>
|
||
Compresses the specified data.
|
||
</summary>
|
||
<param name="data">Data to compress.</param>
|
||
<returns>
|
||
The compressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Compress(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Compresses the specified data.
|
||
</summary>
|
||
<param name="data">Data to compress.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading the data to compress. </param>
|
||
<param name="length">The number of bytes to be compressed. </param>
|
||
<returns>
|
||
The compressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.CompressCore(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Compresses the specified data.
|
||
</summary>
|
||
<param name="data">Data to compress.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading the data to compress. </param>
|
||
<param name="length">The number of bytes to be compressed. </param>
|
||
<returns>
|
||
The compressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Decompress(System.Byte[])">
|
||
<summary>
|
||
Decompresses the specified data.
|
||
</summary>
|
||
<param name="data">Compressed data.</param>
|
||
<returns>
|
||
The decompressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Decompress(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decompresses the specified data.
|
||
</summary>
|
||
<param name="data">Compressed data.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading the data to decompress. </param>
|
||
<param name="length">The number of bytes to be read from the compressed data. </param>
|
||
<returns>
|
||
The decompressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.DecompressCore(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decompresses the specified data.
|
||
</summary>
|
||
<param name="data">Compressed data.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading the data to decompress. </param>
|
||
<param name="length">The number of bytes to be read from the compressed data. </param>
|
||
<returns>
|
||
The decompressed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Compressor.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Compression.Zlib">
|
||
<summary>
|
||
Represents the "zlib" compression algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Zlib.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Compression.Zlib"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Zlib.#ctor(System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Compression.Zlib"/> class.
|
||
</summary>
|
||
<param name="delayedCompression">
|
||
<inheritdoc cref="M:Renci.SshNet.Compression.Compressor.#ctor(System.Boolean)" path="/param[@name='delayedCompression']"/>
|
||
</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Compression.Zlib.Name">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Zlib.CompressCore(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Zlib.DecompressCore(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.Zlib.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Compression.ZlibOpenSsh">
|
||
<summary>
|
||
Represents the "zlib@openssh.com" compression algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Compression.ZlibOpenSsh.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Compression.ZlibOpenSsh"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Compression.ZlibOpenSsh.Name">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ConnectionInfo">
|
||
<summary>
|
||
Represents remote connection information class.
|
||
</summary>
|
||
<remarks>
|
||
This class is NOT thread-safe. Do not use the same <see cref="T:Renci.SshNet.ConnectionInfo"/> with multiple
|
||
client instances.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ConnectionInfo.DefaultTimeout">
|
||
<summary>
|
||
The default connection timeout.
|
||
</summary>
|
||
<value>
|
||
30 seconds.
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ConnectionInfo.DefaultChannelCloseTimeout">
|
||
<summary>
|
||
The default channel close timeout.
|
||
</summary>
|
||
<value>
|
||
1 second.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.KeyExchangeAlgorithms">
|
||
<summary>
|
||
Gets supported key exchange algorithms for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Encryptions">
|
||
<summary>
|
||
Gets supported encryptions for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.HmacAlgorithms">
|
||
<summary>
|
||
Gets supported hash algorithms for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.HostKeyAlgorithms">
|
||
<summary>
|
||
Gets supported host key algorithms for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.AuthenticationMethods">
|
||
<summary>
|
||
Gets supported authentication methods for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CompressionAlgorithms">
|
||
<summary>
|
||
Gets supported compression algorithms for this connection.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ChannelRequests">
|
||
<summary>
|
||
Gets the supported channel requests for this connection.
|
||
</summary>
|
||
<value>
|
||
The supported channel requests for this connection.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.IsAuthenticated">
|
||
<summary>
|
||
Gets a value indicating whether connection is authenticated.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if connection is authenticated; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Host">
|
||
<summary>
|
||
Gets connection host.
|
||
</summary>
|
||
<value>
|
||
The connection host.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Port">
|
||
<summary>
|
||
Gets connection port.
|
||
</summary>
|
||
<value>
|
||
The connection port. The default value is 22.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Username">
|
||
<summary>
|
||
Gets connection username.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ProxyType">
|
||
<summary>
|
||
Gets proxy type.
|
||
</summary>
|
||
<value>
|
||
The type of the proxy.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ProxyHost">
|
||
<summary>
|
||
Gets proxy connection host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ProxyPort">
|
||
<summary>
|
||
Gets proxy connection port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ProxyUsername">
|
||
<summary>
|
||
Gets proxy connection username.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ProxyPassword">
|
||
<summary>
|
||
Gets proxy connection password.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Timeout">
|
||
<summary>
|
||
Gets or sets connection timeout.
|
||
</summary>
|
||
<value>
|
||
The connection timeout. The default value is 30 seconds.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ChannelCloseTimeout">
|
||
<summary>
|
||
Gets or sets the timeout to use when waiting for a server to acknowledge closing a channel.
|
||
</summary>
|
||
<value>
|
||
The channel close timeout. The default value is 1 second.
|
||
</value>
|
||
<remarks>
|
||
If a server does not send a <c>SSH_MSG_CHANNEL_CLOSE</c> message before the specified timeout
|
||
elapses, the channel will be closed immediately.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Encoding">
|
||
<summary>
|
||
Gets or sets the character encoding.
|
||
</summary>
|
||
<value>
|
||
The character encoding. The default is <see cref="P:System.Text.Encoding.UTF8"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.RetryAttempts">
|
||
<summary>
|
||
Gets or sets number of retry attempts when session channel creation failed.
|
||
</summary>
|
||
<value>
|
||
The number of retry attempts when session channel creation failed. The default
|
||
value is 10.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.MaxSessions">
|
||
<summary>
|
||
Gets or sets maximum number of session channels to be open simultaneously.
|
||
</summary>
|
||
<value>
|
||
The maximum number of session channels to be open simultaneously. The default
|
||
value is 10.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ConnectionInfo.AuthenticationBanner">
|
||
<summary>
|
||
Occurs when authentication banner is sent by the server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentKeyExchangeAlgorithm">
|
||
<summary>
|
||
Gets the current key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentServerEncryption">
|
||
<summary>
|
||
Gets the current server encryption.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentClientEncryption">
|
||
<summary>
|
||
Gets the current client encryption.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentServerHmacAlgorithm">
|
||
<summary>
|
||
Gets the current server hash algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentClientHmacAlgorithm">
|
||
<summary>
|
||
Gets the current client hash algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentHostKeyAlgorithm">
|
||
<summary>
|
||
Gets the current host key algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentServerCompressionAlgorithm">
|
||
<summary>
|
||
Gets the current server compression algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ServerVersion">
|
||
<summary>
|
||
Gets the server version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.ClientVersion">
|
||
<summary>
|
||
Gets the client version.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.CurrentClientCompressionAlgorithm">
|
||
<summary>
|
||
Gets the current client compression algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.AuthenticationMethod[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="username">The username.</param>
|
||
<param name="authenticationMethods">The authentication methods.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is a zero-length string.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username" /> is <see langword="null"/>, a zero-length string or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="authenticationMethods"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">No <paramref name="authenticationMethods"/> specified.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.AuthenticationMethod[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">The username.</param>
|
||
<param name="authenticationMethods">The authentication methods.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username" /> is <see langword="null"/>, a zero-length string or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is not within <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="authenticationMethods"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">No <paramref name="authenticationMethods"/> specified.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String,Renci.SshNet.AuthenticationMethod[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ConnectionInfo" /> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
<param name="authenticationMethods">The authentication methods.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username" /> is <see langword="null"/>, a zero-length string or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is not within <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="proxyType"/> is not <see cref="F:Renci.SshNet.ProxyTypes.None"/> and <paramref name="proxyHost" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="proxyType"/> is not <see cref="F:Renci.SshNet.ProxyTypes.None"/> and <paramref name="proxyPort" /> is not within <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="authenticationMethods"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">No <paramref name="authenticationMethods"/> specified.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.Authenticate(Renci.SshNet.ISession,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to be authenticated.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="session"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">No suitable authentication method found to complete authentication, or permission denied.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.Renci#SshNet#IConnectionInfoInternal#UserAuthenticationBannerReceived(System.Object,Renci.SshNet.MessageEventArgs{Renci.SshNet.Messages.Authentication.BannerMessage})">
|
||
<summary>
|
||
Signals that an authentication banner message was received from the server.
|
||
</summary>
|
||
<param name="sender">The session in which the banner message was received.</param>
|
||
<param name="e">The banner message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ConnectionInfo.Renci#SshNet#IConnectionInfoInternal#CreateNoneAuthenticationMethod">
|
||
<summary>
|
||
Creates a <c>none</c> authentication method.
|
||
</summary>
|
||
<returns>
|
||
A <c>none</c> authentication method.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.Renci#SshNet#IConnectionInfoInternal#AuthenticationMethods">
|
||
<summary>
|
||
Gets the supported authentication methods for this connection.
|
||
</summary>
|
||
<value>
|
||
The supported authentication methods for this connection.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ConnectionInfo.LoggerFactory">
|
||
<summary>
|
||
Gets or sets logger factory for this connection.
|
||
</summary>
|
||
<value>
|
||
The logger factory for this connection. If <see langword="null"/> then <see cref="P:Renci.SshNet.SshNetLoggingConfiguration.LoggerFactory"/> is used.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ConnectorBase.SocketConnect(System.Net.EndPoint,System.TimeSpan)">
|
||
<summary>
|
||
Establishes a socket connection to the specified endpoint.
|
||
</summary>
|
||
<param name="endPoint">The <see cref="T:System.Net.EndPoint"/> representing the server to connect to.</param>
|
||
<param name="timeout">The maximum time to wait for the connection to be established.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The connection failed to establish within the configured <see cref="P:Renci.SshNet.ConnectionInfo.Timeout"/>.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">An error occurred trying to establish the connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ConnectorBase.SocketConnectAsync(System.Net.EndPoint,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Establishes a socket connection to the specified endpoint.
|
||
</summary>
|
||
<param name="endPoint">The <see cref="T:System.Net.EndPoint"/> representing the server to connect to.</param>
|
||
<param name="cancellationToken">The cancellation token to observe.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The connection failed to establish within the configured <see cref="P:Renci.SshNet.ConnectionInfo.Timeout"/>.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">An error occurred trying to establish the connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ConnectorBase.SocketRead(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Performs a blocking read on the socket until <paramref name="length"/> bytes are received.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="buffer">An array of type <see cref="T:System.Byte"/> that is the storage location for the received data.</param>
|
||
<param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param>
|
||
<param name="length">The number of bytes to read.</param>
|
||
<returns>
|
||
The number of bytes read.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The socket is closed.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">The read failed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ConnectorBase.SocketRead(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32,System.TimeSpan)">
|
||
<summary>
|
||
Performs a blocking read on the socket until <paramref name="length"/> bytes are received.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="buffer">An array of type <see cref="T:System.Byte"/> that is the storage location for the received data.</param>
|
||
<param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param>
|
||
<param name="length">The number of bytes to read.</param>
|
||
<param name="readTimeout">The maximum time to wait until <paramref name="length"/> bytes have been received.</param>
|
||
<returns>
|
||
The number of bytes read.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The socket is closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read has timed-out.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">The read failed.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.HttpConnector">
|
||
<summary>
|
||
Establishes a tunnel via an HTTP proxy server.
|
||
</summary>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader>
|
||
<term>Specification</term>
|
||
<description>URL</description>
|
||
</listheader>
|
||
<item>
|
||
<term>HTTP CONNECT method</term>
|
||
<description>https://tools.ietf.org/html/rfc7231#section-4.3.6</description>
|
||
</item>
|
||
<item>
|
||
<term>HTTP Authentication: Basic and Digest Access Authentication</term>
|
||
<description>https://tools.ietf.org/html/rfc2617</description>
|
||
</item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.HttpConnector.GetHttpResponseRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>HTTP/(?<version>\\d[.]\\d) (?<statusCode>\\d{3}) (?<reasonPhrase>.+)$</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match the string "HTTP/".<br/>
|
||
○ "version" capture group.<br/>
|
||
○ Match a Unicode digit.<br/>
|
||
○ Match '.'.<br/>
|
||
○ Match a Unicode digit.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "statusCode" capture group.<br/>
|
||
○ Match a Unicode digit exactly 3 times.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "reasonPhrase" capture group.<br/>
|
||
○ Match a character other than '\n' greedily at least once.<br/>
|
||
○ Match if at the end of the string or if before an ending newline.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.HttpConnector.GetHttpHeaderRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>(?<fieldName>[^\\[\\]()<>@,;:\\"/?={} \\t]+):(?<fieldValue>.+)?</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ "fieldName" capture group.<br/>
|
||
○ Match a character in the set [^\t "(),/:-@[]{}] atomically at least once.<br/>
|
||
○ Match ':'.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ "fieldValue" capture group.<br/>
|
||
○ Match a character other than '\n' atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.HttpConnector.SocketReadLine(System.Net.Sockets.Socket,System.TimeSpan)">
|
||
<summary>
|
||
Performs a blocking read on the socket until a line is read.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="readTimeout">A <see cref="T:System.TimeSpan"/> that represents the time to wait until a line is read.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read has timed-out.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when trying to access the socket.</exception>
|
||
<returns>
|
||
The line read from the socket, or <see langword="null"/> when the remote server has shutdown and all data has been received.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.IConnector">
|
||
<summary>
|
||
Represents a means to connect to a SSH endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.IConnector.Connect(Renci.SshNet.IConnectionInfo)">
|
||
<summary>
|
||
Connects to a SSH endpoint using the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.IConnectionInfo"/> to use to establish a connection to a SSH endpoint.</param>
|
||
<returns>
|
||
A <see cref="T:System.Net.Sockets.Socket"/> connected to the SSH endpoint represented by the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.IConnector.ConnectAsync(Renci.SshNet.IConnectionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects to a SSH endpoint using the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.IConnectionInfo"/> to use to establish a connection to a SSH endpoint.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A <see cref="T:System.Net.Sockets.Socket"/> connected to the SSH endpoint represented by the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.IProtocolVersionExchange">
|
||
<summary>
|
||
Handles the SSH protocol version exchange.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.IProtocolVersionExchange.Start(System.String,System.Net.Sockets.Socket,System.TimeSpan)">
|
||
<summary>
|
||
Performs the SSH protocol version exchange.
|
||
</summary>
|
||
<param name="clientVersion">The identification string of the SSH client.</param>
|
||
<param name="socket">A <see cref="T:System.Net.Sockets.Socket"/> connected to the server.</param>
|
||
<param name="timeout">The maximum time to wait for the server to respond.</param>
|
||
<returns>
|
||
The SSH identification of the server.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.IProtocolVersionExchange.StartAsync(System.String,System.Net.Sockets.Socket,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs the SSH protocol version exchange.
|
||
</summary>
|
||
<param name="clientVersion">The identification string of the SSH client.</param>
|
||
<param name="socket">A <see cref="T:System.Net.Sockets.Socket"/> connected to the server.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the SSH protocol version exchange. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the SSH identification of the server.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.ISocketFactory">
|
||
<summary>
|
||
Represents a factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ISocketFactory.Create(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
|
||
<summary>
|
||
Creates a <see cref="T:System.Net.Sockets.Socket"/> with the specified <see cref="T:System.Net.Sockets.SocketType"/>
|
||
and <see cref="T:System.Net.Sockets.ProtocolType"/> that does not use the <c>Nagle</c> algorithm.
|
||
</summary>
|
||
<param name="socketType">The <see cref="T:System.Net.Sockets.SocketType"/>.</param>
|
||
<param name="protocolType">The <see cref="T:System.Net.Sockets.ProtocolType"/>.</param>
|
||
<returns>
|
||
The <see cref="T:System.Net.Sockets.Socket"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.ProtocolVersionExchange">
|
||
<summary>
|
||
Handles the SSH protocol version exchange.
|
||
</summary>
|
||
<remarks>
|
||
https://tools.ietf.org/html/rfc4253#section-4.2.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProtocolVersionExchange.GetServerVersionRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>^SSH-(?<protoversion>[^-]+)-(?<softwareversion>.*?)([ ](?<comments>.+))?$</code><br/>
|
||
Options:<br/>
|
||
<code>RegexOptions.ExplicitCapture</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match if at the beginning of the string.<br/>
|
||
○ Match the string "SSH-".<br/>
|
||
○ "protoversion" capture group.<br/>
|
||
○ Match a character other than '-' atomically at least once.<br/>
|
||
○ Match '-'.<br/>
|
||
○ "softwareversion" capture group.<br/>
|
||
○ Match a character other than '\n' lazily any number of times.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ Match ' '.<br/>
|
||
○ "comments" capture group.<br/>
|
||
○ Match a character other than '\n' greedily at least once.<br/>
|
||
○ Match if at the end of the string or if before an ending newline.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProtocolVersionExchange.Start(System.String,System.Net.Sockets.Socket,System.TimeSpan)">
|
||
<summary>
|
||
Performs the SSH protocol version exchange.
|
||
</summary>
|
||
<param name="clientVersion">The identification string of the SSH client.</param>
|
||
<param name="socket">A <see cref="T:System.Net.Sockets.Socket"/> connected to the server.</param>
|
||
<param name="timeout">The maximum time to wait for the server to respond.</param>
|
||
<returns>
|
||
The SSH identification of the server.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProtocolVersionExchange.StartAsync(System.String,System.Net.Sockets.Socket,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs the SSH protocol version exchange.
|
||
</summary>
|
||
<param name="clientVersion">The identification string of the SSH client.</param>
|
||
<param name="socket">A <see cref="T:System.Net.Sockets.Socket"/> connected to the server.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the SSH protocol version exchange. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the SSH identification of the server.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProtocolVersionExchange.SocketReadLine(System.Net.Sockets.Socket,System.TimeSpan,System.Collections.Generic.List{System.Byte})">
|
||
<summary>
|
||
Performs a blocking read on the socket until a line is read.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the time to wait until a line is read.</param>
|
||
<param name="buffer">A <see cref="T:System.Collections.Generic.List`1"/> to which read bytes will be added.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read has timed-out.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when trying to access the socket.</exception>
|
||
<returns>
|
||
The line read from the socket, or <see langword="null"/> when the remote server has shutdown and all data has been received.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.ProxyConnector">
|
||
<summary>
|
||
Represents a connector that uses a proxy server to establish a connection to a given SSH
|
||
endpoint.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProxyConnector.Connect(Renci.SshNet.IConnectionInfo)">
|
||
<summary>
|
||
Connects to a SSH endpoint using the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.IConnectionInfo"/> to use to establish a connection to a SSH endpoint.</param>
|
||
<returns>
|
||
A <see cref="T:System.Net.Sockets.Socket"/> connected to the SSH endpoint represented by the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.ProxyConnector.ConnectAsync(Renci.SshNet.IConnectionInfo,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects to a SSH endpoint using the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.IConnectionInfo"/> to use to establish a connection to a SSH endpoint.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A <see cref="T:System.Net.Sockets.Socket"/> connected to the SSH endpoint represented by the specified <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.SocketFactory">
|
||
<summary>
|
||
Represents a factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.SocketFactory.Create(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.Socks4Connector">
|
||
<summary>
|
||
Establishes a tunnel via a SOCKS4 proxy server.
|
||
</summary>
|
||
<remarks>
|
||
https://www.openssh.com/txt/socks4.protocol.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.Socks4Connector.HandleProxyConnect(Renci.SshNet.IConnectionInfo,System.Net.Sockets.Socket)">
|
||
<summary>
|
||
Establishes a connection to the server via a SOCKS5 proxy.
|
||
</summary>
|
||
<param name="connectionInfo">The connection information.</param>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/>.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.Socks5Connector">
|
||
<summary>
|
||
Establishes a tunnel via a SOCKS5 proxy server.
|
||
</summary>
|
||
<remarks>
|
||
https://en.wikipedia.org/wiki/SOCKS#SOCKS5.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.Socks5Connector.HandleProxyConnect(Renci.SshNet.IConnectionInfo,System.Net.Sockets.Socket)">
|
||
<summary>
|
||
Establishes a connection to the server via a SOCKS5 proxy.
|
||
</summary>
|
||
<param name="connectionInfo">The connection information.</param>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/>.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.Socks5Connector.CreateSocks5UserNameAndPasswordAuthenticationRequest(System.String,System.String)">
|
||
<summary>
|
||
https://tools.ietf.org/html/rfc1929.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Connection.SshIdentification">
|
||
<summary>
|
||
Represents an SSH identification.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.SshIdentification.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Connection.SshIdentification"/> class with the specified protocol version
|
||
and software version.
|
||
</summary>
|
||
<param name="protocolVersion">The SSH protocol version.</param>
|
||
<param name="softwareVersion">The software version of the implementation.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="protocolVersion"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="softwareVersion"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.SshIdentification.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Connection.SshIdentification"/> class with the specified protocol version,
|
||
software version and comments.
|
||
</summary>
|
||
<param name="protocolVersion">The SSH protocol version.</param>
|
||
<param name="softwareVersion">The software version of the implementation.</param>
|
||
<param name="comments">The comments.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="protocolVersion"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="softwareVersion"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Connection.SshIdentification.SoftwareVersion">
|
||
<summary>
|
||
Gets the software version of the implementation.
|
||
</summary>
|
||
<value>
|
||
The software version of the implementation.
|
||
</value>
|
||
<remarks>
|
||
This is primarily used to trigger compatibility extensions and to indicate
|
||
the capabilities of an implementation.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Connection.SshIdentification.ProtocolVersion">
|
||
<summary>
|
||
Gets the SSH protocol version.
|
||
</summary>
|
||
<value>
|
||
The SSH protocol version.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Connection.SshIdentification.Comments">
|
||
<summary>
|
||
Gets the comments.
|
||
</summary>
|
||
<value>
|
||
The comments, or <see langword="null"/> if there are no comments.
|
||
</value>
|
||
<remarks>
|
||
<see cref="P:Renci.SshNet.Connection.SshIdentification.Comments"/> should contain additional information that might be useful
|
||
in solving user problems.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Connection.SshIdentification.ToString">
|
||
<summary>
|
||
Returns the SSH identification string.
|
||
</summary>
|
||
<returns>
|
||
The SSH identification string.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ExpectAction">
|
||
<summary>
|
||
Specifies behavior for expected expression.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ExpectAction.Expect">
|
||
<summary>
|
||
Gets the expected regular expression.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ExpectAction.Action">
|
||
<summary>
|
||
Gets the action to perform when expected expression is found.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ExpectAction.#ctor(System.Text.RegularExpressions.Regex,System.Action{System.String})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ExpectAction"/> class.
|
||
</summary>
|
||
<param name="expect">The expect regular expression.</param>
|
||
<param name="action">The action to perform.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="expect"/> or <paramref name="action"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ExpectAction.#ctor(System.String,System.Action{System.String})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ExpectAction"/> class.
|
||
</summary>
|
||
<param name="expect">The expect expression.</param>
|
||
<param name="action">The action to perform.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="expect"/> or <paramref name="action"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ForwardedPort">
|
||
<summary>
|
||
Base class for port forwarding functionality.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPort.Session">
|
||
<summary>
|
||
Gets or sets the session.
|
||
</summary>
|
||
<value>
|
||
The session.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPort.IsStarted">
|
||
<summary>
|
||
Gets a value indicating whether port forwarding is started.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if port forwarding is started; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ForwardedPort.Closing">
|
||
<summary>
|
||
The <see cref="E:Renci.SshNet.ForwardedPort.Closing"/> event occurs as the forwarded port is being stopped.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ForwardedPort.Exception">
|
||
<summary>
|
||
Occurs when an exception is thrown.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ForwardedPort.RequestReceived">
|
||
<summary>
|
||
Occurs when a port forwarding request is received.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.Start">
|
||
<summary>
|
||
Starts port forwarding.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The current <see cref="T:Renci.SshNet.ForwardedPort"/> is already started -or- is not linked to a SSH session.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.Stop">
|
||
<summary>
|
||
Stops port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.StartPort">
|
||
<summary>
|
||
Starts port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.StopPort(System.TimeSpan)">
|
||
<summary>
|
||
Stops port forwarding, and waits for the specified timeout until all pending
|
||
requests are processed.
|
||
</summary>
|
||
<param name="timeout">The maximum amount of time to wait for pending requests to finish processing.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langowrd="true"/> to release both managed and unmanaged resources; <see langowrd="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.CheckDisposed">
|
||
<summary>
|
||
Ensures the current instance is not disposed.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The current instance is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.RaiseExceptionEvent(System.Exception)">
|
||
<summary>
|
||
Raises <see cref="E:Renci.SshNet.ForwardedPort.Exception"/> event.
|
||
</summary>
|
||
<param name="exception">The exception.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.RaiseRequestReceived(System.String,System.UInt32)">
|
||
<summary>
|
||
Raises <see cref="E:Renci.SshNet.ForwardedPort.RequestReceived"/> event.
|
||
</summary>
|
||
<param name="host">Request originator host.</param>
|
||
<param name="port">Request originator port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.RaiseClosing">
|
||
<summary>
|
||
Raises the <see cref="E:Renci.SshNet.IForwardedPort.Closing"/> event.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPort.Session_ErrorOccurred(System.Object,Renci.SshNet.Common.ExceptionEventArgs)">
|
||
<summary>
|
||
Handles session ErrorOccurred event.
|
||
</summary>
|
||
<param name="sender">The source of the event.</param>
|
||
<param name="e">The <see cref="T:Renci.SshNet.Common.ExceptionEventArgs"/> instance containing the event data.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ForwardedPortDynamic">
|
||
<summary>
|
||
Provides functionality for forwarding connections from the client to destination servers via the SSH server,
|
||
also known as dynamic port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ForwardedPortDynamic._isDisposed">
|
||
<summary>
|
||
Holds a value indicating whether the current instance is disposed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the current instance is disposed; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortDynamic.BoundHost">
|
||
<summary>
|
||
Gets the bound host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortDynamic.BoundPort">
|
||
<summary>
|
||
Gets the bound port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortDynamic.IsStarted">
|
||
<summary>
|
||
Gets a value indicating whether port forwarding is started.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if port forwarding is started; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortDynamic"/> class.
|
||
</summary>
|
||
<param name="port">The port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.#ctor(System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortDynamic"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.StartPort">
|
||
<summary>
|
||
Starts local port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.StopPort(System.TimeSpan)">
|
||
<summary>
|
||
Stops local port forwarding, and waits for the specified timeout until all pending
|
||
requests are processed.
|
||
</summary>
|
||
<param name="timeout">The maximum amount of time to wait for pending requests to finish processing.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.CheckDisposed">
|
||
<summary>
|
||
Ensures the current instance is not disposed.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The current instance is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.InitializePendingChannelCountdown">
|
||
<summary>
|
||
Initializes the <see cref="T:System.Threading.CountdownEvent"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para>
|
||
When the port is started for the first time, a <see cref="T:System.Threading.CountdownEvent"/> is created with an initial count
|
||
of <c>1</c>.
|
||
</para>
|
||
<para>
|
||
On subsequent (re)starts, we'll dispose the current <see cref="T:System.Threading.CountdownEvent"/> and create a new one with
|
||
initial count of <c>1</c>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.StopListener">
|
||
<summary>
|
||
Interrupts the listener, and unsubscribes from <see cref="T:Renci.SshNet.Session"/> events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.InternalStop(System.TimeSpan)">
|
||
<summary>
|
||
Waits for pending channels to close.
|
||
</summary>
|
||
<param name="timeout">The maximum time to wait for the pending channels to close.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.ReadString(System.Net.Sockets.Socket,System.TimeSpan)">
|
||
<summary>
|
||
Reads a null terminated string from a socket.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="timeout">The timeout to apply to individual reads.</param>
|
||
<returns>
|
||
The <see cref="T:System.String"/> read, or <see langword="null"/> when the socket was closed.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortDynamic.Finalize">
|
||
<summary>
|
||
Finalizes an instance of the <see cref="T:Renci.SshNet.ForwardedPortDynamic"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ForwardedPortLocal">
|
||
<summary>
|
||
Provides functionality for local port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortLocal.BoundHost">
|
||
<summary>
|
||
Gets the bound host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortLocal.BoundPort">
|
||
<summary>
|
||
Gets the bound port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortLocal.Host">
|
||
<summary>
|
||
Gets the forwarded host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortLocal.Port">
|
||
<summary>
|
||
Gets the forwarded port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortLocal.IsStarted">
|
||
<summary>
|
||
Gets a value indicating whether port forwarding is started.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if port forwarding is started; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.#ctor(System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortLocal"/> class.
|
||
</summary>
|
||
<param name="boundPort">The bound port.</param>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="boundPort" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.#ctor(System.String,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortLocal"/> class.
|
||
</summary>
|
||
<param name="boundHost">The bound host.</param>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="boundHost"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.#ctor(System.String,System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortLocal"/> class.
|
||
</summary>
|
||
<param name="boundHost">The bound host.</param>
|
||
<param name="boundPort">The bound port.</param>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="boundHost"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="host"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="boundPort" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.StartPort">
|
||
<summary>
|
||
Starts local port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.StopPort(System.TimeSpan)">
|
||
<summary>
|
||
Stops local port forwarding, and waits for the specified timeout until all pending
|
||
requests are processed.
|
||
</summary>
|
||
<param name="timeout">The maximum amount of time to wait for pending requests to finish processing.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.CheckDisposed">
|
||
<summary>
|
||
Ensures the current instance is not disposed.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The current instance is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.Finalize">
|
||
<summary>
|
||
Finalizes an instance of the <see cref="T:Renci.SshNet.ForwardedPortLocal"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.InitializePendingChannelCountdown">
|
||
<summary>
|
||
Initializes the <see cref="T:System.Threading.CountdownEvent"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para>
|
||
When the port is started for the first time, a <see cref="T:System.Threading.CountdownEvent"/> is created with an initial count
|
||
of <c>1</c>.
|
||
</para>
|
||
<para>
|
||
On subsequent (re)starts, we'll dispose the current <see cref="T:System.Threading.CountdownEvent"/> and create a new one with
|
||
initial count of <c>1</c>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.StopListener">
|
||
<summary>
|
||
Interrupts the listener, and unsubscribes from <see cref="T:Renci.SshNet.Session"/> events.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortLocal.InternalStop(System.TimeSpan)">
|
||
<summary>
|
||
Waits for pending channels to close.
|
||
</summary>
|
||
<param name="timeout">The maximum time to wait for the pending channels to close.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ForwardedPortRemote">
|
||
<summary>
|
||
Provides functionality for remote port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.IsStarted">
|
||
<summary>
|
||
Gets a value indicating whether port forwarding is started.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if port forwarding is started; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.BoundHostAddress">
|
||
<summary>
|
||
Gets the bound host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.BoundHost">
|
||
<summary>
|
||
Gets the bound host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.BoundPort">
|
||
<summary>
|
||
Gets the bound port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.HostAddress">
|
||
<summary>
|
||
Gets the forwarded host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.Host">
|
||
<summary>
|
||
Gets the forwarded host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ForwardedPortRemote.Port">
|
||
<summary>
|
||
Gets the forwarded port.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.#ctor(System.Net.IPAddress,System.UInt32,System.Net.IPAddress,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortRemote" /> class.
|
||
</summary>
|
||
<param name="boundHostAddress">The bound host address.</param>
|
||
<param name="boundPort">The bound port.</param>
|
||
<param name="hostAddress">The host address.</param>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="boundHostAddress"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="hostAddress"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="boundPort" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.#ctor(System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortRemote"/> class.
|
||
</summary>
|
||
<param name="boundPort">The bound port.</param>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.#ctor(System.String,System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ForwardedPortRemote"/> class.
|
||
</summary>
|
||
<param name="boundHost">The bound host.</param>
|
||
<param name="boundPort">The bound port.</param>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.StartPort">
|
||
<summary>
|
||
Starts remote port forwarding.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.StopPort(System.TimeSpan)">
|
||
<summary>
|
||
Stops remote port forwarding.
|
||
</summary>
|
||
<param name="timeout">The maximum amount of time to wait for the port to stop.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.CheckDisposed">
|
||
<summary>
|
||
Ensures the current instance is not disposed.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The current instance is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.InitializePendingChannelCountdown">
|
||
<summary>
|
||
Initializes the <see cref="T:System.Threading.CountdownEvent"/>.
|
||
</summary>
|
||
<remarks>
|
||
<para>
|
||
When the port is started for the first time, a <see cref="T:System.Threading.CountdownEvent"/> is created with an initial count
|
||
of <c>1</c>.
|
||
</para>
|
||
<para>
|
||
On subsequent (re)starts, we'll dispose the current <see cref="T:System.Threading.CountdownEvent"/> and create a new one with
|
||
initial count of <c>1</c>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortRemote.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortStatus.ToStopping(Renci.SshNet.ForwardedPortStatus@)">
|
||
<summary>
|
||
Returns a value indicating whether <paramref name="status"/> has been changed to <see cref="F:Renci.SshNet.ForwardedPortStatus.Stopping"/>.
|
||
</summary>
|
||
<param name="status">The status to transition from.</param>
|
||
<returns>
|
||
<see langword="true"/> if <paramref name="status"/> has been changed to <see cref="F:Renci.SshNet.ForwardedPortStatus.Stopping"/>; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Cannot transition <paramref name="status"/> to <see cref="F:Renci.SshNet.ForwardedPortStatus.Stopping"/>.</exception>
|
||
<remarks>
|
||
While a transition from <see cref="F:Renci.SshNet.ForwardedPortStatus.Stopped"/> to <see cref="F:Renci.SshNet.ForwardedPortStatus.Stopping"/> is not possible, this method will
|
||
return <see langword="false"/> for any such attempts. This is related to concurrency.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ForwardedPortStatus.ToStarting(Renci.SshNet.ForwardedPortStatus@)">
|
||
<summary>
|
||
Returns a value indicating whether <paramref name="status"/> has been changed to <see cref="F:Renci.SshNet.ForwardedPortStatus.Starting"/>.
|
||
</summary>
|
||
<param name="status">The status to transition from.</param>
|
||
<returns>
|
||
<see langword="true"/> if <paramref name="status"/> has been changed to <see cref="F:Renci.SshNet.ForwardedPortStatus.Starting"/>; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Cannot transition <paramref name="status"/> to <see cref="F:Renci.SshNet.ForwardedPortStatus.Starting"/>.</exception>
|
||
<remarks>
|
||
While a transition from <see cref="F:Renci.SshNet.ForwardedPortStatus.Started"/> to <see cref="F:Renci.SshNet.ForwardedPortStatus.Starting"/> is not possible, this method will
|
||
return <see langword="false"/> for any such attempts. This is related to concurrency.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.HashInfo">
|
||
<summary>
|
||
Holds information about key size and cipher to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.HashInfo.KeySize">
|
||
<summary>
|
||
Gets the size of the key.
|
||
</summary>
|
||
<value>
|
||
The size of the key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.HashInfo.IsEncryptThenMAC">
|
||
<summary>
|
||
Gets a value indicating whether the MAC algorithm will use encrypt-then-MAC ordering.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.HashInfo.HashAlgorithm">
|
||
<summary>
|
||
Gets the method for creating a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance
|
||
given a key.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.HashInfo.#ctor(System.Int32,System.Func{System.Byte[],System.Security.Cryptography.HashAlgorithm},System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.HashInfo"/> class.
|
||
</summary>
|
||
<param name="keySize">Size of the key.</param>
|
||
<param name="hash">The hash algorithm to use for a given key.</param>
|
||
<param name="isEncryptThenMAC"><see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IAuthenticationMethod">
|
||
<summary>
|
||
Base interface for authentication of a session using a given method.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IAuthenticationMethod.Authenticate(Renci.SshNet.ISession)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>
|
||
The result of the authentication process.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IAuthenticationMethod.AllowedAuthentications">
|
||
<summary>
|
||
Gets the list of allowed authentications.
|
||
</summary>
|
||
<value>
|
||
The list of allowed authentications.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IAuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
<value>
|
||
The name of the authentication method.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IBaseClient">
|
||
<summary>
|
||
Serves as base class for client implementations, provides common client functionality.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IBaseClient.ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>
|
||
The connection info.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IBaseClient.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether this client is connected to the server.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this client is connected; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IBaseClient.KeepAliveInterval">
|
||
<summary>
|
||
Gets or sets the keep-alive interval.
|
||
</summary>
|
||
<value>
|
||
The keep-alive interval. Specify negative one (-1) milliseconds to disable the
|
||
keep-alive. This is the default value.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="E:Renci.SshNet.IBaseClient.ErrorOccurred">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.IBaseClient.HostKeyReceived">
|
||
<summary>
|
||
Occurs when host key received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.IBaseClient.ServerIdentificationReceived">
|
||
<summary>
|
||
Occurs when server identification received.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IBaseClient.Connect">
|
||
<summary>
|
||
Connects client to the server.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IBaseClient.ConnectAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects client to the server.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous connect operation.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IBaseClient.Disconnect">
|
||
<summary>
|
||
Disconnects client from the server.
|
||
</summary>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IBaseClient.SendKeepAlive">
|
||
<summary>
|
||
Sends a keep-alive message to the server.
|
||
</summary>
|
||
<remarks>
|
||
Use <see cref="P:Renci.SshNet.IBaseClient.KeepAliveInterval"/> to configure the client to send a keep-alive at regular
|
||
intervals.
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IClientAuthentication">
|
||
<summary>
|
||
Represents a mechanism to authenticate a given client.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IClientAuthentication.Authenticate(Renci.SshNet.IConnectionInfoInternal,Renci.SshNet.ISession)">
|
||
<summary>
|
||
Attempts to perform authentication for a given <see cref="T:Renci.SshNet.ISession"/> using the
|
||
<see cref="P:Renci.SshNet.IConnectionInfoInternal.AuthenticationMethods"/> of the specified
|
||
<see cref="T:Renci.SshNet.IConnectionInfoInternal"/>.
|
||
</summary>
|
||
<param name="connectionInfo">A <see cref="T:Renci.SshNet.IConnectionInfoInternal"/> to use for authenticating.</param>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> for which to perform authentication.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> or <paramref name="session"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Failed to Authenticate the client.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IConnectionInfo">
|
||
<summary>
|
||
Represents remote connection information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.LoggerFactory">
|
||
<summary>
|
||
Gets the logger factory for this connection.
|
||
</summary>
|
||
<value>
|
||
The logger factory for this connection. If <see langword="null"/> then <see cref="P:Renci.SshNet.SshNetLoggingConfiguration.LoggerFactory"/> is used.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ChannelCloseTimeout">
|
||
<summary>
|
||
Gets the timeout to used when waiting for a server to acknowledge closing a channel.
|
||
</summary>
|
||
<value>
|
||
The channel close timeout. The default value is 1 second.
|
||
</value>
|
||
<remarks>
|
||
If a server does not send a <c>SSH2_MSG_CHANNEL_CLOSE</c> message before the specified timeout
|
||
elapses, the channel will be closed immediately.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ChannelRequests">
|
||
<summary>
|
||
Gets the supported channel requests for this connection.
|
||
</summary>
|
||
<value>
|
||
The supported channel requests for this connection.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.Encoding">
|
||
<summary>
|
||
Gets the character encoding.
|
||
</summary>
|
||
<value>
|
||
The character encoding.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.Host">
|
||
<summary>
|
||
Gets connection host.
|
||
</summary>
|
||
<value>
|
||
The connection host.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.Port">
|
||
<summary>
|
||
Gets connection port.
|
||
</summary>
|
||
<value>
|
||
The connection port. The default value is 22.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ProxyType">
|
||
<summary>
|
||
Gets proxy type.
|
||
</summary>
|
||
<value>
|
||
The type of the proxy.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ProxyHost">
|
||
<summary>
|
||
Gets proxy connection host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ProxyPort">
|
||
<summary>
|
||
Gets proxy connection port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ProxyUsername">
|
||
<summary>
|
||
Gets proxy connection username.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.ProxyPassword">
|
||
<summary>
|
||
Gets proxy connection password.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.RetryAttempts">
|
||
<summary>
|
||
Gets the number of retry attempts when session channel creation failed.
|
||
</summary>
|
||
<value>
|
||
The number of retry attempts when session channel creation failed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfo.Timeout">
|
||
<summary>
|
||
Gets the connection timeout.
|
||
</summary>
|
||
<value>
|
||
The connection timeout. The default value is 30 seconds.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.IConnectionInfo.AuthenticationBanner">
|
||
<summary>
|
||
Occurs when authentication banner is sent by the server.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IConnectionInfoInternal">
|
||
<summary>
|
||
Represents remote connection information.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IConnectionInfoInternal.UserAuthenticationBannerReceived(System.Object,Renci.SshNet.MessageEventArgs{Renci.SshNet.Messages.Authentication.BannerMessage})">
|
||
<summary>
|
||
Signals that an authentication banner message was received from the server.
|
||
</summary>
|
||
<param name="sender">The session in which the banner message was received.</param>
|
||
<param name="e">The banner message.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IConnectionInfoInternal.AuthenticationMethods">
|
||
<summary>
|
||
Gets the supported authentication methods for this connection.
|
||
</summary>
|
||
<value>
|
||
The supported authentication methods for this connection.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IConnectionInfoInternal.CreateNoneAuthenticationMethod">
|
||
<summary>
|
||
Creates a <see cref="T:Renci.SshNet.NoneAuthenticationMethod"/> for the credentials represented
|
||
by the current <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.NoneAuthenticationMethod"/> for the credentials represented by the
|
||
current <see cref="T:Renci.SshNet.IConnectionInfo"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IForwardedPort">
|
||
<summary>
|
||
Supports port forwarding functionality.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.IForwardedPort.Closing">
|
||
<summary>
|
||
The <see cref="E:Renci.SshNet.IForwardedPort.Closing"/> event occurs as the forwarded port is being stopped.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IOrderedDictionary`2">
|
||
<summary>
|
||
Represents a collection of key/value pairs that are accessible by the key or index.
|
||
</summary>
|
||
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
|
||
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IOrderedDictionary`2.Item(`0)">
|
||
<summary>Gets or sets the value associated with the specified key.</summary>
|
||
<param name="key">The key of the value to get or set.</param>
|
||
<returns>The value associated with the specified key. If the specified key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException"/>, and a set operation creates a new element with the specified key.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The property is retrieved and <paramref name="key"/> does not exist in the collection.</exception>
|
||
<remarks>Setting the value of an existing key does not impact its order in the collection.</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IOrderedDictionary`2.Keys">
|
||
<summary>Gets a collection containing the keys in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IOrderedDictionary`2.Values">
|
||
<summary>Gets a collection containing the values in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IOrderedDictionary`2.Count">
|
||
<summary>Gets the number of key/value pairs contained in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.ContainsKey(`0)">
|
||
<summary>Determines whether the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains the specified key.</summary>
|
||
<param name="key">The key to locate in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</param>
|
||
<returns><see langword="true"/> if the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.ContainsValue(`1)">
|
||
<summary>Determines whether the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains a specific value.</summary>
|
||
<param name="value">The value to locate in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>. The value can be null for reference types.</param>
|
||
<returns><see langword="true"/> if the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains an element with the specified value; otherwise, <see langword="false"/>.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.GetAt(System.Int32)">
|
||
<summary>Gets the key/value pair at the specified index.</summary>
|
||
<param name="index">The zero-based index of the pair to get.</param>
|
||
<returns>The element at the specified index.</returns>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.IndexOf(`0)">
|
||
<summary>Determines the index of a specific key in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</summary>
|
||
<param name="key">The key to locate.</param>
|
||
<returns>The index of <paramref name="key"/> if found; otherwise, -1.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.Insert(System.Int32,`0,`1)">
|
||
<summary>Inserts an item into the collection at the specified index.</summary>
|
||
<param name="index">The zero-based index at which item should be inserted.</param>
|
||
<param name="key">The key to insert.</param>
|
||
<param name="value">The value to insert.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or greater than <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.Remove(`0,`1@)">
|
||
<summary>Removes the value with the specified key from the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> and copies the element to the value parameter.</summary>
|
||
<param name="key">The key of the element to remove.</param>
|
||
<param name="value">The removed element.</param>
|
||
<returns><see langword="true"/> if the element is successfully found and removed; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.RemoveAt(System.Int32)">
|
||
<summary>Removes the key/value pair at the specified index.</summary>
|
||
<param name="index">The zero-based index of the item to remove.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.SetAt(System.Int32,`0,`1)">
|
||
<summary>Sets the key/value pair at the specified index.</summary>
|
||
<param name="index">The zero-based index at which to set the key/value pair.</param>
|
||
<param name="key">The key to store at the specified index.</param>
|
||
<param name="value">The value to store at the specified index.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">An element with the same key already exists at an index different to <paramref name="index"/>.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.SetAt(System.Int32,`1)">
|
||
<summary>Sets the value for the key at the specified index.</summary>
|
||
<param name="index">The zero-based index at which to set the key/value pair.</param>
|
||
<param name="value">The value to store at the specified index.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.SetPosition(System.Int32,System.Int32)">
|
||
<summary>
|
||
Moves an existing key/value pair to the specified index in the collection.
|
||
</summary>
|
||
<param name="index">The current zero-based index of the key/value pair to move.</param>
|
||
<param name="newIndex">The zero-based index at which to set the key/value pair.</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||
<paramref name="index"/> or <paramref name="newIndex"/> are less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.SetPosition(`0,System.Int32)">
|
||
<summary>
|
||
Moves an existing key/value pair to the specified index in the collection.
|
||
</summary>
|
||
<param name="key">The key to move.</param>
|
||
<param name="newIndex">The zero-based index at which to set the key/value pair.</param>
|
||
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The specified key does not exist in the collection.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="newIndex"/> is less than 0 or greater than or equal to <see cref="P:Renci.SshNet.IOrderedDictionary`2.Count"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.TryAdd(`0,`1)">
|
||
<summary>Adds the specified key and value to the dictionary if the key doesn't already exist.</summary>
|
||
<param name="key">The key of the element to add.</param>
|
||
<param name="value">The value of the element to add. The value can be <see langword="null"/> for reference types.</param>
|
||
<returns><see langword="true"/> if the key didn't exist and the key and value were added to the dictionary; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.TryAdd(`0,`1,System.Int32@)">
|
||
<summary>Adds the specified key and value to the dictionary if the key doesn't already exist.</summary>
|
||
<param name="key">The key of the element to add.</param>
|
||
<param name="value">The value of the element to add. The value can be <see langword="null"/> for reference types.</param>
|
||
<param name="index">The index of the added or existing <paramref name="key"/>. This is always a valid index into the dictionary.</param>
|
||
<returns><see langword="true"/> if the key didn't exist and the key and value were added to the dictionary; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.TryGetValue(`0,`1@)">
|
||
<summary>Gets the value associated with the specified key.</summary>
|
||
<param name="key">The key of the value to get.</param>
|
||
<param name="value">
|
||
When this method returns, contains the value associated with the specified key, if the key is found;
|
||
otherwise, the default value for the type of the value parameter.
|
||
</param>
|
||
<returns><see langword="true"/> if the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IOrderedDictionary`2.TryGetValue(`0,`1@,System.Int32@)">
|
||
<summary>Gets the value associated with the specified key.</summary>
|
||
<param name="key">The key of the value to get.</param>
|
||
<param name="value">
|
||
When this method returns, contains the value associated with the specified key, if the key is found;
|
||
otherwise, the default value for the type of the value parameter.
|
||
</param>
|
||
<param name="index">The index of <paramref name="key"/> if found; otherwise, -1.</param>
|
||
<returns><see langword="true"/> if the <see cref="T:Renci.SshNet.IOrderedDictionary`2"/> contains an element with the specified key; otherwise, <see langword="false"/>.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IPrivateKeySource">
|
||
<summary>
|
||
Represents private key source interface.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.IPrivateKeySource.HostKeyAlgorithms">
|
||
<summary>
|
||
Gets the host keys algorithms.
|
||
</summary>
|
||
<remarks>
|
||
In situations where there is a preferred order of usage of the host algorithms,
|
||
the collection should be ordered from most preferred to least.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IRemotePathTransformation">
|
||
<summary>
|
||
Represents a transformation that can be applied to a remote path.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IRemotePathTransformation.Transform(System.String)">
|
||
<summary>
|
||
Transforms the specified remote path.
|
||
</summary>
|
||
<param name="path">The path to transform.</param>
|
||
<returns>
|
||
The transformed path.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.IServiceFactory">
|
||
<summary>
|
||
Factory for creating new services.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateClientAuthentication">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.IClientAuthentication"/>.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.IClientAuthentication"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateNetConfSession(Renci.SshNet.ISession,System.Int32)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.NetConf.INetConfSession"/> in a given <see cref="T:Renci.SshNet.ISession"/>
|
||
and with the specified operation timeout.
|
||
</summary>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> to create the <see cref="T:Renci.SshNet.NetConf.INetConfSession"/> in.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for an operation to complete, or <c>-1</c> to wait indefinitely.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.NetConf.INetConfSession"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateSession(Renci.SshNet.ConnectionInfo,Renci.SshNet.Connection.ISocketFactory)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.ISession"/> with the specified <see cref="T:Renci.SshNet.ConnectionInfo"/> and
|
||
<see cref="T:Renci.SshNet.Connection.ISocketFactory"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.ConnectionInfo"/> to use for creating a new session.</param>
|
||
<param name="socketFactory">A factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.ISession"/> for the specified <see cref="T:Renci.SshNet.ConnectionInfo"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="socketFactory"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateSftpSession(Renci.SshNet.ISession,System.Int32,System.Text.Encoding,Renci.SshNet.Sftp.ISftpResponseFactory)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.Sftp.ISftpSession"/> in a given <see cref="T:Renci.SshNet.ISession"/> and with
|
||
the specified operation timeout and encoding.
|
||
</summary>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> to create the <see cref="T:Renci.SshNet.Sftp.ISftpSession"/> in.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for an operation to complete, or <c>-1</c> to wait indefinitely.</param>
|
||
<param name="encoding">The encoding.</param>
|
||
<param name="sftpMessageFactory">The factory to use for creating SFTP messages.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Sftp.ISftpSession"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreatePipeStream">
|
||
<summary>
|
||
Create a new <see cref="T:Renci.SshNet.Common.PipeStream"/>.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Common.PipeStream"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateKeyExchange(System.Collections.Generic.IDictionary{System.String,System.Func{Renci.SshNet.Security.IKeyExchange}},System.String[])">
|
||
<summary>
|
||
Negotiates a key exchange algorithm, and creates a <see cref="T:Renci.SshNet.Security.IKeyExchange" /> for the negotiated
|
||
algorithm.
|
||
</summary>
|
||
<param name="clientAlgorithms">A dictionary of the key exchange algorithms supported by the client where the key is the name of the algorithm, and the value is a factory returning this algorithm.</param>
|
||
<param name="serverAlgorithms">The names of the key exchange algorithms supported by the SSH server.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Security.IKeyExchange"/> that was negotiated between client and server.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="clientAlgorithms"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serverAlgorithms"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">No key exchange algorithm is supported by both client and server.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateSftpResponseFactory">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.Sftp.ISftpResponseFactory"/> instance.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Sftp.ISftpResponseFactory"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateShellStream(Renci.SshNet.ISession,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<summary>
|
||
Creates a shell stream.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="terminalName">The <c>TERM</c> environment variable.</param>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal height in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<param name="bufferSize">Size of the buffer.</param>
|
||
<returns>
|
||
The created <see cref="T:Renci.SshNet.ShellStream"/> instance.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<remarks>
|
||
<para>
|
||
The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
|
||
You can get a detailed list of these capabilities by using the ‘infocmp’ command.
|
||
</para>
|
||
<para>
|
||
The column/row dimensions override the pixel dimensions(when non-zero). Pixel dimensions refer
|
||
to the drawable area of the window.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateShellStreamNoTerminal(Renci.SshNet.ISession,System.Int32)">
|
||
<summary>
|
||
Creates a shell stream without allocating a pseudo terminal.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="bufferSize">Size of the buffer.</param>
|
||
<returns>
|
||
The created <see cref="T:Renci.SshNet.ShellStream"/> instance.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateRemotePathDoubleQuoteTransformation">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that encloses a path in double quotes, and escapes
|
||
any embedded double quote with a backslash.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that encloses a path in double quotes, and escapes any
|
||
embedded double quote with a backslash.
|
||
with a shell.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateConnector(Renci.SshNet.IConnectionInfo,Renci.SshNet.Connection.ISocketFactory)">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.Connection.IConnector"/> that can be used to establish a connection
|
||
to the server identified by the specified <paramref name="connectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">A <see cref="T:Renci.SshNet.IConnectionInfo"/> detailing the server to establish a connection to.</param>
|
||
<param name="socketFactory">A factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.IConnector"/> that can be used to establish a connection to the
|
||
server identified by the specified <paramref name="connectionInfo"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="socketFactory"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.NotSupportedException">The <see cref="P:Renci.SshNet.IConnectionInfo.ProxyType"/> value of <paramref name="connectionInfo"/> is not supported.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateProtocolVersionExchange">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.Connection.IProtocolVersionExchange"/> that deals with the SSH protocol
|
||
version exchange.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.IProtocolVersionExchange"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.IServiceFactory.CreateSocketFactory">
|
||
<summary>
|
||
Creates a factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.ISocketFactory"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ISession">
|
||
<summary>
|
||
Provides functionality to connect and interact with SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISession.ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>The connection info.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISession.SessionLoggerFactory">
|
||
<summary>
|
||
Gets the logger factory for this session.
|
||
</summary>
|
||
<value>
|
||
The logger factory for this session. Will never return <see langword="null"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISession.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether the session is connected.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the session is connected; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISession.SessionSemaphore">
|
||
<summary>
|
||
Gets the session semaphore that controls session channels.
|
||
</summary>
|
||
<value>
|
||
The session semaphore.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISession.MessageListenerCompleted">
|
||
<summary>
|
||
Gets a <see cref="T:System.Threading.WaitHandle"/> that can be used to wait for the message listener loop to complete.
|
||
</summary>
|
||
<value>
|
||
A <see cref="T:System.Threading.WaitHandle"/> that can be used to wait for the message listener loop to complete, or
|
||
<see langword="null"/> when the session has not been connected.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.Connect">
|
||
<summary>
|
||
Connects to the server.
|
||
</summary>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.ConnectAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects to the server.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous connect operation.</returns>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.CreateChannelSession">
|
||
<summary>
|
||
Create a new SSH session channel.
|
||
</summary>
|
||
<returns>
|
||
A new SSH session channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.CreateChannelDirectTcpip">
|
||
<summary>
|
||
Create a new channel for a locally forwarded TCP/IP port.
|
||
</summary>
|
||
<returns>
|
||
A new channel for a locally forwarded TCP/IP port.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.CreateChannelForwardedTcpip(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Creates a "forwarded-tcpip" SSH channel.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The number of the remote channel.</param>
|
||
<param name="remoteWindowSize">The window size of the remote channel.</param>
|
||
<param name="remoteChannelDataPacketSize">The data packet size of the remote channel.</param>
|
||
<returns>
|
||
A new "forwarded-tcpip" SSH channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.Disconnect">
|
||
<summary>
|
||
Disconnects from the server.
|
||
</summary>
|
||
<remarks>
|
||
This sends a <b>SSH_MSG_DISCONNECT</b> message to the server, waits for the
|
||
server to close the socket on its end and subsequently closes the client socket.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.RegisterMessage(System.String)">
|
||
<summary>
|
||
Registers SSH message with the session.
|
||
</summary>
|
||
<param name="messageName">The name of the message to register with the session.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.SendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The operation timed out.</exception>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.TrySendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<returns>
|
||
<see langword="true"/> if the message was sent to the server; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
<remarks>
|
||
This methods returns <see langword="false"/> when the attempt to send the message results in a
|
||
<see cref="T:System.Net.Sockets.SocketException"/> or a <see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.UnRegisterMessage(System.String)">
|
||
<summary>
|
||
Unregister SSH message from the session.
|
||
</summary>
|
||
<param name="messageName">The name of the message to unregister with the session.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.WaitOnHandle(System.Threading.WaitHandle)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the connection timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
<remarks>
|
||
When neither handles are signaled in time and the session is not closing, then the
|
||
session is disconnected.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.WaitOnHandle(System.Threading.WaitHandle,System.TimeSpan)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the specified timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<param name="timeout">The time to wait for any of the handles to become signaled.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
<remarks>
|
||
When neither handles are signaled in time and the session is not closing, then the
|
||
session is disconnected.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.TryWait(System.Threading.WaitHandle,System.TimeSpan,System.Exception@)">
|
||
<summary>
|
||
Waits for the specified <seec ref="WaitHandle"/> to receive a signal, using a <see cref="T:System.TimeSpan"/>
|
||
to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandle">The <see cref="T:System.Threading.WaitHandle"/> that should be signaled.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan"/> that represents <c>-1</c> milliseconds to wait indefinitely.</param>
|
||
<param name="exception">When this method returns <see cref="F:Renci.SshNet.WaitResult.Failed"/>, contains the <see cref="T:System.Exception"/>.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.WaitResult"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISession.TryWait(System.Threading.WaitHandle,System.TimeSpan)">
|
||
<summary>
|
||
Waits for the specified <seec ref="WaitHandle"/> to receive a signal, using a <see cref="T:System.TimeSpan"/>
|
||
to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandle">The <see cref="T:System.Threading.WaitHandle"/> that should be signaled.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan"/> that represents <c>-1</c> milliseconds to wait indefinitely.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.WaitResult"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelCloseReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelEofReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelEofMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelExtendedDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelOpenConfirmationReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelOpenFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelOpenReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelRequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelSuccessReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ChannelWindowAdjustReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.Disconnected">
|
||
<summary>
|
||
Occurs when session has been disconnected from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ErrorOccured">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.ServerIdentificationReceived">
|
||
<summary>
|
||
Occurs when server identification received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.HostKeyReceived">
|
||
<summary>
|
||
Occurs when host key received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.RequestSuccessReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.RequestFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.RequestFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ISession.UserAuthenticationBannerReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.BannerMessage"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ISftpClient">
|
||
<summary>
|
||
Implementation of the SSH File Transfer Protocol (SFTP) over SSH.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISftpClient.BufferSize">
|
||
<summary>
|
||
Gets or sets the maximum size of the buffer in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the buffer. The default buffer size is 32768 bytes (32 KB).
|
||
</value>
|
||
<remarks>
|
||
<para>
|
||
For write operations, this limits the size of the payload for
|
||
individual SSH_FXP_WRITE messages. The actual size is always
|
||
capped at the maximum packet size supported by the peer
|
||
(minus the size of protocol fields).
|
||
</para>
|
||
<para>
|
||
For read operations, this controls the size of the payload which
|
||
is requested from the peer in a SSH_FXP_READ message. The peer
|
||
will send the requested number of bytes in a SSH_FXP_DATA message,
|
||
possibly split over multiple SSH_MSG_CHANNEL_DATA messages.
|
||
</para>
|
||
<para>
|
||
To optimize the size of the SSH packets sent by the peer,
|
||
the actual requested size will take into account the size of the
|
||
SSH_FXP_DATA protocol fields.
|
||
</para>
|
||
<para>
|
||
The size of the each individual SSH_FXP_DATA message is limited to the
|
||
local maximum packet size of the channel, which is set to <c>64 KB</c>
|
||
for SSH.NET. However, the peer can limit this even further.
|
||
</para>
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISftpClient.OperationTimeout">
|
||
<summary>
|
||
Gets or sets the operation timeout.
|
||
</summary>
|
||
<value>
|
||
The timeout to wait until an operation completes. The default value is negative
|
||
one (-1) milliseconds, which indicates an infinite timeout period.
|
||
</value>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> represents a value that is less than -1 or greater than <see cref="F:System.Int32.MaxValue"/> milliseconds.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISftpClient.ProtocolVersion">
|
||
<summary>
|
||
Gets sftp protocol version.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISftpClient.WorkingDirectory">
|
||
<summary>
|
||
Gets remote working directory.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendAllLines(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Appends lines to a file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
||
<param name="contents">The lines to append to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendAllLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding)">
|
||
<summary>
|
||
Appends lines to a file by using a specified encoding, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
||
<param name="contents">The lines to append to the file.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendAllText(System.String,System.String)">
|
||
<summary>
|
||
Appends the specified string to the file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the specified string to.</param>
|
||
<param name="contents">The string to append to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendAllText(System.String,System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Appends the specified string to the file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the specified string to.</param>
|
||
<param name="contents">The string to append to the file.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendText(System.String)">
|
||
<summary>
|
||
Creates a <see cref="T:System.IO.StreamWriter"/> that appends UTF-8 encoded text to the specified file,
|
||
creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The path to the file to append to.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that appends text to a file using UTF-8 encoding without a
|
||
Byte-Order Mark (BOM).
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.AppendText(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Creates a <see cref="T:System.IO.StreamWriter"/> that appends text to a file using the specified
|
||
encoding, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The path to the file to append to.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that appends text to a file using the specified encoding.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginDownloadFile(System.String,System.IO.Stream)">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginDownloadFile(System.String,System.IO.Stream,System.AsyncCallback)">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginDownloadFile(System.String,System.IO.Stream,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="downloadCallback">The download callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginListDirectory(System.String,System.AsyncCallback,System.Object,System.Action{System.Int32})">
|
||
<summary>
|
||
Begins an asynchronous operation of retrieving list of files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="listCallback">The list callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginSynchronizeDirectories(System.String,System.String,System.String,System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Begins the synchronize directories.
|
||
</summary>
|
||
<param name="sourcePath">The source path.</param>
|
||
<param name="destinationPath">The destination path.</param>
|
||
<param name="searchPattern">The search pattern.</param>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous directory synchronization.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="sourcePath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">If a problem occurs while copying the file.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginUploadFile(System.IO.Stream,System.String)">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginUploadFile(System.IO.Stream,System.String,System.AsyncCallback)">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginUploadFile(System.IO.Stream,System.String,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.BeginUploadFile(System.IO.Stream,System.String,System.Boolean,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="canOverride">Specified whether an existing file can be overwritten.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
When <paramref name="path"/> refers to an existing file, set <paramref name="canOverride"/> to <see langword="true"/> to overwrite and truncate that file.
|
||
If <paramref name="canOverride"/> is <see langword="false"/>, the upload will fail and <see cref="M:Renci.SshNet.SftpClient.EndUploadFile(System.IAsyncResult)"/> will throw an
|
||
<see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ChangeDirectory(System.String)">
|
||
<summary>
|
||
Changes remote directory to path.
|
||
</summary>
|
||
<param name="path">New directory path.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ChangeDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously requests to change the current working directory to the specified path.
|
||
</summary>
|
||
<param name="path">The new working directory.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that tracks the asynchronous change working directory request.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ChangePermissions(System.String,System.Int16)">
|
||
<summary>
|
||
Changes permissions of file(s) to specified mode.
|
||
</summary>
|
||
<param name="path">File(s) path, may match multiple files.</param>
|
||
<param name="mode">The mode.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change permission on the path(s) was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Create(System.String)">
|
||
<summary>
|
||
Creates or overwrites a file in the specified path.
|
||
</summary>
|
||
<param name="path">The path and name of the file to create.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides read/write access to the file specified in path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the target file already exists, it is first truncated to zero bytes.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Create(System.String,System.Int32)">
|
||
<summary>
|
||
Creates or overwrites the specified file.
|
||
</summary>
|
||
<param name="path">The path and name of the file to create.</param>
|
||
<param name="bufferSize">The maximum number of bytes buffered for reads and writes to the file.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides read/write access to the file specified in path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the target file already exists, it is first truncated to zero bytes.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.CreateDirectory(System.String)">
|
||
<summary>
|
||
Creates remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory path to create.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.CreateDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously requests to create a remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory path to create.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous create directory operation.</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.CreateText(System.String)">
|
||
<summary>
|
||
Creates or opens a file for writing UTF-8 encoded text.
|
||
</summary>
|
||
<param name="path">The file to be opened for writing.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that writes text to a file using UTF-8 encoding without
|
||
a Byte-Order Mark (BOM).
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.CreateText(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Creates or opens a file for writing text using the specified encoding.
|
||
</summary>
|
||
<param name="path">The file to be opened for writing.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that writes to a file using the specified encoding.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Delete(System.String)">
|
||
<summary>
|
||
Deletes the specified file or directory.
|
||
</summary>
|
||
<param name="path">The name of the file or directory to be deleted. Wildcard characters are not supported.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DeleteAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Permanently deletes a file on remote machine.
|
||
</summary>
|
||
<param name="path">The name of the file or directory to be deleted. Wildcard characters are not supported.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous delete operation.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DeleteDirectory(System.String)">
|
||
<summary>
|
||
Deletes remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory to be deleted path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DeleteDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously deletes a remote directory.
|
||
</summary>
|
||
<param name="path">The path of the directory to be deleted.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous delete operation.</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DeleteFile(System.String)">
|
||
<summary>
|
||
Deletes remote file specified by path.
|
||
</summary>
|
||
<param name="path">File to be deleted path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DeleteFileAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously deletes remote file specified by path.
|
||
</summary>
|
||
<param name="path">File to be deleted path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous delete operation.</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DownloadFile(System.String,System.IO.Stream,System.Action{System.UInt64})">
|
||
<summary>
|
||
Downloads a remote file into a <see cref="T:System.IO.Stream"/>.
|
||
</summary>
|
||
<param name="path">The path to the remote file.</param>
|
||
<param name="output">The <see cref="T:System.IO.Stream"/> to write the file into.</param>
|
||
<param name="downloadCallback">The download callback.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output"/> or <paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is empty or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> An SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">An SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.DownloadFileAsync(System.String,System.IO.Stream,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously downloads a remote file into a <see cref="T:System.IO.Stream"/>.
|
||
</summary>
|
||
<param name="path">The path to the remote file.</param>
|
||
<param name="output">The <see cref="T:System.IO.Stream"/> to write the file into.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous download operation.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output"/> or <paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is empty or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> An SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">An SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.EndDownloadFile(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndDownloadFile(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The path was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.EndListDirectory(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous operation of retrieving list of files in remote directory.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<returns>
|
||
A list of files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndListDirectory(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.EndSynchronizeDirectories(System.IAsyncResult)">
|
||
<summary>
|
||
Ends the synchronize directories.
|
||
</summary>
|
||
<param name="asyncResult">The async result.</param>
|
||
<returns>
|
||
A list of uploaded files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndSynchronizeDirectories(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The destination path was not found on the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.EndUploadFile(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndUploadFile(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The directory of the file was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Exists(System.String)">
|
||
<summary>
|
||
Checks whether file or directory exists.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
<see langword="true"/> if directory or file exists; otherwise <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ExistsAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Checks whether file or directory exists.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the exists operation.
|
||
The task result contains <see langword="true"/> if directory or file exists; otherwise <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Get(System.String)">
|
||
<summary>
|
||
Gets reference to remote file or directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A reference to <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> file object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets reference to remote file or directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the get operation.
|
||
The task result contains the reference to <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> file object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetAttributes(System.String)">
|
||
<summary>
|
||
Gets the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<returns>
|
||
The <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetAttributesAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the attribute retrieval operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetLastAccessTime(System.String)">
|
||
<summary>
|
||
Returns the date and time the specified file or directory was last accessed.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain access date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
||
This value is expressed in local time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetLastAccessTimeUtc(System.String)">
|
||
<summary>
|
||
Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last accessed.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain access date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
||
This value is expressed in UTC time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetLastWriteTime(System.String)">
|
||
<summary>
|
||
Returns the date and time the specified file or directory was last written to.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain write date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
||
This value is expressed in local time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetLastWriteTimeUtc(System.String)">
|
||
<summary>
|
||
Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last written to.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain write date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
||
This value is expressed in UTC time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetStatus(System.String)">
|
||
<summary>
|
||
Gets status using statvfs@openssh.com request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation"/> instance that contains file status information.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.GetStatusAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously gets status using statvfs@openssh.com request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the status operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation"/> instance that contains file status information.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ListDirectory(System.String,System.Action{System.Int32})">
|
||
<summary>
|
||
Retrieves list of files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="listCallback">The list callback.</param>
|
||
<returns>
|
||
A list of files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ListDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously enumerates the files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> of <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> that represents the asynchronous enumeration operation.
|
||
The enumeration contains an async stream of <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> for the files in the directory specified by <paramref name="path" />.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Open(System.String,System.IO.FileMode)">
|
||
<summary>
|
||
Opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path with read/write access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and read/write access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.Open(System.String,System.IO.FileMode,System.IO.FileAccess)">
|
||
<summary>
|
||
Opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path, with the specified mode and access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<param name="access">A <see cref="T:System.IO.FileAccess"/> value that specifies the operations that can be performed on the file.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.OpenAsync(System.String,System.IO.FileMode,System.IO.FileAccess,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path, with the specified mode and access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<param name="access">A <see cref="T:System.IO.FileAccess"/> value that specifies the operations that can be performed on the file.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous open operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.OpenRead(System.String)">
|
||
<summary>
|
||
Opens an existing file for reading.
|
||
</summary>
|
||
<param name="path">The file to be opened for reading.</param>
|
||
<returns>
|
||
A read-only <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.OpenText(System.String)">
|
||
<summary>
|
||
Opens an existing UTF-8 encoded text file for reading.
|
||
</summary>
|
||
<param name="path">The file to be opened for reading.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamReader"/> on the specified path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.OpenWrite(System.String)">
|
||
<summary>
|
||
Opens a file for writing.
|
||
</summary>
|
||
<param name="path">The file to be opened for writing.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> object on the specified path with <see cref="F:System.IO.FileAccess.Write"/> access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file does not exist, it is created.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadAllBytes(System.String)">
|
||
<summary>
|
||
Opens a binary file, reads the contents of the file into a byte array, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A byte array containing the contents of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadAllLines(System.String)">
|
||
<summary>
|
||
Opens a text file, reads all lines of the file using UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A string array containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadAllLines(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Opens a file, reads all lines of the file with the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<param name="encoding">The encoding applied to the contents of the file.</param>
|
||
<returns>
|
||
A string array containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadAllText(System.String)">
|
||
<summary>
|
||
Opens a text file, reads all lines of the file with the UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A string containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadAllText(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Opens a file, reads all lines of the file with the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<param name="encoding">The encoding applied to the contents of the file.</param>
|
||
<returns>
|
||
A string containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadLines(System.String)">
|
||
<summary>
|
||
Reads the lines of a file with the UTF-8 encoding.
|
||
</summary>
|
||
<param name="path">The file to read.</param>
|
||
<returns>
|
||
The lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.ReadLines(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Read the lines of a file that has a specified encoding.
|
||
</summary>
|
||
<param name="path">The file to read.</param>
|
||
<param name="encoding">The encoding that is applied to the contents of the file.</param>
|
||
<returns>
|
||
The lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.RenameFile(System.String,System.String)">
|
||
<summary>
|
||
Renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.RenameFile(System.String,System.String,System.Boolean)">
|
||
<summary>
|
||
Renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<param name="isPosix">if set to <see langword="true"/> then perform a posix rename.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath" /> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.RenameFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous rename operation.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SetLastAccessTime(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time the specified file was last accessed.
|
||
</summary>
|
||
<param name="path">The file for which to set the access date and time information.</param>
|
||
<param name="lastAccessTime">A <see cref="T:System.DateTime"/> containing the value to set for the last access date and time of path. This value is expressed in local time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SetLastAccessTimeUtc(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time, in coordinated universal time (UTC), that the specified file was last accessed.
|
||
</summary>
|
||
<param name="path">The file for which to set the access date and time information.</param>
|
||
<param name="lastAccessTimeUtc">A <see cref="T:System.DateTime"/> containing the value to set for the last access date and time of path. This value is expressed in UTC time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SetLastWriteTime(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time that the specified file was last written to.
|
||
</summary>
|
||
<param name="path">The file for which to set the date and time information.</param>
|
||
<param name="lastWriteTime">A <see cref="T:System.DateTime"/> containing the value to set for the last write date and time of path. This value is expressed in local time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SetLastWriteTimeUtc(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time, in coordinated universal time (UTC), that the specified file was last written to.
|
||
</summary>
|
||
<param name="path">The file for which to set the date and time information.</param>
|
||
<param name="lastWriteTimeUtc">A <see cref="T:System.DateTime"/> containing the value to set for the last write date and time of path. This value is expressed in UTC time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SetAttributes(System.String,Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<summary>
|
||
Sets the specified <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the specified path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<param name="fileAttributes">The desired <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/>.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SymbolicLink(System.String,System.String)">
|
||
<summary>
|
||
Creates a symbolic link from old path to new path.
|
||
</summary>
|
||
<param name="path">The old path.</param>
|
||
<param name="linkPath">The new path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="linkPath"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the symbolic link was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.SynchronizeDirectories(System.String,System.String,System.String)">
|
||
<summary>
|
||
Synchronizes the directories.
|
||
</summary>
|
||
<param name="sourcePath">The source path.</param>
|
||
<param name="destinationPath">The destination path.</param>
|
||
<param name="searchPattern">The search pattern.</param>
|
||
<returns>
|
||
A list of uploaded files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="sourcePath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="destinationPath"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">If a problem occurs while copying the file.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.UploadFile(System.IO.Stream,System.String,System.Action{System.UInt64})">
|
||
<summary>
|
||
Uploads a <see cref="T:System.IO.Stream"/> to a remote file path.
|
||
</summary>
|
||
<param name="input">The <see cref="T:System.IO.Stream"/> to write to the remote path.</param>
|
||
<param name="path">The remote file path to write to.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> or <paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is empty or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> An SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">An SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.UploadFile(System.IO.Stream,System.String,System.Boolean,System.Action{System.UInt64})">
|
||
<summary>
|
||
Uploads a <see cref="T:System.IO.Stream"/> to a remote file path.
|
||
</summary>
|
||
<param name="input">The <see cref="T:System.IO.Stream"/> to write to the remote path.</param>
|
||
<param name="path">The remote file path to write to.</param>
|
||
<param name="canOverride">Whether the remote file can be overwritten if it already exists.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> or <paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is empty or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> An SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">An SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.UploadFileAsync(System.IO.Stream,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously uploads a <see cref="T:System.IO.Stream"/> to a remote file path.
|
||
</summary>
|
||
<param name="input">The <see cref="T:System.IO.Stream"/> to write to the remote path.</param>
|
||
<param name="path">The remote file path to write to.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous upload operation.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input"/> or <paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is empty or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> An SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">An SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllBytes(System.String,System.Byte[])">
|
||
<summary>
|
||
Writes the specified byte array to the specified file, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="bytes">The bytes to write to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Writes a collection of strings to the file using the UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The lines to write to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</para>
|
||
<para>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding)">
|
||
<summary>
|
||
Writes a collection of strings to the file using the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The lines to write to the file.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllLines(System.String,System.String[])">
|
||
<summary>
|
||
Write the specified string array to the file using the UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The string array to write to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</para>
|
||
<para>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllLines(System.String,System.String[],System.Text.Encoding)">
|
||
<summary>
|
||
Writes the specified string array to the file by using the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The string array to write to the file.</param>
|
||
<param name="encoding">An <see cref="T:System.Text.Encoding"/> object that represents the character encoding applied to the string array.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllText(System.String,System.String)">
|
||
<summary>
|
||
Writes the specified string to the file using the UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The string to write to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</para>
|
||
<para>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISftpClient.WriteAllText(System.String,System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Writes the specified string to the file using the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to write to.</param>
|
||
<param name="contents">The string to write to the file.</param>
|
||
<param name="encoding">The encoding to apply to the string.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file specified by <paramref name="path"/> does not exist, it is created.
|
||
If the file does exist, its contents are replaced.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ISshClient">
|
||
<summary>
|
||
Provides client connection to SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISshClient.ForwardedPorts">
|
||
<summary>
|
||
Gets the list of forwarded ports.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.AddForwardedPort(Renci.SshNet.ForwardedPort)">
|
||
<summary>
|
||
Adds the forwarded port.
|
||
</summary>
|
||
<param name="port">The port.</param>
|
||
<exception cref="T:System.InvalidOperationException">Forwarded port is already added to a different client.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="port"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.RemoveForwardedPort(Renci.SshNet.ForwardedPort)">
|
||
<summary>
|
||
Stops and removes the forwarded port from the list.
|
||
</summary>
|
||
<param name="port">Forwarded port.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="port"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateCommand(System.String)">
|
||
<summary>
|
||
Creates the command to be executed.
|
||
</summary>
|
||
<param name="commandText">The command text.</param>
|
||
<returns><see cref="T:Renci.SshNet.SshCommand"/> object.</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateCommand(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Creates the command to be executed with specified encoding.
|
||
</summary>
|
||
<param name="commandText">The command text.</param>
|
||
<param name="encoding">The encoding to use for results.</param>
|
||
<returns><see cref="T:Renci.SshNet.SshCommand"/> object which uses specified encoding.</returns>
|
||
<remarks>This method will change current default encoding.</remarks>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="commandText"/> or <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.RunCommand(System.String)">
|
||
<summary>
|
||
Creates and executes the command.
|
||
</summary>
|
||
<param name="commandText">The command text.</param>
|
||
<returns>Returns an instance of <see cref="T:Renci.SshNet.SshCommand"/> with execution results.</returns>
|
||
<remarks>This method internally uses asynchronous calls.</remarks>
|
||
<exception cref="T:System.ArgumentException">CommandText property is empty.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Invalid Operation - An existing channel was used to execute this command.</exception>
|
||
<exception cref="T:System.InvalidOperationException">Asynchronous operation is already in progress.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="commandText"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="terminalName">Name of the terminal.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModes">The terminal mode.</param>
|
||
<param name="bufferSize">Size of the internal read buffer.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="terminalName">Name of the terminal.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModes">The terminal mode.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream)">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="encoding">The encoding to use to send the input.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="terminalName">Name of the terminal.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModes">The terminal mode.</param>
|
||
<param name="bufferSize">Size of the internal read buffer.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="encoding">The encoding.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="terminalName">Name of the terminal.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModes">The terminal modes.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream)">
|
||
<summary>
|
||
Creates the shell.
|
||
</summary>
|
||
<param name="encoding">The encoding.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShellNoTerminal(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Int32)">
|
||
<summary>
|
||
Creates the shell without allocating a pseudo terminal,
|
||
similar to the <c>ssh -T</c> option.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="bufferSize">Size of the internal read buffer.</param>
|
||
<returns>
|
||
Returns a representation of a <see cref="T:Renci.SshNet.Shell" /> object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShellStream(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Int32)">
|
||
<summary>
|
||
Creates the shell stream.
|
||
</summary>
|
||
<param name="terminalName">The <c>TERM</c> environment variable.</param>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal height in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<returns>
|
||
The created <see cref="T:Renci.SshNet.ShellStream"/> instance.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<remarks>
|
||
<para>
|
||
The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
|
||
You can get a detailed list of these capabilities by using the ‘infocmp’ command.
|
||
</para>
|
||
<para>
|
||
The column/row dimensions override the pixel dimensions (when nonzero). Pixel dimensions refer
|
||
to the drawable area of the window.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShellStream(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Int32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Creates the shell stream.
|
||
</summary>
|
||
<param name="terminalName">The <c>TERM</c> environment variable.</param>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal height in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<returns>
|
||
The created <see cref="T:Renci.SshNet.ShellStream"/> instance.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<remarks>
|
||
<para>
|
||
The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
|
||
You can get a detailed list of these capabilities by using the ‘infocmp’ command.
|
||
</para>
|
||
<para>
|
||
The column/row dimensions override the pixel dimensions (when non-zero). Pixel dimensions refer
|
||
to the drawable area of the window.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISshClient.CreateShellStreamNoTerminal(System.Int32)">
|
||
<summary>
|
||
Creates the shell stream without allocating a pseudo terminal,
|
||
similar to the <c>ssh -T</c> option.
|
||
</summary>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<returns>
|
||
The created <see cref="T:Renci.SshNet.ShellStream"/> instance.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ISubsystemSession">
|
||
<summary>
|
||
Base interface for SSH subsystem implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISubsystemSession.SessionLoggerFactory">
|
||
<summary>
|
||
Gets the logger factory for this subsystem session.
|
||
</summary>
|
||
<value>
|
||
The logger factory for this connection. Will never return <see langword="null"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISubsystemSession.OperationTimeout">
|
||
<summary>
|
||
Gets or sets the number of milliseconds to wait for an operation to complete.
|
||
</summary>
|
||
<value>
|
||
The number of milliseconds to wait for an operation to complete, or <c>-1</c> to wait indefinitely.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ISubsystemSession.IsOpen">
|
||
<summary>
|
||
Gets a value indicating whether this session is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this session is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.Connect">
|
||
<summary>
|
||
Connects the subsystem using a new SSH channel session.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The session is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the session was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.Disconnect">
|
||
<summary>
|
||
Disconnects the subsystem channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.WaitOnHandle(System.Threading.WaitHandle,System.Int32)">
|
||
<summary>
|
||
Waits a specified time for a given <see cref="T:System.Threading.WaitHandle"/> to be signaled.
|
||
</summary>
|
||
<param name="waitHandle">The handle to wait for.</param>
|
||
<param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="waitHandle"/> to be signaled, or <c>-1</c> to wait indefinitely.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The connection was closed by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel was closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.WaitOnHandleAsync(System.Threading.WaitHandle,System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously waits for a given <see cref="T:System.Threading.WaitHandle"/> to be signaled.
|
||
</summary>
|
||
<param name="waitHandle">The handle to wait for.</param>
|
||
<param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="waitHandle"/> to be signaled, or <c>-1</c> to wait indefinitely.</param>
|
||
<param name="cancellationToken">The cancellation token to observe.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The connection was closed by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel was closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the wait.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.WaitOnHandleAsync``1(System.Threading.Tasks.TaskCompletionSource{``0},System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously waits for a given <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> to complete.
|
||
</summary>
|
||
<typeparam name="T">The type of the result which is being awaited.</typeparam>
|
||
<param name="tcs">The handle to wait for.</param>
|
||
<param name="millisecondsTimeout">The number of milliseconds to wait for <paramref name="tcs"/> to complete, or <c>-1</c> to wait indefinitely.</param>
|
||
<param name="cancellationToken">The cancellation token to observe.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The connection was closed by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel was closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the wait.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.WaitAny(System.Threading.WaitHandle[],System.Int32)">
|
||
<summary>
|
||
Waits for any of the elements in the specified array to receive a signal, using a 32-bit signed
|
||
integer to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandles">A <see cref="T:System.Threading.WaitHandle"/> array - constructed using <see cref="M:Renci.SshNet.ISubsystemSession.CreateWaitHandleArray(System.Threading.WaitHandle,System.Threading.WaitHandle)"/> - containing the objects to wait for.</param>
|
||
<param name="millisecondsTimeout">To number of milliseconds to wait for a <see cref="T:System.Threading.WaitHandle"/> to get signaled, or <c>-1</c> to wait indefinitely.</param>
|
||
<returns>
|
||
The array index of the first non-system object that satisfied the wait.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The connection was closed by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel was closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">No object satisfied the wait and a time interval equivalent to <paramref name="millisecondsTimeout"/> has passed.</exception>
|
||
<remarks>
|
||
For the return value, the index of the first non-system object is considered to be zero.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ISubsystemSession.CreateWaitHandleArray(System.Threading.WaitHandle,System.Threading.WaitHandle)">
|
||
<summary>
|
||
Creates a <see cref="T:System.Threading.WaitHandle"/> array that is composed of system objects and the specified
|
||
elements.
|
||
</summary>
|
||
<param name="waitHandle1">The first <see cref="T:System.Threading.WaitHandle"/> to wait for.</param>
|
||
<param name="waitHandle2">The second <see cref="T:System.Threading.WaitHandle"/> to wait for.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.WaitHandle"/> array that is composed of system objects and the specified elements.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.KeyboardInteractiveAuthenticationMethod">
|
||
<summary>
|
||
Provides functionality to perform keyboard interactive authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.KeyboardInteractiveAuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
<value>
|
||
The name of the authentication method.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.KeyboardInteractiveAuthenticationMethod.AuthenticationPrompt">
|
||
<summary>
|
||
Occurs when server prompts for more authentication information.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveAuthenticationMethod.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveAuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveAuthenticationMethod.Authenticate(Renci.SshNet.Session)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>Result of authentication process.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveAuthenticationMethod.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.KeyboardInteractiveConnectionInfo">
|
||
<summary>
|
||
Provides connection information when keyboard interactive authentication method is used.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.KeyboardInteractiveConnectionInfo.AuthenticationPrompt">
|
||
<summary>
|
||
Occurs when server prompts for more authentication information.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="username">The username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">The host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">The username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.KeyboardInteractiveConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.KeyboardInteractiveConnectionInfo.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.MessageEventArgs`1">
|
||
<summary>
|
||
Provides data for message events.
|
||
</summary>
|
||
<typeparam name="T">Message type.</typeparam>
|
||
</member>
|
||
<member name="P:Renci.SshNet.MessageEventArgs`1.Message">
|
||
<summary>
|
||
Gets the message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.MessageEventArgs`1.#ctor(`0)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.MessageEventArgs`1"/> class.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="message"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.BannerMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_BANNER message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.BannerMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.BannerMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.BannerMessage.Message">
|
||
<summary>
|
||
Gets banner message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.BannerMessage.Language">
|
||
<summary>
|
||
Gets banner language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.BannerMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.BannerMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.BannerMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.FailureMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_FAILURE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.FailureMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.FailureMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.FailureMessage.AllowedAuthentications">
|
||
<summary>
|
||
Gets or sets the allowed authentications if available.
|
||
</summary>
|
||
<value>
|
||
The allowed authentications.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.FailureMessage.Message">
|
||
<summary>
|
||
Gets failure message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.FailureMessage.PartialSuccess">
|
||
<summary>
|
||
Gets a value indicating whether authentication is partially successful.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if partially successful; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.FailureMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.FailureMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.FailureMessage.ToString">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.InformationRequestMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_INFO_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.Name">
|
||
<summary>
|
||
Gets information request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.Instruction">
|
||
<summary>
|
||
Gets information request instruction.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.Language">
|
||
<summary>
|
||
Gets information request language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationRequestMessage.Prompts">
|
||
<summary>
|
||
Gets information request prompts.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.InformationRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.InformationRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.InformationResponseMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_INFO_RESPONSE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationResponseMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationResponseMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationResponseMessage.Responses">
|
||
<summary>
|
||
Gets authentication responses.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.InformationResponseMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
<c>-1</c> to indicate that the size of the message cannot be determined,
|
||
or is too costly to calculate.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.InformationResponseMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.InformationResponseMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.InformationResponseMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.InformationResponseMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_PASSWD_CHANGEREQ message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.Message">
|
||
<summary>
|
||
Gets password change request message as UTF-8 encoded byte array.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.Language">
|
||
<summary>
|
||
Gets message language as UTF-8 encoded byte array.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.PublicKeyMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_PK_OK message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PublicKeyMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PublicKeyMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PublicKeyMessage.PublicKeyAlgorithmName">
|
||
<summary>
|
||
Gets the name of the public key algorithm as ASCII encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The name of the public key algorithm.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PublicKeyMessage.PublicKeyData">
|
||
<summary>
|
||
Gets the public key data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.PublicKeyMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.PublicKeyMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.PublicKeyMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.PublicKeyMessage.ToString">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_REQUEST message. Server as a base message for other user authentication requests.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Authentication.RequestMessage.AuthenticationMessageCode">
|
||
<summary>
|
||
Returns the authentication message code for <c>SSH_MSG_USERAUTH_REQUEST</c>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.Username">
|
||
<summary>
|
||
Gets authentication username as UTF-8 encoded byte array.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.ServiceName">
|
||
<summary>
|
||
Gets the name of the service as ASCII encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The name of the service.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.MethodName">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
<value>
|
||
The name of the method.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessage.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessage"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="methodName">The name of the authentication method.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessage.ToString">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessageHost">
|
||
<summary>
|
||
Represents "hostbased" SSH_MSG_USERAUTH_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.PublicKeyAlgorithm">
|
||
<summary>
|
||
Gets the public key algorithm for host key as ASCII encoded byte array.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.PublicHostKey">
|
||
<summary>
|
||
Gets the public host key and certificates for client host.
|
||
</summary>
|
||
<value>
|
||
The public host key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.ClientHostName">
|
||
<summary>
|
||
Gets the name of the client host as ASCII encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The name of the client host.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.ClientUsername">
|
||
<summary>
|
||
Gets the client username on the client host as UTF-8 encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The client username.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.Signature">
|
||
<summary>
|
||
Gets the signature.
|
||
</summary>
|
||
<value>
|
||
The signature.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageHost.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessageHost.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.String,System.Byte[],System.String,System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessageHost"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="publicKeyAlgorithm">The public key algorithm.</param>
|
||
<param name="publicHostKey">The public host key.</param>
|
||
<param name="clientHostName">Name of the client host.</param>
|
||
<param name="clientUsername">The client username.</param>
|
||
<param name="signature">The signature.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessageHost.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive">
|
||
<summary>
|
||
Represents "keyboard-interactive" SSH_MSG_USERAUTH_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive.Language">
|
||
<summary>
|
||
Gets message language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive.SubMethods">
|
||
<summary>
|
||
Gets authentication sub methods.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive.#ctor(Renci.SshNet.Messages.ServiceName,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessageKeyboardInteractive.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessageNone">
|
||
<summary>
|
||
Represents "none" SSH_MSG_USERAUTH_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessageNone.#ctor(Renci.SshNet.Messages.ServiceName,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessageNone"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessagePassword">
|
||
<summary>
|
||
Represents "password" SSH_MSG_USERAUTH_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePassword.Password">
|
||
<summary>
|
||
Gets authentication password.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePassword.NewPassword">
|
||
<summary>
|
||
Gets new authentication password.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePassword.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePassword.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessagePassword"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePassword.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessagePassword"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<param name="newPassword">New authentication password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePassword.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey">
|
||
<summary>
|
||
Represents "publickey" SSH_MSG_USERAUTH_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.PublicKeyAlgorithmName">
|
||
<summary>
|
||
Gets the name of the public key algorithm as ASCII encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The name of the public key algorithm.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.PublicKeyData">
|
||
<summary>
|
||
Gets the public key data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.Signature">
|
||
<summary>
|
||
Gets or sets public key signature.
|
||
</summary>
|
||
<value>
|
||
The signature.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyAlgorithmName">Name of private key algorithm.</param>
|
||
<param name="keyData">Private key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.#ctor(Renci.SshNet.Messages.ServiceName,System.String,System.String,System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyAlgorithmName">Name of private key algorithm.</param>
|
||
<param name="keyData">Private key data.</param>
|
||
<param name="signature">Private key signature.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.RequestMessagePublicKey.ToString">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Authentication.SuccessMessage">
|
||
<summary>
|
||
Represents SSH_MSG_USERAUTH_SUCCESS message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.SuccessMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Authentication.SuccessMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.SuccessMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Authentication.SuccessMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.CancelTcpIpForwardGlobalRequestMessage.AddressToBind">
|
||
<summary>
|
||
Gets the address to bind to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.CancelTcpIpForwardGlobalRequestMessage.PortToBind">
|
||
<summary>
|
||
Gets port number to bind to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.CancelTcpIpForwardGlobalRequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.CancelTcpIpForwardGlobalRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.CancelTcpIpForwardGlobalRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_CLOSE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelCloseMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelCloseMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelCloseMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelCloseMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelDataMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_DATA message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Data">
|
||
<summary>
|
||
Gets the message data.
|
||
</summary>
|
||
<value>
|
||
The data.
|
||
</value>
|
||
<remarks>
|
||
The actual data to read or write depends on the <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Offset"/> and <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Size"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Offset">
|
||
<summary>
|
||
Gets the zero-based offset in <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Data"/> at which the data begins.
|
||
</summary>
|
||
<value>
|
||
The zero-based offset in <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Data"/> at which the data begins.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Size">
|
||
<summary>
|
||
Gets the number of bytes of <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Data"/> to read or write.
|
||
</summary>
|
||
<value>
|
||
The number of bytes of <see cref="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.Data"/> to read or write.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelDataMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelDataMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelDataMessage.#ctor(System.UInt32,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="data">Message data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelDataMessage.#ctor(System.UInt32,System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="data">The message data.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading or writing data from.</param>
|
||
<param name="size">The number of bytes of <paramref name="data"/> to read or write.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelDataMessage.LoadData">
|
||
<summary>
|
||
Loads the data.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelDataMessage.SaveData">
|
||
<summary>
|
||
Saves the data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelEofMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_EOF message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelEofMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelEofMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelEofMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelEofMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelEofMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelEofMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_EXTENDED_DATA message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.DataTypeCode">
|
||
<summary>
|
||
Gets message data type code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.Data">
|
||
<summary>
|
||
Gets message data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.#ctor(System.UInt32,System.UInt32,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="dataTypeCode">The message data type code.</param>
|
||
<param name="data">The message data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.LoadData">
|
||
<summary>
|
||
Loads the data.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage.SaveData">
|
||
<summary>
|
||
Saves the data.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_FAILURE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelFailureMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelFailureMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelFailureMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelFailureMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelMessage">
|
||
<summary>
|
||
Base class for all channel specific SSH messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelMessage.LocalChannelNumber">
|
||
<summary>
|
||
Gets or sets the local channel number.
|
||
</summary>
|
||
<value>
|
||
The local channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelMessage"/> class with the specified local channel number.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelMessage.ToString">
|
||
<summary>
|
||
Returns a <see cref="T:System.String"/> that represents this instance.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:System.String"/> that represents this instance.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_OPEN_CONFIRMATION message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.RemoteChannelNumber">
|
||
<summary>
|
||
Gets the remote channel number.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.InitialWindowSize">
|
||
<summary>
|
||
Gets the initial size of the window.
|
||
</summary>
|
||
<value>
|
||
The initial size of the window.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.MaximumPacketSize">
|
||
<summary>
|
||
Gets the maximum size of the packet.
|
||
</summary>
|
||
<value>
|
||
The maximum size of the packet.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.#ctor(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="initialWindowSize">Initial size of the window.</param>
|
||
<param name="maximumPacketSize">Maximum size of the packet.</param>
|
||
<param name="remoteChannelNumber">The remote channel number.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_OPEN_FAILURE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.ReasonCode">
|
||
<summary>
|
||
Gets failure reason code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.Description">
|
||
<summary>
|
||
Gets description for failure.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.Language">
|
||
<summary>
|
||
Gets message language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.#ctor(System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="description">The description.</param>
|
||
<param name="reasonCode">The reason code.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.#ctor(System.UInt32,System.String,System.UInt32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="description">The description.</param>
|
||
<param name="reasonCode">The reason code.</param>
|
||
<param name="language">The language (RFC3066).</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureReasons">
|
||
<summary>
|
||
List channel open failure reasons defined by the protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ChannelOpenFailureReasons.AdministativelyProhibited">
|
||
<summary>
|
||
SSH_OPEN_ADMINISTRATIVELY_PROHIBITED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ChannelOpenFailureReasons.ConnectFailed">
|
||
<summary>
|
||
SSH_OPEN_CONNECT_FAILED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ChannelOpenFailureReasons.UnknownChannelType">
|
||
<summary>
|
||
SSH_OPEN_UNKNOWN_CHANNEL_TYPE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ChannelOpenFailureReasons.ResourceShortage">
|
||
<summary>
|
||
SSH_OPEN_RESOURCE_SHORTAGE.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelOpenInfo">
|
||
<summary>
|
||
Base class for open channel messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenInfo.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel to open.
|
||
</summary>
|
||
<value>
|
||
The type of the channel to open.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_OPEN message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel as ASCII encoded byte array.
|
||
</summary>
|
||
<value>
|
||
The type of the channel.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.LocalChannelNumber">
|
||
<summary>
|
||
Gets or sets the local channel number.
|
||
</summary>
|
||
<value>
|
||
The local channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.InitialWindowSize">
|
||
<summary>
|
||
Gets the initial size of the window.
|
||
</summary>
|
||
<value>
|
||
The initial size of the window.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.MaximumPacketSize">
|
||
<summary>
|
||
Gets the maximum size of the packet.
|
||
</summary>
|
||
<value>
|
||
The maximum size of the packet.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.Info">
|
||
<summary>
|
||
Gets channel specific open information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelOpenMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenMessage.#ctor(System.UInt32,System.UInt32,System.UInt32,Renci.SshNet.Messages.Connection.ChannelOpenInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> class.
|
||
</summary>
|
||
<param name="channelNumber">The channel number.</param>
|
||
<param name="initialWindowSize">Initial size of the window.</param>
|
||
<param name="maximumPacketSize">Maximum size of the packet.</param>
|
||
<param name="info">Information specific to the type of the channel to open.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="info"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelOpenMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo">
|
||
<summary>
|
||
Used to open "direct-tcpip" channel type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.NAME">
|
||
<summary>
|
||
Specifies channel open type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel to open.
|
||
</summary>
|
||
<value>
|
||
The type of the channel to open.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.HostToConnect">
|
||
<summary>
|
||
Gets the host to connect.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.PortToConnect">
|
||
<summary>
|
||
Gets the port to connect.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.OriginatorAddress">
|
||
<summary>
|
||
Gets the originator address.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.OriginatorPort">
|
||
<summary>
|
||
Gets the originator port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo"/> class from the
|
||
specified data.
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.#ctor(System.String,System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo"/> class.
|
||
</summary>
|
||
<param name="hostToConnect">The host to connect.</param>
|
||
<param name="portToConnect">The port to connect.</param>
|
||
<param name="originatorAddress">The originator address.</param>
|
||
<param name="originatorPort">The originator port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.DirectTcpipChannelInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo">
|
||
<summary>
|
||
Used to open "forwarded-tcpip" channel type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.NAME">
|
||
<summary>
|
||
Specifies channel open type.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo"/> class from the
|
||
specified data.
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.#ctor(System.String,System.UInt32,System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo"/> class with the
|
||
specified connector address and port, and originator address and port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel to open.
|
||
</summary>
|
||
<value>
|
||
The type of the channel to open.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.ConnectedAddress">
|
||
<summary>
|
||
Gets the connected address.
|
||
</summary>
|
||
<value>
|
||
The connected address.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.ConnectedPort">
|
||
<summary>
|
||
Gets the connected port.
|
||
</summary>
|
||
<value>
|
||
The connected port.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.OriginatorAddress">
|
||
<summary>
|
||
Gets the originator address.
|
||
</summary>
|
||
<value>
|
||
The originator address.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.OriginatorPort">
|
||
<summary>
|
||
Gets the originator port.
|
||
</summary>
|
||
<value>
|
||
The originator port.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ForwardedTcpipChannelInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo">
|
||
<summary>
|
||
Used to open "session" channel type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo.Name">
|
||
<summary>
|
||
Specifies channel open type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel to open.
|
||
</summary>
|
||
<value>
|
||
The type of the channel to open.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SessionChannelOpenInfo"/> class from the
|
||
specified data.
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo">
|
||
<summary>
|
||
Used to open "x11" channel type.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.Name">
|
||
<summary>
|
||
Specifies channel open type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.ChannelType">
|
||
<summary>
|
||
Gets the type of the channel to open.
|
||
</summary>
|
||
<value>
|
||
The type of the channel to open.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.OriginatorAddress">
|
||
<summary>
|
||
Gets the originator address.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.OriginatorPort">
|
||
<summary>
|
||
Gets the originator port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo"/> class from the
|
||
specified data.
|
||
</summary>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.#ctor(System.String,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo"/> class with the
|
||
specified originator address and port.
|
||
</summary>
|
||
<param name="originatorAddress">The originator address.</param>
|
||
<param name="originatorPort">The originator port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ChannelOpenInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.BreakRequestInfo">
|
||
<summary>
|
||
Represents "break" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.BreakRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.BreakRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.BreakRequestInfo.BreakLength">
|
||
<summary>
|
||
Gets break length in milliseconds.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.BreakRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.BreakRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.BreakRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.BreakRequestInfo.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.BreakRequestInfo"/> class.
|
||
</summary>
|
||
<param name="breakLength">Length of the break.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.BreakRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.BreakRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelRequestMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelRequestMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelRequestMessage.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelRequestMessage.RequestData">
|
||
<summary>
|
||
Gets channel request data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelRequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelRequestMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelRequestMessage.#ctor(System.UInt32,Renci.SshNet.Messages.Connection.RequestInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="info">The info.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.EndOfWriteRequestInfo">
|
||
<summary>
|
||
Represents "eow@openssh.com" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.EndOfWriteRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.EndOfWriteRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.EndOfWriteRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.EndOfWriteRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo">
|
||
<summary>
|
||
Represents "env" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.VariableName">
|
||
<summary>
|
||
Gets the name of the variable.
|
||
</summary>
|
||
<value>
|
||
The name of the variable.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.VariableValue">
|
||
<summary>
|
||
Gets the value of the variable.
|
||
</summary>
|
||
<value>
|
||
The variable value.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo"/> class.
|
||
</summary>
|
||
<param name="variableName">Name of the variable.</param>
|
||
<param name="variableValue">The variable value.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.EnvironmentVariableRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ExecRequestInfo">
|
||
<summary>
|
||
Represents "exec" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ExecRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExecRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExecRequestInfo.Command">
|
||
<summary>
|
||
Gets command to execute.
|
||
</summary>
|
||
<value>
|
||
The command.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExecRequestInfo.Encoding">
|
||
<summary>
|
||
Gets the encoding.
|
||
</summary>
|
||
<value>
|
||
The encoding.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExecRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExecRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExecRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExecRequestInfo.#ctor(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExecRequestInfo"/> class.
|
||
</summary>
|
||
<param name="command">The command.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="command"/> or <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExecRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExecRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo">
|
||
<summary>
|
||
Represents "exit-signal" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.SignalName">
|
||
<summary>
|
||
Gets the name of the signal.
|
||
</summary>
|
||
<value>
|
||
The name of the signal.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.CoreDumped">
|
||
<summary>
|
||
Gets a value indicating whether core is dumped.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if core is dumped; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.ErrorMessage">
|
||
<summary>
|
||
Gets the error message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.Language">
|
||
<summary>
|
||
Gets message language.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.#ctor(System.String,System.Boolean,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo"/> class.
|
||
</summary>
|
||
<param name="signalName">Name of the signal.</param>
|
||
<param name="coreDumped">if set to <see langword="true"/> then core is dumped.</param>
|
||
<param name="errorMessage">The error message.</param>
|
||
<param name="language">The language.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitSignalRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo">
|
||
<summary>
|
||
Represents "exit-status" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.ExitStatus">
|
||
<summary>
|
||
Gets the exit status number.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo"/> class.
|
||
</summary>
|
||
<param name="exitStatus">The exit status number.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ExitStatusRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.KeepAliveRequestInfo">
|
||
<summary>
|
||
Represents "keepalive@openssh.com" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.KeepAliveRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.KeepAliveRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.KeepAliveRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.KeepAliveRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo">
|
||
<summary>
|
||
Represents "pty-req" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.EnvironmentVariable">
|
||
<summary>
|
||
Gets or sets the value of the TERM environment variable (e.g., vt100).
|
||
</summary>
|
||
<value>
|
||
The value of the TERM environment variable.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.Columns">
|
||
<summary>
|
||
Gets or sets the terminal width in columns (e.g., 80).
|
||
</summary>
|
||
<value>
|
||
The terminal width in columns.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.Rows">
|
||
<summary>
|
||
Gets or sets the terminal width in rows (e.g., 24).
|
||
</summary>
|
||
<value>
|
||
The terminal width in rows.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.PixelWidth">
|
||
<summary>
|
||
Gets or sets the terminal width in pixels (e.g., 640).
|
||
</summary>
|
||
<value>
|
||
The terminal width in pixels.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.PixelHeight">
|
||
<summary>
|
||
Gets or sets the terminal height in pixels (e.g., 480).
|
||
</summary>
|
||
<value>
|
||
The terminal height in pixels.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.TerminalModeValues">
|
||
<summary>
|
||
Gets or sets the terminal mode.
|
||
</summary>
|
||
<value>
|
||
The terminal mode.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
<c>-1</c> to indicate that the size of the message cannot be determined,
|
||
or is too costly to calculate.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.#ctor(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo"/> class.
|
||
</summary>
|
||
<param name="environmentVariable">The <c>TERM</c> environment variable which a identifier for the text window’s capabilities.</param>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal width in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<remarks>
|
||
<para>
|
||
The <c>TERM</c> environment variable contains an identifier for the text window's capabilities.
|
||
You can get a detailed list of these capabilities by using the ‘infocmp’ command.
|
||
</para>
|
||
<para>
|
||
The column/row dimensions override the pixel dimensions(when nonzero). Pixel dimensions refer
|
||
to the drawable area of the window.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.PseudoTerminalRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.RequestInfo">
|
||
<summary>
|
||
Represents type specific information for channel request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestInfo.WantReply">
|
||
<summary>
|
||
Gets or sets a value indicating whether reply message is needed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if reply message is needed; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ShellRequestInfo">
|
||
<summary>
|
||
Represents "shell" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.ShellRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ShellRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ShellRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ShellRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.SignalRequestInfo">
|
||
<summary>
|
||
Represents "signal" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.SignalRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SignalRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SignalRequestInfo.SignalName">
|
||
<summary>
|
||
Gets the name of the signal.
|
||
</summary>
|
||
<value>
|
||
The name of the signal.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SignalRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SignalRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SignalRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SignalRequestInfo.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SignalRequestInfo"/> class.
|
||
</summary>
|
||
<param name="signalName">Name of the signal.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SignalRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SignalRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.SubsystemRequestInfo">
|
||
<summary>
|
||
Represents "subsystem" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.SubsystemName">
|
||
<summary>
|
||
Gets the name of the subsystem.
|
||
</summary>
|
||
<value>
|
||
The name of the subsystem.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SubsystemRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.SubsystemRequestInfo"/> class.
|
||
</summary>
|
||
<param name="subsystem">The subsystem.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.SubsystemRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.UnknownRequestInfo">
|
||
<summary>
|
||
Represents an unknown request information that we can't handle.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.UnknownRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.UnknownRequestInfo.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.UnknownRequestInfo"/> class.
|
||
<paramref name="requestName">The name of the unknown request.</paramref>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo">
|
||
<summary>
|
||
Represents "window-change" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.Name">
|
||
<summary>
|
||
Channe request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.Columns">
|
||
<summary>
|
||
Gets the columns.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.Rows">
|
||
<summary>
|
||
Gets the rows.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.Width">
|
||
<summary>
|
||
Gets the width.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.Height">
|
||
<summary>
|
||
Gets the height.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.#ctor(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo"/> class.
|
||
</summary>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.WindowChangeRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo">
|
||
<summary>
|
||
Represents "x11-req" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.Name">
|
||
<summary>
|
||
Channel request name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.IsSingleConnection">
|
||
<summary>
|
||
Gets or sets a value indicating whether it is a single connection.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if it is a single connection; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.AuthenticationProtocol">
|
||
<summary>
|
||
Gets the authentication protocol.
|
||
</summary>
|
||
<value>
|
||
The authentication protocol.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.AuthenticationCookie">
|
||
<summary>
|
||
Gets or sets the authentication cookie.
|
||
</summary>
|
||
<value>
|
||
The authentication cookie.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.ScreenNumber">
|
||
<summary>
|
||
Gets or sets the screen number.
|
||
</summary>
|
||
<value>
|
||
The screen number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.#ctor(System.Boolean,System.String,System.Byte[],System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo"/> class.
|
||
</summary>
|
||
<param name="isSingleConnection">if set to <see langword="true"/> it is a single connection.</param>
|
||
<param name="protocol">The protocol.</param>
|
||
<param name="cookie">The cookie.</param>
|
||
<param name="screenNumber">The screen number.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.X11ForwardingRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.XonXoffRequestInfo">
|
||
<summary>
|
||
Represents "xon-xoff" type channel request information.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.Name">
|
||
<summary>
|
||
Channel request type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.ClientCanDo">
|
||
<summary>
|
||
Gets or sets a value indicating whether client can do.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if client can do; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.XonXoffRequestInfo"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.#ctor(System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.XonXoffRequestInfo"/> class.
|
||
</summary>
|
||
<param name="clientCanDo">if set to <see langword="true"/> [client can do].</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.XonXoffRequestInfo.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_SUCCESS message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelSuccessMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelSuccessMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelSuccessMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelSuccessMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage">
|
||
<summary>
|
||
Represents SSH_MSG_CHANNEL_SUCCESS message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.BytesToAdd">
|
||
<summary>
|
||
Gets number of bytes to add to the window.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.#ctor(System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> class.
|
||
</summary>
|
||
<param name="localChannelNumber">The local channel number.</param>
|
||
<param name="bytesToAdd">The bytes to add.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.GlobalRequestMessage">
|
||
<summary>
|
||
Represents SSH_MSG_GLOBAL_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.GlobalRequestMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.GlobalRequestMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.GlobalRequestMessage.RequestName">
|
||
<summary>
|
||
Gets the name of the request.
|
||
</summary>
|
||
<value>
|
||
The name of the request.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.GlobalRequestMessage.WantReply">
|
||
<summary>
|
||
Gets a value indicating whether message reply should be sent..
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if message reply should be sent; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.GlobalRequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.GlobalRequestMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.GlobalRequestMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.GlobalRequestMessage.#ctor(System.Byte[],System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.GlobalRequestMessage"/> class.
|
||
</summary>
|
||
<param name="requestName">Name of the request.</param>
|
||
<param name="wantReply">if set to <see langword="true"/> [want reply].</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.GlobalRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.GlobalRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.GlobalRequestName">
|
||
<summary>
|
||
Specifies supported request names.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.GlobalRequestName.TcpIpForward">
|
||
<summary>
|
||
tcpip-forward.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Connection.GlobalRequestName.CancelTcpIpForward">
|
||
<summary>
|
||
cancel-tcpip-forward.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.RequestFailureMessage">
|
||
<summary>
|
||
Represents SSH_MSG_REQUEST_FAILURE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestFailureMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestFailureMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestFailureMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestFailureMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage">
|
||
<summary>
|
||
Represents SSH_MSG_REQUEST_SUCCESS message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestSuccessMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestSuccessMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestSuccessMessage.BoundPort">
|
||
<summary>
|
||
Gets the bound port.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.RequestSuccessMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestSuccessMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestSuccessMessage.#ctor(System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> class.
|
||
</summary>
|
||
<param name="boundPort">The bound port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestSuccessMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.RequestSuccessMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.TcpIpForwardGlobalRequestMessage.AddressToBind">
|
||
<summary>
|
||
Gets the address to bind to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.TcpIpForwardGlobalRequestMessage.PortToBind">
|
||
<summary>
|
||
Gets port number to bind to.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Connection.TcpIpForwardGlobalRequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.TcpIpForwardGlobalRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Connection.TcpIpForwardGlobalRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Message">
|
||
<summary>
|
||
Base class for all SSH protocol messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Message.MessageName">
|
||
<summary>
|
||
Gets the message name as defined in RFC 4250.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Message.MessageNumber">
|
||
<summary>
|
||
Gets the message number as defined in RFC 4250.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Message.BufferCapacity">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Message.WriteBytes(Renci.SshNet.Common.SshDataStream)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Message.ToString">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Message.Process(Renci.SshNet.Session)">
|
||
<summary>
|
||
Process the current message for the specified <see cref="T:Renci.SshNet.Session"/>.
|
||
</summary>
|
||
<param name="session">The <see cref="T:Renci.SshNet.Session"/> for which to process the current message.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.ServiceName">
|
||
<summary>
|
||
Specifies list of supported services.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.ServiceName.UserAuthentication">
|
||
<summary>
|
||
ssh-userauth.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.ServiceName.Connection">
|
||
<summary>
|
||
ssh-connection.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.DebugMessage">
|
||
<summary>
|
||
Represents SSH_MSG_DEBUG message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.IsAlwaysDisplay">
|
||
<summary>
|
||
Gets a value indicating whether the message to be always displayed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the message always to be displayed; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.Message">
|
||
<summary>
|
||
Gets debug message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.Language">
|
||
<summary>
|
||
Gets message language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DebugMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DebugMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DebugMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.DisconnectMessage">
|
||
<summary>
|
||
Represents SSH_MSG_DISCONNECT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.ReasonCode">
|
||
<summary>
|
||
Gets disconnect reason code.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.Description">
|
||
<summary>
|
||
Gets disconnect description.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.Language">
|
||
<summary>
|
||
Gets message language.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.DisconnectMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DisconnectMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.DisconnectMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DisconnectMessage.#ctor(Renci.SshNet.Messages.Transport.DisconnectReason,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.DisconnectMessage"/> class.
|
||
</summary>
|
||
<param name="reasonCode">The reason code.</param>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DisconnectMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.DisconnectMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.DisconnectReason">
|
||
<summary>
|
||
Provides list of disconnect reason as specified by the protocol.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.None">
|
||
<summary>
|
||
Disconnect reason is not provided.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.HostNotAllowedToConnect">
|
||
<summary>
|
||
SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.ProtocolError">
|
||
<summary>
|
||
SSH_DISCONNECT_PROTOCOL_ERROR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.KeyExchangeFailed">
|
||
<summary>
|
||
SSH_DISCONNECT_KEY_EXCHANGE_FAILED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.Reserved">
|
||
<summary>
|
||
SSH_DISCONNECT_RESERVED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.MacError">
|
||
<summary>
|
||
SSH_DISCONNECT_MAC_ERROR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.CompressionError">
|
||
<summary>
|
||
SSH_DISCONNECT_COMPRESSION_ERROR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.ServiceNotAvailable">
|
||
<summary>
|
||
SSH_DISCONNECT_SERVICE_NOT_AVAILABLE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.ProtocolVersionNotSupported">
|
||
<summary>
|
||
SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.HostKeyNotVerifiable">
|
||
<summary>
|
||
SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.ConnectionLost">
|
||
<summary>
|
||
SSH_DISCONNECT_CONNECTION_LOST.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.ByApplication">
|
||
<summary>
|
||
SSH_DISCONNECT_BY_APPLICATION.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.TooManyConnections">
|
||
<summary>
|
||
SSH_DISCONNECT_TOO_MANY_CONNECTIONS.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.AuthenticationCanceledByUser">
|
||
<summary>
|
||
SSH_DISCONNECT_AUTH_CANCELLED_BY_USER.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.NoMoreAuthenticationMethodsAvailable">
|
||
<summary>
|
||
SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Messages.Transport.DisconnectReason.IllegalUserName">
|
||
<summary>
|
||
SSH_DISCONNECT_ILLEGAL_USER_NAME.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.IgnoreMessage">
|
||
<summary>
|
||
Represents SSH_MSG_IGNORE message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.IgnoreMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.IgnoreMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.IgnoreMessage.Data">
|
||
<summary>
|
||
Gets ignore message data if this message has been initialised
|
||
with data to be sent. Otherwise, returns an empty array.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.IgnoreMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.IgnoreMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.IgnoreMessage.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.IgnoreMessage"/> class.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.IgnoreMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.IgnoreMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.IgnoreMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.IKeyExchangedAllowed">
|
||
<summary>
|
||
Indicates that message that implement this interface is allowed during key exchange phase.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_DH_GEX_GROUP message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.SafePrime">
|
||
<summary>
|
||
Gets the safe prime.
|
||
</summary>
|
||
<value>
|
||
The safe prime.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.SubGroup">
|
||
<summary>
|
||
Gets the generator for subgroup in GF(p).
|
||
</summary>
|
||
<value>
|
||
The sub group.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_DH_GEX_INIT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.E">
|
||
<summary>
|
||
Gets the E value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit"/> class.
|
||
</summary>
|
||
<param name="clientExchangeValue">The client exchange value.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeInit.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_DH_GEX_REPLY message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.HostKey">
|
||
<summary>
|
||
Gets server public host key and certificates.
|
||
</summary>
|
||
<value>
|
||
The host key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.F">
|
||
<summary>
|
||
Gets the F value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.Signature">
|
||
<summary>
|
||
Gets the signature of H.
|
||
</summary>
|
||
<value>The signature.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_DH_GEX_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.Minimum">
|
||
<summary>
|
||
Gets the minimum size, in bits, of an acceptable group.
|
||
</summary>
|
||
<value>
|
||
The minimum.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.Preferred">
|
||
<summary>
|
||
Gets the preferred size, in bits, of the group the server will send.
|
||
</summary>
|
||
<value>
|
||
The preferred.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.Maximum">
|
||
<summary>
|
||
Gets the maximum size, in bits, of an acceptable group.
|
||
</summary>
|
||
<value>
|
||
The maximum.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.#ctor(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest"/> class.
|
||
</summary>
|
||
<param name="minimum">The minimum.</param>
|
||
<param name="preferred">The preferred.</param>
|
||
<param name="maximum">The maximum.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeRequest.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEXDH_INIT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.E">
|
||
<summary>
|
||
Gets the E value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage"/> class.
|
||
</summary>
|
||
<param name="clientExchangeValue">The client exchange value.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhInitMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEXDH_REPLY message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.HostKey">
|
||
<summary>
|
||
Gets server public host key and certificates.
|
||
</summary>
|
||
<value>The host key.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.F">
|
||
<summary>
|
||
Gets the F value.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.Signature">
|
||
<summary>
|
||
Gets the signature of H.
|
||
</summary>
|
||
<value>The signature.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_ECDH_INIT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.QC">
|
||
<summary>
|
||
Gets the client's ephemeral contribution to the ECDH exchange, encoded as an octet string.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeEcdhInitMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_ECDH_REPLY message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.KS">
|
||
<summary>
|
||
Gets a string encoding an X.509v3 certificate containing the server's ECDSA public host key.
|
||
</summary>
|
||
<value>The host key.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.QS">
|
||
<summary>
|
||
Gets the server's ephemeral contribution to the ECDH exchange, encoded as an octet string.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.Signature">
|
||
<summary>
|
||
Gets an octet string containing the server's signature of the newly established exchange hash value.
|
||
</summary>
|
||
<value>The signature.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_HYBRID_INIT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.CInit">
|
||
<summary>
|
||
Gets the client init data.
|
||
</summary>
|
||
<remarks>
|
||
The init data is the concatenation of C_PK2 and C_PK1 (C_INIT = C_PK2 || C_PK1, where || depicts concatenation).
|
||
C_PK1 and C_PK2 represent the ephemeral client public keys used for each key exchange of the PQ/T Hybrid mechanism.
|
||
Typically, C_PK1 represents a traditional / classical (i.e., ECDH) key exchange public key.
|
||
C_PK2 represents the 'pk' output of the corresponding post-quantum KEM's 'KeyGen' at the client.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeHybridInitMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEX_HYBRID_REPLY message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.KS">
|
||
<summary>
|
||
Gets a string encoding an X.509v3 certificate containing the server's ECDSA public host key.
|
||
</summary>
|
||
<value>The host key.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.SReply">
|
||
<summary>
|
||
Gets the server reply.
|
||
</summary>
|
||
<remarks>
|
||
The server reply is the concatenation of S_CT2 and S_PK1 (S_REPLY = S_CT2 || S_PK1).
|
||
Typically, S_PK1 represents the ephemeral (EC)DH server public key.
|
||
S_CT2 represents the ciphertext 'ct' output of the corresponding KEM's 'Encaps' algorithm generated by
|
||
the server which encapsulates a secret to the client public key C_PK2.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.Signature">
|
||
<summary>
|
||
Gets an octet string containing the server's signature of the newly established exchange hash value.
|
||
</summary>
|
||
<value>The signature.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage">
|
||
<summary>
|
||
Represents SSH_MSG_KEXINIT message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.Cookie">
|
||
<summary>
|
||
Gets session cookie.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.KeyExchangeAlgorithms">
|
||
<summary>
|
||
Gets or sets supported key exchange algorithms.
|
||
</summary>
|
||
<value>
|
||
Supported key exchange algorithms.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.ServerHostKeyAlgorithms">
|
||
<summary>
|
||
Gets or sets supported server host key algorithms.
|
||
</summary>
|
||
<value>
|
||
Supported server host key algorithms.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.EncryptionAlgorithmsClientToServer">
|
||
<summary>
|
||
Gets or sets supported encryption algorithms client to server.
|
||
</summary>
|
||
<value>
|
||
Supported encryption algorithms client to server.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.EncryptionAlgorithmsServerToClient">
|
||
<summary>
|
||
Gets or sets supported encryption algorithms server to client.
|
||
</summary>
|
||
<value>
|
||
Supported encryption algorithms server to client.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.MacAlgorithmsClientToServer">
|
||
<summary>
|
||
Gets or sets supported hash algorithms client to server.
|
||
</summary>
|
||
<value>
|
||
Supported hash algorithms client to server.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.MacAlgorithmsServerToClient">
|
||
<summary>
|
||
Gets or sets supported hash algorithms server to client.
|
||
</summary>
|
||
<value>
|
||
Supported hash algorithms server to client.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.CompressionAlgorithmsClientToServer">
|
||
<summary>
|
||
Gets or sets supported compression algorithms client to server.
|
||
</summary>
|
||
<value>
|
||
Supported compression algorithms client to server.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.CompressionAlgorithmsServerToClient">
|
||
<summary>
|
||
Gets or sets supported compression algorithms server to client.
|
||
</summary>
|
||
<value>
|
||
Supported compression algorithms server to client.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.LanguagesClientToServer">
|
||
<summary>
|
||
Gets or sets supported languages client to server.
|
||
</summary>
|
||
<value>
|
||
Supported languages client to server.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.LanguagesServerToClient">
|
||
<summary>
|
||
Gets or sets supported languages server to client.
|
||
</summary>
|
||
<value>
|
||
The languages server to client.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.FirstKexPacketFollows">
|
||
<summary>
|
||
Gets or sets a value indicating whether first key exchange packet follows.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if first key exchange packet follows; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.Reserved">
|
||
<summary>
|
||
Gets or sets the reserved value.
|
||
</summary>
|
||
<value>
|
||
The reserved value.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
<c>-1</c> to indicate that the size of the message cannot be determined,
|
||
or is too costly to calculate.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.NewKeysMessage">
|
||
<summary>
|
||
Represents SSH_MSG_NEWKEYS message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.NewKeysMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.NewKeysMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.NewKeysMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.NewKeysMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.ServiceAcceptMessage">
|
||
<summary>
|
||
Represents SSH_MSG_SERVICE_ACCEPT message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceAcceptMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceAcceptMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceAcceptMessage.ServiceName">
|
||
<summary>
|
||
Gets the name of the service.
|
||
</summary>
|
||
<value>
|
||
The name of the service.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.ServiceAcceptMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.ServiceAcceptMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.ServiceRequestMessage">
|
||
<summary>
|
||
Represents SSH_MSG_SERVICE_REQUEST message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceRequestMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceRequestMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceRequestMessage.ServiceName">
|
||
<summary>
|
||
Gets the name of the service.
|
||
</summary>
|
||
<value>
|
||
The name of the service.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.ServiceRequestMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.ServiceRequestMessage.#ctor(Renci.SshNet.Messages.ServiceName)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Messages.Transport.ServiceRequestMessage"/> class.
|
||
</summary>
|
||
<param name="serviceName">Name of the service.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.ServiceRequestMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.ServiceRequestMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Messages.Transport.UnimplementedMessage">
|
||
<summary>
|
||
Represents SSH_MSG_UNIMPLEMENTED message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.UnimplementedMessage.MessageName">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="P:Renci.SshNet.Messages.Transport.UnimplementedMessage.MessageNumber">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.UnimplementedMessage.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Messages.Transport.UnimplementedMessage.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.NetConfClient">
|
||
<summary>
|
||
Contains operation for working with NetConf server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.NetConfClient._netConfSession">
|
||
<summary>
|
||
Holds <see cref="T:Renci.SshNet.NetConf.INetConfSession"/> instance that used to communicate to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConfClient.OperationTimeout">
|
||
<summary>
|
||
Gets or sets the operation timeout.
|
||
</summary>
|
||
<value>
|
||
The timeout to wait until an operation completes. The default value is negative
|
||
one (-1) milliseconds, which indicates an infinite time-out period.
|
||
</value>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> represents a value that is less than -1 or greater than <see cref="F:System.Int32.MaxValue"/> milliseconds.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConfClient.NetConfSession">
|
||
<summary>
|
||
Gets the current NetConf session.
|
||
</summary>
|
||
<value>
|
||
The current NetConf session.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(Renci.SshNet.ConnectionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConfClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConfClient.ServerCapabilities">
|
||
<summary>
|
||
Gets the NetConf server capabilities.
|
||
</summary>
|
||
<value>
|
||
The NetConf server capabilities.
|
||
</value>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConfClient.ClientCapabilities">
|
||
<summary>
|
||
Gets the NetConf client capabilities.
|
||
</summary>
|
||
<value>
|
||
The NetConf client capabilities.
|
||
</value>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConfClient.AutomaticMessageIdHandling">
|
||
<summary>
|
||
Gets or sets a value indicating whether automatic message id handling is
|
||
enabled.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if automatic message id handling is enabled; otherwise, <see langword="false"/>.
|
||
The default value is <see langword="true"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.SendReceiveRpc(System.Xml.XmlDocument)">
|
||
<summary>
|
||
Sends the receive RPC.
|
||
</summary>
|
||
<example>
|
||
<code>
|
||
var rpcXmlTemplate = "<rpc xmlns='urn:ietf:params:xml:ns:netconf:base:1.0' message-id='1'>{0}</rpc>"'
|
||
rpc.LoadXml(String.Format(rpcXmlTemplate, "<get-config><source><running/></source></get-config>"));
|
||
var rpcResponse = client.SendReceiveRpc(rpc);
|
||
</code>
|
||
</example>
|
||
<param name="rpc">The RPC.</param>
|
||
<returns>
|
||
Reply message to RPC request.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.SendReceiveRpc(System.String)">
|
||
<summary>
|
||
Sends the receive RPC.
|
||
</summary>
|
||
<example>
|
||
<code>
|
||
var rpcXmlTemplate = "<rpc xmlns='urn:ietf:params:xml:ns:netconf:base:1.0' message-id='1'>{0}</rpc>"'
|
||
var rpcResponse = client.SendReceiveRpc(String.Format(rpcXmlTemplate, "<get-config><source><running/></source></get-config>"));
|
||
</code>
|
||
</example>
|
||
<param name="xml">The XML.</param>
|
||
<returns>
|
||
Reply message to RPC request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.SendCloseRpc">
|
||
<summary>
|
||
Sends the close RPC.
|
||
</summary>
|
||
<returns>
|
||
Reply message to closing RPC request.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.OnConnected">
|
||
<summary>
|
||
Called when client is connected to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConfClient.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.NetConf.INetConfSession">
|
||
<summary>
|
||
Represents a <c>NETCONF</c> session.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConf.INetConfSession.ServerCapabilities">
|
||
<summary>
|
||
Gets the <c>NETCONF</c> server capabilities.
|
||
</summary>
|
||
<value>
|
||
The <c>NETCONF</c> server capabilities.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConf.INetConfSession.ClientCapabilities">
|
||
<summary>
|
||
Gets the <c>NETCONF</c> client capabilities.
|
||
</summary>
|
||
<value>
|
||
The <c>NETCONF</c> client capabilities.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConf.INetConfSession.SendReceiveRpc(System.Xml.XmlDocument,System.Boolean)">
|
||
<summary>
|
||
Sends the specified RPC request and returns the reply sent by the <c>NETCONF</c> server.
|
||
</summary>
|
||
<param name="rpc">The RPC request.</param>
|
||
<param name="automaticMessageIdHandling"><see langword="true"/> to automatically increment the message id and verify the message id of the RPC reply.</param>
|
||
<returns>
|
||
The RPC reply.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.NetConfServerException"><paramref name="automaticMessageIdHandling"/> is <see langword="true"/> and the message id in the RPC reply does not match the message id of the RPC request.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConf.NetConfSession.GetLengthRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>\\n#(?<length>\\d+)\\n</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match the string "\n#".<br/>
|
||
○ "length" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\n'.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConf.NetConfSession.GetReplyRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>\\n##\\n</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match the string "\n##\n".<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConf.NetConfSession.ServerCapabilities">
|
||
<summary>
|
||
Gets NetConf server capabilities.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NetConf.NetConfSession.ClientCapabilities">
|
||
<summary>
|
||
Gets NetConf client capabilities.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NetConf.NetConfSession.#ctor(Renci.SshNet.ISession,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NetConf.NetConfSession"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for an operation to complete, or -1 to wait indefinitely.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.NoneAuthenticationMethod">
|
||
<summary>
|
||
Provides functionality for "none" authentication method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.NoneAuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NoneAuthenticationMethod.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.NoneAuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NoneAuthenticationMethod.Authenticate(Renci.SshNet.Session)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<returns>
|
||
Result of authentication process.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="session" /> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.NoneAuthenticationMethod.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PasswordAuthenticationMethod">
|
||
<summary>
|
||
Provides functionality to perform password authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PasswordAuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PasswordAuthenticationMethod.Password">
|
||
<summary>
|
||
Gets the password as a sequence of bytes.
|
||
</summary>
|
||
<value>
|
||
The password as a sequence of bytes.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.PasswordAuthenticationMethod.PasswordExpired">
|
||
<summary>
|
||
Occurs when user's password has expired and needs to be changed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordAuthenticationMethod.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordAuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<param name="password">The password.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordAuthenticationMethod.#ctor(System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordAuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<param name="password">The password.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordAuthenticationMethod.Authenticate(Renci.SshNet.Session)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>
|
||
Result of authentication process.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="session" /> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordAuthenticationMethod.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PasswordConnectionInfo">
|
||
<summary>
|
||
Provides connection information when password authentication method is used.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.PasswordConnectionInfo.PasswordExpired">
|
||
<summary>
|
||
Occurs when user's password has expired and needs to be changed.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo" /> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo" /> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host" /> is invalid, or <paramref name="username" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port" /> is not within <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.#ctor(System.String,System.Int32,System.String,System.Byte[],Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PasswordConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="password">Connection password.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PasswordConnectionInfo.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PrivateKeyAuthenticationMethod">
|
||
<summary>
|
||
Provides functionality to perform private key authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyAuthenticationMethod.Name">
|
||
<summary>
|
||
Gets the name of the authentication method.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyAuthenticationMethod.KeyFiles">
|
||
<summary>
|
||
Gets the key files used for authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyAuthenticationMethod.#ctor(System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyAuthenticationMethod"/> class.
|
||
</summary>
|
||
<param name="username">The username.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="username"/> is whitespace or <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyAuthenticationMethod.Authenticate(Renci.SshNet.Session)">
|
||
<summary>
|
||
Authenticates the specified session.
|
||
</summary>
|
||
<param name="session">The session to authenticate.</param>
|
||
<returns>
|
||
Result of authentication process.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyAuthenticationMethod.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PrivateKeyConnectionInfo">
|
||
<summary>
|
||
Provides connection information when private key authentication method is used.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyConnectionInfo.KeyFiles">
|
||
<summary>
|
||
Gets the key files used for authentication.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="keyFiles">Connection key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="keyFiles">Connection key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.#ctor(System.String,System.Int32,System.String,Renci.SshNet.ProxyTypes,System.String,System.Int32,System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyConnectionInfo"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">The port.</param>
|
||
<param name="username">Connection username.</param>
|
||
<param name="proxyType">Type of the proxy.</param>
|
||
<param name="proxyHost">The proxy host.</param>
|
||
<param name="proxyPort">The proxy port.</param>
|
||
<param name="proxyUsername">The proxy username.</param>
|
||
<param name="proxyPassword">The proxy password.</param>
|
||
<param name="keyFiles">The key files.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyConnectionInfo.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PrivateKeyFile">
|
||
<summary>
|
||
Represents private key information.
|
||
</summary>
|
||
<remarks>
|
||
<para>
|
||
The following private keys are supported:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>RSA in OpenSSL PEM, ssh.com, OpenSSH and PuTTY key format</description>
|
||
</item>
|
||
<item>
|
||
<description>ECDSA 256/384/521 in OpenSSL PEM, OpenSSH and PuTTY key format</description>
|
||
</item>
|
||
<item>
|
||
<description>ED25519 in OpenSSL PEM, OpenSSH and PuTTY key format</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
<para>
|
||
The following encryption algorithms are supported for OpenSSL traditional PEM:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>DES-EDE3-CBC</description>
|
||
</item>
|
||
<item>
|
||
<description>DES-EDE3-CFB</description>
|
||
</item>
|
||
<item>
|
||
<description>AES-128-CBC</description>
|
||
</item>
|
||
<item>
|
||
<description>AES-192-CBC</description>
|
||
</item>
|
||
<item>
|
||
<description>AES-256-CBC</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
<para>
|
||
Private keys in OpenSSL PKCS#8 PEM format can be encrypted using any cipher method BouncyCastle supports.
|
||
</para>
|
||
<para>
|
||
The following encryption algorithms are supported for ssh.com format:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>3des-cbc</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
<para>
|
||
The following encryption algorithms are supported for OpenSSH key format:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>3des-cbc</description>
|
||
</item>
|
||
<item>
|
||
<description>aes128-cbc</description>
|
||
</item>
|
||
<item>
|
||
<description>aes192-cbc</description>
|
||
</item>
|
||
<item>
|
||
<description>aes256-cbc</description>
|
||
</item>
|
||
<item>
|
||
<description>aes128-ctr</description>
|
||
</item>
|
||
<item>
|
||
<description>aes192-ctr</description>
|
||
</item>
|
||
<item>
|
||
<description>aes256-ctr</description>
|
||
</item>
|
||
<item>
|
||
<description>aes128-gcm@openssh.com</description>
|
||
</item>
|
||
<item>
|
||
<description>aes256-gcm@openssh.com</description>
|
||
</item>
|
||
<item>
|
||
<description>chacha20-poly1305@openssh.com</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
<para>
|
||
The following encryption algorithms are supported for PuTTY key format:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>aes256-cbc</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.GetPrivateKeyRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>^-+ *BEGIN (?<keyName>\\w+( \\w+)*) *-+\\r?\\n((Proc-Type: 4,ENCRYPTED\\r?\\nDEK-Info: (?<cipherName>[A-Z0-9-]+),(?<salt>[a-fA-F0-9]+)\\r?\\n\\r?\\n)|(Comment: "?[^\\r\\n]*"?\\r?\\n))?(?<data>([a-zA-Z0-9/+=]{1,80}\\r?\\n)+)(\\r?\\n)?-+ *END \\k<keyName> *-+</code><br/>
|
||
Options:<br/>
|
||
<code>RegexOptions.Multiline | RegexOptions.ExplicitCapture</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match if at the beginning of a line.<br/>
|
||
○ Match '-' atomically at least once.<br/>
|
||
○ Match ' ' atomically any number of times.<br/>
|
||
○ Match the string "BEGIN ".<br/>
|
||
○ "keyName" capture group.<br/>
|
||
○ Match a word character greedily at least once.<br/>
|
||
○ Loop greedily any number of times.<br/>
|
||
○ Match ' '.<br/>
|
||
○ Match a word character atomically at least once.<br/>
|
||
○ Match ' ' atomically any number of times.<br/>
|
||
○ Match '-' atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ Match with 2 alternative expressions.<br/>
|
||
○ Match a sequence of expressions.<br/>
|
||
○ Match the string "Proc-Type: 4,ENCRYPTED".<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nDEK-Info: ".<br/>
|
||
○ "cipherName" capture group.<br/>
|
||
○ Match a character in the set [-0-9A-Z] atomically at least once.<br/>
|
||
○ Match ','.<br/>
|
||
○ "salt" capture group.<br/>
|
||
○ Match a character in the set [0-9A-Fa-f] atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Match a sequence of expressions.<br/>
|
||
○ Match the string "Comment: ".<br/>
|
||
○ Match '"' greedily, optionally.<br/>
|
||
○ Match a character in the set [^\n\r] greedily any number of times.<br/>
|
||
○ Match '"' atomically, optionally.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ "data" capture group.<br/>
|
||
○ Loop greedily at least once.<br/>
|
||
○ Match a character in the set [+/-9=A-Za-z] atomically at least 1 and at most 80 times.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Match '-' atomically at least once.<br/>
|
||
○ Match ' ' atomically any number of times.<br/>
|
||
○ Match the string "END ".<br/>
|
||
○ Match the same text as matched by the "keyName" capture group.<br/>
|
||
○ Match ' ' atomically any number of times.<br/>
|
||
○ Match '-' atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.GetPrivateKeyPuTTYRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>^(?<keyName>PuTTY-User-Key-File)-(?<version>\\d+): (?<algorithmName>[\\w-]+)\\r?\\nEncryption: (?<encryptionType>[\\w-]+)\\r?\\nComment: (?<comment>.*?)\\r?\\nPublic-Lines: \\d+\\r?\\n(?<publicKey>(([a-zA-Z0-9/+=]{1,64})\\r?\\n)+)(Key-Derivation: (?<argon2Type>\\w+)\\r?\\nArgon2-Memory: (?<argon2Memory>\\d+)\\r?\\nArgon2-Passes: (?<argon2Passes>\\d+)\\r?\\nArgon2-Parallelism: (?<argon2Parallelism>\\d+)\\r?\\nArgon2-Salt: (?<argon2Salt>[a-fA-F0-9]+)\\r?\\n)?Private-Lines: \\d+\\r?\\n(?<data>(([a-zA-Z0-9/+=]{1,64})\\r?\\n)+)+Private-MAC: (?<mac>[a-fA-F0-9]+)</code><br/>
|
||
Options:<br/>
|
||
<code>RegexOptions.Multiline | RegexOptions.ExplicitCapture</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match if at the beginning of a line.<br/>
|
||
○ "keyName" capture group.<br/>
|
||
○ Match the string "PuTTY-User-Key-File".<br/>
|
||
○ Match '-'.<br/>
|
||
○ "version" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match the string ": ".<br/>
|
||
○ "algorithmName" capture group.<br/>
|
||
○ Match a character in the set [-\w] atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nEncryption: ".<br/>
|
||
○ "encryptionType" capture group.<br/>
|
||
○ Match a character in the set [-\w] atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nComment: ".<br/>
|
||
○ "comment" capture group.<br/>
|
||
○ Match a character other than '\n' lazily any number of times.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nPublic-Lines: ".<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ "publicKey" capture group.<br/>
|
||
○ Loop greedily at least once.<br/>
|
||
○ Match a character in the set [+/-9=A-Za-z] atomically at least 1 and at most 64 times.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ Match the string "Key-Derivation: ".<br/>
|
||
○ "argon2Type" capture group.<br/>
|
||
○ Match a word character atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nArgon2-Memory: ".<br/>
|
||
○ "argon2Memory" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nArgon2-Passes: ".<br/>
|
||
○ "argon2Passes" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nArgon2-Parallelism: ".<br/>
|
||
○ "argon2Parallelism" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match the string "\nArgon2-Salt: ".<br/>
|
||
○ "argon2Salt" capture group.<br/>
|
||
○ Match a character in the set [0-9A-Fa-f] atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Match the string "Private-Lines: ".<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Loop greedily at least once.<br/>
|
||
○ "data" capture group.<br/>
|
||
○ Loop greedily at least once.<br/>
|
||
○ Match a character in the set [+/-9=A-Za-z] atomically at least 1 and at most 64 times.<br/>
|
||
○ Match '\r' atomically, optionally.<br/>
|
||
○ Match '\n'.<br/>
|
||
○ Match the string "Private-MAC: ".<br/>
|
||
○ "mac" capture group.<br/>
|
||
○ Match a character in the set [0-9A-Fa-f] atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.GetCertificateRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>(?<type>[-\\w]+@openssh\\.com)\\s(?<data>[a-zA-Z0-9\\/+=]*)(\\s+(?<comment>.*))?</code><br/>
|
||
Options:<br/>
|
||
<code>RegexOptions.ExplicitCapture</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ "type" capture group.<br/>
|
||
○ Match a character in the set [-\w] atomically at least once.<br/>
|
||
○ Match the string "@openssh.com".<br/>
|
||
○ Match a whitespace character.<br/>
|
||
○ "data" capture group.<br/>
|
||
○ Match a character in the set [+/-9=A-Za-z] greedily any number of times.<br/>
|
||
○ Optional (greedy).<br/>
|
||
○ Match a whitespace character greedily at least once.<br/>
|
||
○ "comment" capture group.<br/>
|
||
○ Match a character other than '\n' atomically any number of times.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyFile.HostKeyAlgorithms">
|
||
<summary>
|
||
Gets the supported host algorithms for this key file.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyFile.Key">
|
||
<summary>
|
||
Gets the key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.PrivateKeyFile.Certificate">
|
||
<summary>
|
||
Gets the public key certificate associated with this key,
|
||
or <see langword="null"/> if no certificate data
|
||
has been passed to the constructor.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(Renci.SshNet.Security.Key)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.IO.Stream)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="privateKey">The private key.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="fileName">The path of the private key file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="fileName"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
This method calls <see cref="M:System.IO.File.Open(System.String,System.IO.FileMode)"/> internally, this method does not catch exceptions from <see cref="M:System.IO.File.Open(System.String,System.IO.FileMode)"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="fileName">The path of the private key file.</param>
|
||
<param name="passPhrase">The pass phrase for the private key.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="fileName"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
This method calls <see cref="M:System.IO.File.Open(System.String,System.IO.FileMode)"/> internally, this method does not catch exceptions from <see cref="M:System.IO.File.Open(System.String,System.IO.FileMode)"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="fileName">The path of the private key file.</param>
|
||
<param name="passPhrase">The pass phrase for the private key.</param>
|
||
<param name="certificateFileName">The path of a certificate file which certifies the private key.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="fileName"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.IO.Stream,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="privateKey">The private key.</param>
|
||
<param name="passPhrase">The pass phrase.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="privateKey"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.#ctor(System.IO.Stream,System.String,System.IO.Stream)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.PrivateKeyFile"/> class.
|
||
</summary>
|
||
<param name="privateKey">The private key.</param>
|
||
<param name="passPhrase">The pass phrase for the private key.</param>
|
||
<param name="certificate">A certificate which certifies the private key.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.Open(System.IO.Stream,System.String)">
|
||
<summary>
|
||
Opens the specified private key.
|
||
</summary>
|
||
<param name="privateKey">The private key.</param>
|
||
<param name="passPhrase">The pass phrase.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.OpenCertificate(System.IO.Stream)">
|
||
<summary>
|
||
Opens the specified certificate.
|
||
</summary>
|
||
<param name="certificate">The certificate.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.PrivateKeyFile.IPrivateKeyParser">
|
||
<summary>
|
||
Represents private key parser.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.IPrivateKeyParser.Parse">
|
||
<summary>
|
||
Parses the private key.
|
||
</summary>
|
||
<returns>The <see cref="P:Renci.SshNet.PrivateKeyFile.Key"/>.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.OpenSSH.Parse">
|
||
<summary>
|
||
Parses an OpenSSH V1 key file according to the key spec:
|
||
<see href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.PKCS1.DecryptKey(Renci.SshNet.CipherInfo,System.Byte[],System.String,System.Byte[])">
|
||
<summary>
|
||
Decrypts encrypted private key file data.
|
||
</summary>
|
||
<param name="cipherInfo">The cipher info.</param>
|
||
<param name="cipherData">Encrypted data.</param>
|
||
<param name="passPhrase">Decryption pass phrase.</param>
|
||
<param name="binarySalt">Decryption binary salt.</param>
|
||
<returns>Decrypted byte array.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="cipherInfo" />, <paramref name="cipherData" />, <paramref name="passPhrase" /> or <paramref name="binarySalt" /> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.PKCS8.Parse">
|
||
<summary>
|
||
Parses an OpenSSL PKCS#8 key file according to RFC5208:
|
||
<see href="https://www.rfc-editor.org/rfc/rfc5208#section-5"/>.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Algorithm not supported.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.PrivateKeyFile.PuTTY.Parse">
|
||
<summary>
|
||
Parses an PuTTY PPK key file.
|
||
<see href="https://tartarus.org/~simon/putty-snapshots/htmldoc/AppendixC.html"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ProxyTypes">
|
||
<summary>
|
||
Specifies the type of proxy client will use to connect to server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ProxyTypes.None">
|
||
<summary>
|
||
No proxy server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ProxyTypes.Socks4">
|
||
<summary>
|
||
A SOCKS4 proxy server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ProxyTypes.Socks5">
|
||
<summary>
|
||
A SOCKS5 proxy server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ProxyTypes.Http">
|
||
<summary>
|
||
An HTTP proxy server.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.RemotePathDoubleQuoteTransformation">
|
||
<summary>
|
||
Encloses a path in double quotes, and escapes any embedded double quote with a backslash.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.RemotePathDoubleQuoteTransformation.Transform(System.String)">
|
||
<summary>
|
||
Encloses a path in double quotes, and escapes any embedded double quote with a backslash.
|
||
</summary>
|
||
<param name="path">The path to transform.</param>
|
||
<returns>
|
||
The transformed path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<example>
|
||
<list type="table">
|
||
<listheader>
|
||
<term>Original</term>
|
||
<term>Transformed</term>
|
||
</listheader>
|
||
<item>
|
||
<term>/var/log/auth.log</term>
|
||
<term>"/var/log/auth.log"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/mp3/Guns N' Roses</term>
|
||
<term>"/var/mp3/Guns N' Roses"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/garbage!/temp</term>
|
||
<term>"/var/garbage!/temp"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/would be 'kewl'!/not?</term>
|
||
<term>"/var/would be 'kewl'!, not?"</term>
|
||
</item>
|
||
<item>
|
||
<term></term>
|
||
<term>""</term>
|
||
</item>
|
||
<item>
|
||
<term>Hello "World"</term>
|
||
<term>"Hello \"World"</term>
|
||
</item>
|
||
</list>
|
||
</example>
|
||
</member>
|
||
<member name="T:Renci.SshNet.RemotePathNoneTransformation">
|
||
<summary>
|
||
Performs no transformation.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.RemotePathNoneTransformation.Transform(System.String)">
|
||
<summary>
|
||
Returns the specified path without applying a transformation.
|
||
</summary>
|
||
<param name="path">The path to transform.</param>
|
||
<returns>
|
||
The specified path as is.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
This transformation is recommended for servers that do not require any quoting to preserve the
|
||
literal value of metacharacters, or when paths are guaranteed to never contain any such characters.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.RemotePathShellQuoteTransformation">
|
||
<summary>
|
||
Quotes a path in a way to be suitable to be used with a shell-based server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.RemotePathShellQuoteTransformation.Transform(System.String)">
|
||
<summary>
|
||
Quotes a path in a way to be suitable to be used with a shell-based server.
|
||
</summary>
|
||
<param name="path">The path to transform.</param>
|
||
<returns>
|
||
A quoted path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
<para>
|
||
If <paramref name="path"/> contains a single-quote, that character is embedded
|
||
in quotation marks (eg. "'"). Sequences of single-quotes are grouped in a single
|
||
pair of quotation marks.
|
||
</para>
|
||
<para>
|
||
An exclamation mark in <paramref name="path"/> is escaped with a backslash. This is
|
||
necessary because C Shell interprets it as a meta-character for history substitution
|
||
even when enclosed in single quotes or quotation marks.
|
||
</para>
|
||
<para>
|
||
All other characters are enclosed in single quotes. Sequences of such characters are grouped
|
||
in a single pair of single quotes.
|
||
</para>
|
||
<para>
|
||
References:
|
||
<list type="bullet">
|
||
<item>
|
||
<description><a href="http://pubs.opengroup.org/onlinepubs/7908799/xcu/chap2.html">Shell Command Language</a></description>
|
||
</item>
|
||
<item>
|
||
<description><a href="https://earthsci.stanford.edu/computing/unix/shell/specialchars.php">Unix C-Shell special characters and their uses</a></description>
|
||
</item>
|
||
<item>
|
||
<description><a href="https://docstore.mik.ua/orelly/unix3/upt/ch27_13.htm">Differences Between Bourne and C Shell Quoting</a></description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
</remarks>
|
||
<example>
|
||
<list type="table">
|
||
<listheader>
|
||
<term>Original</term>
|
||
<term>Transformed</term>
|
||
</listheader>
|
||
<item>
|
||
<term>/var/log/auth.log</term>
|
||
<term>'/var/log/auth.log'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/mp3/Guns N' Roses</term>
|
||
<term>'/var/mp3/Guns N'"'"' Roses'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/garbage!/temp</term>
|
||
<term>'/var/garbage'\!'/temp'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/would be 'kewl'!, not?</term>
|
||
<term>'/var/would be '"'"'kewl'"'"\!', not?'</term>
|
||
</item>
|
||
<item>
|
||
<term></term>
|
||
<term>''</term>
|
||
</item>
|
||
<item>
|
||
<term>Hello "World"</term>
|
||
<term>'Hello "World"'</term>
|
||
</item>
|
||
</list>
|
||
</example>
|
||
</member>
|
||
<member name="T:Renci.SshNet.RemotePathTransformation">
|
||
<summary>
|
||
Provides access to built-in remote path transformations.
|
||
</summary>
|
||
<remarks>
|
||
References:
|
||
<list type="bullet">
|
||
<item>
|
||
<description><a href="http://pubs.opengroup.org/onlinepubs/7908799/xcu/chap2.html">Shell Command Language</a></description>
|
||
</item>
|
||
<item>
|
||
<description><a href="https://earthsci.stanford.edu/computing/unix/shell/specialchars.php">Unix C-Shell special characters and their uses</a></description>
|
||
</item>
|
||
<item>
|
||
<description><a href="https://docstore.mik.ua/orelly/unix3/upt/ch27_13.htm">Differences Between Bourne and C Shell Quoting</a></description>
|
||
</item>
|
||
<item>
|
||
<description><a href="https://blogs.msdn.microsoft.com/twistylittlepassagesallalike/2011/04/23/everyone-quotes-command-line-arguments-the-wrong-way/">Everyone quotes command line arguments the wrong way</a></description>
|
||
</item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.RemotePathTransformation.ShellQuote">
|
||
<summary>
|
||
Gets a <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that quotes a path in a way to be suitable to be used with a shell-based server.
|
||
</summary>
|
||
<returns>
|
||
A quoted path.
|
||
</returns>
|
||
<remarks>
|
||
<para>
|
||
If a path contains a single-quote, that character is embedded in quotation marks (eg. "'").
|
||
Sequences of single-quotes are grouped in a single pair of quotation marks.
|
||
</para>
|
||
<para>
|
||
An exclamation mark in a path is escaped with a backslash. This is necessary because C Shell
|
||
interprets it as a meta-character for history substitution even when enclosed in single quotes
|
||
or quotation marks.
|
||
</para>
|
||
<para>
|
||
All other characters are enclosed in single quotes. Sequences of such characters are grouped
|
||
in a single pair of single quotes.
|
||
</para>
|
||
</remarks>
|
||
<example>
|
||
<list type="table">
|
||
<listheader>
|
||
<term>Original</term>
|
||
<term>Transformed</term>
|
||
</listheader>
|
||
<item>
|
||
<term>/var/log/auth.log</term>
|
||
<term>'/var/log/auth.log'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/mp3/Guns N' Roses</term>
|
||
<term>'/var/mp3/Guns N'"'"' Roses'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/garbage!/temp</term>
|
||
<term>'/var/garbage'\!'/temp'</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/would be 'kewl'!, not?</term>
|
||
<term>'/var/would be '"'"'kewl'"'"\!', not?'</term>
|
||
</item>
|
||
<item>
|
||
<term></term>
|
||
<term>''</term>
|
||
</item>
|
||
<item>
|
||
<term>Hello "World"</term>
|
||
<term>'Hello "World"'</term>
|
||
</item>
|
||
</list>
|
||
</example>
|
||
</member>
|
||
<member name="P:Renci.SshNet.RemotePathTransformation.None">
|
||
<summary>
|
||
Gets a <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that performs no transformation.
|
||
</summary>
|
||
<remarks>
|
||
Recommended for servers that do not require any character to be escaped or enclosed in quotes,
|
||
or when paths are guaranteed to never contain any special characters (such as #, ", ', $, ...).
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.RemotePathTransformation.DoubleQuote">
|
||
<summary>
|
||
Gets a <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that encloses a path in double quotes, and escapes any embedded double quote with a backslash.
|
||
</summary>
|
||
<value>
|
||
A transformation that encloses a path in double quotes, and escapes any embedded double quote with
|
||
a backslash.
|
||
</value>
|
||
<example>
|
||
<list type="table">
|
||
<listheader>
|
||
<term>Original</term>
|
||
<term>Transformed</term>
|
||
</listheader>
|
||
<item>
|
||
<term>/var/log/auth.log</term>
|
||
<term>"/var/log/auth.log"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/mp3/Guns N' Roses</term>
|
||
<term>"/var/mp3/Guns N' Roses"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/garbage!/temp</term>
|
||
<term>"/var/garbage!/temp"</term>
|
||
</item>
|
||
<item>
|
||
<term>/var/would be 'kewl'!, not?</term>
|
||
<term>"/var/would be 'kewl'!, not?"</term>
|
||
</item>
|
||
<item>
|
||
<term></term>
|
||
<term>""</term>
|
||
</item>
|
||
<item>
|
||
<term>Hello "World"</term>
|
||
<term>"Hello \"World"</term>
|
||
</item>
|
||
</list>
|
||
</example>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ScpClient">
|
||
<summary>
|
||
Provides SCP client functionality.
|
||
</summary>
|
||
<remarks>
|
||
<para>
|
||
More information on the SCP protocol is available here: https://github.com/net-ssh/net-scp/blob/master/lib/net/scp.rb.
|
||
</para>
|
||
<para>
|
||
Known issues in OpenSSH:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>Recursive download (-prf) does not deal well with specific UTF-8 and newline characters.</description>
|
||
<description>Recursive update does not support empty path for uploading to home directory.</description>
|
||
</item>
|
||
</list>
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.GetFileInfoRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>C(?<mode>\\d{4}) (?<length>\\d+) (?<filename>.+)</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match 'C'.<br/>
|
||
○ "mode" capture group.<br/>
|
||
○ Match a Unicode digit exactly 4 times.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "length" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "filename" capture group.<br/>
|
||
○ Match a character other than '\n' atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.GetDirectoryInfoRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>D(?<mode>\\d{4}) (?<length>\\d+) (?<filename>.+)</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match 'D'.<br/>
|
||
○ "mode" capture group.<br/>
|
||
○ Match a Unicode digit exactly 4 times.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "length" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match ' '.<br/>
|
||
○ "filename" capture group.<br/>
|
||
○ Match a character other than '\n' atomically at least once.<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.GetTimestampRegex">
|
||
<remarks>
|
||
Pattern:<br/>
|
||
<code>T(?<mtime>\\d+) 0 (?<atime>\\d+) 0</code><br/>
|
||
Explanation:<br/>
|
||
<code>
|
||
○ Match 'T'.<br/>
|
||
○ "mtime" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match the string " 0 ".<br/>
|
||
○ "atime" capture group.<br/>
|
||
○ Match a Unicode digit atomically at least once.<br/>
|
||
○ Match the string " 0".<br/>
|
||
</code>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ScpClient.OperationTimeout">
|
||
<summary>
|
||
Gets or sets the operation timeout.
|
||
</summary>
|
||
<value>
|
||
The timeout to wait until an operation completes. The default value is negative
|
||
one (-1) milliseconds, which indicates an infinite time-out period.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ScpClient.BufferSize">
|
||
<summary>
|
||
Gets or sets the size of the buffer.
|
||
</summary>
|
||
<value>
|
||
The size of the buffer. The default buffer size is 16384 bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ScpClient.RemotePathTransformation">
|
||
<summary>
|
||
Gets or sets the transformation to apply to remote paths.
|
||
</summary>
|
||
<value>
|
||
The transformation to apply to remote paths. The default is <see cref="P:Renci.SshNet.RemotePathTransformation.DoubleQuote"/>.
|
||
</value>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
<para>
|
||
This transformation is applied to the remote file or directory path that is passed to the
|
||
<c>scp</c> command.
|
||
</para>
|
||
<para>
|
||
See <see cref="T:Renci.SshNet.RemotePathTransformation"/> for the transformations that are supplied
|
||
out-of-the-box with SSH.NET.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ScpClient.Downloading">
|
||
<summary>
|
||
Occurs when downloading file.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ScpClient.Uploading">
|
||
<summary>
|
||
Occurs when uploading file.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(Renci.SshNet.ConnectionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ScpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Upload(System.IO.Stream,System.String)">
|
||
<summary>
|
||
Uploads the specified stream to the remote host.
|
||
</summary>
|
||
<param name="source">The <see cref="T:System.IO.Stream"/> to upload.</param>
|
||
<param name="path">A relative or absolute path for the remote file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length <see cref="T:System.String"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException">A directory with the specified path exists on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Upload(System.IO.FileInfo,System.String)">
|
||
<summary>
|
||
Uploads the specified file to the remote host.
|
||
</summary>
|
||
<param name="fileInfo">The file system info.</param>
|
||
<param name="path">A relative or absolute path for the remote file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="fileInfo" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length <see cref="T:System.String"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException">A directory with the specified path exists on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Upload(System.IO.DirectoryInfo,System.String)">
|
||
<summary>
|
||
Uploads the specified directory to the remote host.
|
||
</summary>
|
||
<param name="directoryInfo">The directory info.</param>
|
||
<param name="path">A relative or absolute path for the remote directory.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="directoryInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException"><paramref name="path"/> does not exist on the remote host, is not a directory or the user does not have the required permission.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Download(System.String,System.IO.FileInfo)">
|
||
<summary>
|
||
Downloads the specified file from the remote host to local file.
|
||
</summary>
|
||
<param name="filename">Remote host file name.</param>
|
||
<param name="fileInfo">Local file information.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="fileInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="filename"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException"><paramref name="filename"/> exists on the remote host, and is not a regular file.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Download(System.String,System.IO.DirectoryInfo)">
|
||
<summary>
|
||
Downloads the specified directory from the remote host to local directory.
|
||
</summary>
|
||
<param name="directoryName">Remote host directory name.</param>
|
||
<param name="directoryInfo">Local directory information.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="directoryName"/> is <see langword="null"/> or empty.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="directoryInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException">File or directory with the specified path does not exist on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.Download(System.String,System.IO.Stream)">
|
||
<summary>
|
||
Downloads the specified file from the remote host to the stream.
|
||
</summary>
|
||
<param name="filename">A relative or absolute path for the remote file.</param>
|
||
<param name="destination">The <see cref="T:System.IO.Stream"/> to download the remote file to.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="filename"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ScpException"><paramref name="filename"/> exists on the remote host, and is not a regular file.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The secure copy execution request was rejected by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.UploadFileModeAndName(Renci.SshNet.Channels.IChannelSession,System.IO.Stream,System.Int64,System.String)">
|
||
<summary>
|
||
Sets mode, size and name of file being upload.
|
||
</summary>
|
||
<param name="channel">The channel to perform the upload in.</param>
|
||
<param name="input">A <see cref="T:System.IO.Stream"/> from which any feedback from the server can be read.</param>
|
||
<param name="fileSize">The size of the content to upload.</param>
|
||
<param name="serverFileName">The name of the file, without path, to which the content is to be uploaded.</param>
|
||
<remarks>
|
||
<para>
|
||
When the SCP transfer is already initiated for a file, a zero-length <see cref="T:System.String"/> should
|
||
be specified for <paramref name="serverFileName"/>. This prevents the server from uploading the
|
||
content to a file with path <c><file path>/<paramref name="serverFileName"/></c> if there's
|
||
already a directory with this path, and allows us to receive an error response.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.UploadFileContent(Renci.SshNet.Channels.IChannelSession,System.IO.Stream,System.IO.Stream,System.String)">
|
||
<summary>
|
||
Uploads the content of a file.
|
||
</summary>
|
||
<param name="channel">The channel to perform the upload in.</param>
|
||
<param name="input">A <see cref="T:System.IO.Stream"/> from which any feedback from the server can be read.</param>
|
||
<param name="source">The content to upload.</param>
|
||
<param name="remoteFileName">The name of the remote file, without path, to which the content is uploaded.</param>
|
||
<remarks>
|
||
<paramref name="remoteFileName"/> is only used for raising the <see cref="E:Renci.SshNet.ScpClient.Uploading"/> event.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.CheckReturnCode(System.IO.Stream)">
|
||
<summary>
|
||
Checks the return code.
|
||
</summary>
|
||
<param name="input">The output stream.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.ReadString(System.IO.Stream)">
|
||
<summary>
|
||
Read a LF-terminated string from the <see cref="T:System.IO.Stream"/>.
|
||
</summary>
|
||
<param name="stream">The <see cref="T:System.IO.Stream"/> to read from.</param>
|
||
<returns>
|
||
The string without trailing LF.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.UploadTimes(Renci.SshNet.Channels.IChannelSession,System.IO.Stream,System.IO.FileSystemInfo)">
|
||
<summary>
|
||
Uploads the <see cref="P:System.IO.FileSystemInfo.LastWriteTimeUtc"/> and <see cref="P:System.IO.FileSystemInfo.LastAccessTimeUtc"/>
|
||
of the next file or directory to upload.
|
||
</summary>
|
||
<param name="channel">The channel to perform the upload in.</param>
|
||
<param name="input">A <see cref="T:System.IO.Stream"/> from which any feedback from the server can be read.</param>
|
||
<param name="fileOrDirectory">The file or directory to upload.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.UploadDirectoryContent(Renci.SshNet.Channels.IChannelSession,System.IO.Stream,System.IO.DirectoryInfo)">
|
||
<summary>
|
||
Upload the files and subdirectories in the specified directory.
|
||
</summary>
|
||
<param name="channel">The channel to perform the upload in.</param>
|
||
<param name="input">A <see cref="T:System.IO.Stream"/> from which any feedback from the server can be read.</param>
|
||
<param name="directoryInfo">The directory to upload.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ScpClient.UploadDirectoryModeAndName(Renci.SshNet.Channels.IChannelSession,System.IO.Stream,System.String)">
|
||
<summary>
|
||
Sets mode and name of the directory being upload.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Algorithm">
|
||
<summary>
|
||
Represents the abstract base class from which all implementations of algorithms must inherit.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Algorithm.Name">
|
||
<summary>
|
||
Gets the algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Certificate">
|
||
<summary>
|
||
Represents an OpenSSH certificate as described in
|
||
https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Name">
|
||
<summary>
|
||
The type identifier of the certificate.
|
||
</summary>
|
||
<remarks>
|
||
The value is one of the following:
|
||
<list type="bullet">
|
||
<item>ssh-rsa-cert-v01@openssh.com</item>
|
||
<item>ecdsa-sha2-nistp256-cert-v01@openssh.com</item>
|
||
<item>ecdsa-sha2-nistp384-cert-v01@openssh.com</item>
|
||
<item>ecdsa-sha2-nistp521-cert-v01@openssh.com</item>
|
||
<item>ssh-ed25519-cert-v01@openssh.com</item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Nonce">
|
||
<summary>
|
||
A CA-provided random bitstring of arbitrary length
|
||
(but typically 16 or 32 bytes) included to make attacks that depend on
|
||
inducing collisions in the signature hash infeasible.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Key">
|
||
<summary>
|
||
The public key that has been certified by the certificate authority.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Serial">
|
||
<summary>
|
||
An optional certificate serial number set by the CA to
|
||
provide an abbreviated way to refer to certificates from that CA.
|
||
If a CA does not wish to number its certificates, it must set this
|
||
field to zero.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Type">
|
||
<summary>
|
||
Specifies whether this certificate is for identification of a user
|
||
or a host.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.KeyId">
|
||
<summary>
|
||
A free-form text field that is filled in by the CA at the time
|
||
of signing; the intention is that the contents of this field are used to
|
||
identify the identity principal in log messages.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.ValidPrincipals">
|
||
<summary>
|
||
The names for which this certificate is valid;
|
||
hostnames for SSH_CERT_TYPE_HOST certificates and
|
||
usernames for SSH_CERT_TYPE_USER certificates. As a special case, a
|
||
zero-length "valid principals" field means the certificate is valid for
|
||
any principal of the specified type.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.ValidAfterUnixSeconds">
|
||
<summary>
|
||
The beginning of the validity period of the certificate, as the number
|
||
of seconds elapsed since 1970-01-01T00:00:00Z.
|
||
</summary>
|
||
<seealso cref="P:Renci.SshNet.Security.Certificate.ValidAfter"/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.ValidAfter">
|
||
<summary>
|
||
The beginning of the validity period of the certificate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.ValidBeforeUnixSeconds">
|
||
<summary>
|
||
The end of the validity period of the certificate, as the number
|
||
of seconds elapsed since 1970-01-01T00:00:00Z.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.ValidBefore">
|
||
<summary>
|
||
The end of the validity period of the certificate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.CriticalOptions">
|
||
<summary>
|
||
A set of zero or more options on the certificate's validity.
|
||
The key identifies the option and the value encodes
|
||
option-specific information.
|
||
All such options are "critical" in the sense that an implementation
|
||
must refuse to authorize a key that has an unrecognised option.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Extensions">
|
||
<summary>
|
||
A set of zero or more optional extensions. These extensions
|
||
are not critical, and an implementation that encounters one that it does
|
||
not recognise may safely ignore it.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.CertificateAuthorityKey">
|
||
<summary>
|
||
The CA key used to sign the certificate.
|
||
The valid key types for CA keys are ssh-rsa,
|
||
ssh-ed25519 and the ECDSA types ecdsa-sha2-nistp256,
|
||
ecdsa-sha2-nistp384, ecdsa-sha2-nistp521. "Chained" certificates, where
|
||
the signature key type is a certificate type itself are NOT supported.
|
||
Note that it is possible for a RSA certificate key to be signed by a
|
||
Ed25519 or ECDSA CA key and vice-versa.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.CertificateAuthorityKeyFingerPrint">
|
||
<summary>
|
||
Gets the SHA256 fingerprint of the certificate authority key in the same format
|
||
as the ssh command, i.e. non-padded base64, but without the <c>SHA256:</c> prefix.
|
||
</summary>
|
||
<example><c>ohD8VZEXGWo6Ez8GSEJQ9WpafgLFsOfLOtGGQCQo6Og</c>.</example>
|
||
<value>
|
||
Base64 encoded SHA256 fingerprint with padding (equals sign) removed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Signature">
|
||
<summary>
|
||
The signature computed over all preceding fields from the initial string
|
||
up to, and including the signature key. Signatures are computed and
|
||
encoded according to the rules defined for the CA's public key algorithm
|
||
(RFC4253 section 6.6 for ssh-rsa and ssh-dss, RFC5656 for the ECDSA
|
||
types, and RFC8032 for Ed25519).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.Bytes">
|
||
<summary>
|
||
The encoded certificate bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.BytesForSignature">
|
||
<summary>
|
||
The encoded bytes of the certificate which are used
|
||
to calculate <see cref="P:Renci.SshNet.Security.Certificate.Signature"/>.
|
||
This consists of all of the fields before (i.e. except from)
|
||
<see cref="P:Renci.SshNet.Security.Certificate.Signature"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Certificate.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Certificate"/>
|
||
class based on the data encoded in <paramref name="data"/>.
|
||
</summary>
|
||
<param name="data">The encoded public-key certificate data.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Certificate.CertificateData.ByteCountBeforeSignature">
|
||
<summary>
|
||
Returns the number of bytes in the encoded certificate data
|
||
up to and including <see cref="P:Renci.SshNet.Security.Certificate.CertificateData.SignatureKey"/>.
|
||
Used for verifying <see cref="P:Renci.SshNet.Security.Certificate.CertificateData.Signature"/> which is calculated
|
||
from those bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Certificate.CertificateType">
|
||
<summary>
|
||
Used to specify whether a certificate is for identification of a user
|
||
or a host.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Certificate.CertificateType.User">
|
||
<summary>
|
||
The certificate is for identification of a user (SSH_CERT_TYPE_USER).
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Certificate.CertificateType.Host">
|
||
<summary>
|
||
The certificate is for identification of a host (SSH_CERT_TYPE_HOST).
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.CertificateHostAlgorithm">
|
||
<summary>
|
||
Implements certificate support for host algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.CertificateHostAlgorithm._keyAlgorithms">
|
||
<summary>
|
||
The <see cref="T:Renci.SshNet.Security.KeyHostAlgorithm"/> factories which may be used in order to verify
|
||
the signature within the certificate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.CertificateHostAlgorithm.Certificate">
|
||
<summary>
|
||
Gets certificate used in this host key algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.CertificateHostAlgorithm.KeyData">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.CertificateHostAlgorithm.Data">
|
||
<summary>
|
||
Gets the encoded bytes of the certificate.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Key,Renci.SshNet.Security.Certificate)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.CertificateHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The algorithm identifier.</param>
|
||
<param name="privateKey">The private key used for this host algorithm.</param>
|
||
<param name="certificate">The certificate which certifies <paramref name="privateKey"/>.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Key,Renci.SshNet.Security.Certificate,Renci.SshNet.Security.Cryptography.DigitalSignature)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.CertificateHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The algorithm identifier.</param>
|
||
<param name="privateKey">The private key used for this host algorithm.</param>
|
||
<param name="certificate">The certificate which certifies <paramref name="privateKey"/>.</param>
|
||
<param name="digitalSignature"><inheritdoc cref="P:Renci.SshNet.Security.KeyHostAlgorithm.DigitalSignature" path="/summary"/></param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Certificate,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Func{System.Byte[],Renci.SshNet.Security.KeyHostAlgorithm}})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.CertificateHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The algorithm identifier.</param>
|
||
<param name="certificate">The certificate.</param>
|
||
<param name="keyAlgorithms"><inheritdoc cref="F:Renci.SshNet.Security.CertificateHostAlgorithm._keyAlgorithms" path="/summary"/></param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Certificate,Renci.SshNet.Security.Cryptography.DigitalSignature,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Func{System.Byte[],Renci.SshNet.Security.KeyHostAlgorithm}})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.CertificateHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The algorithm identifier.</param>
|
||
<param name="certificate">The certificate.</param>
|
||
<param name="digitalSignature"><inheritdoc cref="P:Renci.SshNet.Security.KeyHostAlgorithm.DigitalSignature" path="/summary"/></param>
|
||
<param name="keyAlgorithms"><inheritdoc cref="F:Renci.SshNet.Security.CertificateHostAlgorithm._keyAlgorithms" path="/summary"/></param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.Sign(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.CertificateHostAlgorithm.VerifySignatureBlob(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="data">The data to verify the signature against.</param>
|
||
<param name="signatureBlob">The signature blob in format specific encoding.</param>
|
||
<returns>
|
||
<see langword="true"/> if <paramref name="signatureBlob"/> is the result of signing
|
||
<paramref name="data"/> with the corresponding private key to <see cref="P:Renci.SshNet.Security.CertificateHostAlgorithm.Certificate"/>,
|
||
and <see cref="P:Renci.SshNet.Security.CertificateHostAlgorithm.Certificate"/> is valid with respect to its validity period and to its
|
||
signature therein as signed by the certificate authority.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.BCrypt">
|
||
<summary>
|
||
BCrypt Pbkdf implementation.
|
||
This was originally based on https://github.com/hierynomus/sshj/blob/master/src/main/java/com/hierynomus/sshj/userauth/keyprovider/bcrypt/BCrypt.java .
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.Encipher(System.UInt32[],System.Int32)">
|
||
<summary>Blowfish encipher a single 64-bit block encoded as two 32-bit halves.</summary>
|
||
<param name="blockArray">An array containing the two 32-bit half blocks.</param>
|
||
<param name="offset"> The position in the array of the blocks.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.StreamToWord(System.Byte[],System.Int32@)">
|
||
<summary>Cycically extract a word of key material.</summary>
|
||
<param name="data">The string to extract the data from.</param>
|
||
<param name="offset"> [in,out] The current offset.</param>
|
||
<returns>The next word of material from data.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.InitializeKey">
|
||
<summary>Initializes the Blowfish key schedule.</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.Key(System.Byte[])">
|
||
<summary>Key the Blowfish cipher.</summary>
|
||
<param name="keyBytes">The key byte array.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.EKSKey(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Perform the "enhanced key schedule" step described by Provos and Mazieres in "A Future-
|
||
Adaptable Password Scheme" http://www.openbsd.org/papers/bcrypt-paper.ps.
|
||
</summary>
|
||
<param name="saltBytes"> Salt byte array.</param>
|
||
<param name="inputBytes">Input byte array.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.Hash(System.Byte[],System.Byte[],System.Byte[])">
|
||
Compatibility with new OpenBSD function.
|
||
Ported from SSHJ library (https://github.com/hierynomus/sshj)
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.Pbkdf(System.Byte[],System.Byte[],System.Int32,System.Byte[])">
|
||
<summary>
|
||
Applies the Bcrypt kdf to derive a key and iv from the passphrase,
|
||
the key/iv are returned in the output variable.
|
||
Ported from the SSHJ library. https://github.com/hierynomus/sshj
|
||
</summary>
|
||
<param name="password"></param>
|
||
<param name="salt"></param>
|
||
<param name="rounds"></param>
|
||
<param name="output"></param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BCrypt.AppendArrays(System.Byte[],System.Byte[][])">
|
||
<summary>
|
||
Appends multiple byte arrays into one array.
|
||
</summary>
|
||
<param name="b1"></param>
|
||
<param name="others"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.BlockCipher">
|
||
<summary>
|
||
Base class for block cipher implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.BlockCipher._blockSize">
|
||
<summary>
|
||
Gets the size of the block in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the block in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.BlockCipher.MinimumSize">
|
||
<summary>
|
||
Gets the minimum data size.
|
||
</summary>
|
||
<value>
|
||
The minimum data size.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.BlockCipher.BlockSize">
|
||
<summary>
|
||
Gets the size of the block.
|
||
</summary>
|
||
<value>
|
||
The size of the block.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BlockCipher.#ctor(System.Byte[],System.Byte,Renci.SshNet.Security.Cryptography.Ciphers.CipherMode,Org.BouncyCastle.Crypto.Paddings.IBlockCipherPadding)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.BlockCipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="blockSize">Size of the block.</param>
|
||
<param name="mode">Cipher mode.</param>
|
||
<param name="padding">Cipher padding.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BlockCipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Encrypts the specified data.
|
||
</summary>
|
||
<param name="input">The data.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin encrypting.</param>
|
||
<param name="length">The number of bytes to encrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The encrypted data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BlockCipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decrypts the specified input.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin decrypting.</param>
|
||
<param name="length">The number of bytes to decrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The decrypted data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BlockCipher.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.BlockCipher.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Cipher">
|
||
<summary>
|
||
Base class for cipher implementation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Cipher.MinimumSize">
|
||
<summary>
|
||
Gets the minimum data size.
|
||
</summary>
|
||
<value>
|
||
The minimum data size.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Cipher.TagSize">
|
||
<summary>
|
||
Gets the size of the authentication tag for ciphers which implement Authenticated Encryption (AE).
|
||
</summary>
|
||
<value>
|
||
When this <see cref="T:Renci.SshNet.Security.Cryptography.Cipher"/> implements Authenticated Encryption, the size, in bytes,
|
||
of the authentication tag included in the encrypted message.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Cipher.SetSequenceNumber(System.UInt32)">
|
||
<summary>
|
||
Sets the sequence number.
|
||
</summary>
|
||
<param name="sequenceNumber">The sequence number.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Cipher.Encrypt(System.Byte[])">
|
||
<summary>
|
||
Encrypts the specified input.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<returns>Encrypted data.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Cipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Encrypts the specified input.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin encrypting.</param>
|
||
<param name="length">The number of bytes to encrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The encrypted data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Cipher.Decrypt(System.Byte[])">
|
||
<summary>
|
||
Decrypts the specified input.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<returns>
|
||
The decrypted data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Cipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decrypts the specified input.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin decrypting.</param>
|
||
<param name="length">The number of bytes to decrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The decrypted data.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher">
|
||
<summary>
|
||
AES cipher implementation.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.#ctor(System.Byte[],System.Byte[],Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="iv">The IV.</param>
|
||
<param name="mode">The mode.</param>
|
||
<param name="pkcs7Padding">Enable PKCS7 padding.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException">Keysize is not valid for this algorithm.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesCipher.Dispose">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode">
|
||
<summary>
|
||
Custom AES Cipher Mode, follows System.Security.Cryptography.CipherMode.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.CBC">
|
||
<summary>Cipher Block Chain Mode.</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.ECB">
|
||
<summary>Electronic Codebook Mode.</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.OFB">
|
||
<summary>Output Feedback Mode.</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.CFB">
|
||
<summary>Cipher Feedback Mode.</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.CTS">
|
||
<summary>Cipher Text Stealing Mode.</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.AesCipherMode.CTR">
|
||
<summary>Counter Mode.</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher">
|
||
<summary>
|
||
AES GCM cipher implementation.
|
||
<see href="https://datatracker.ietf.org/doc/html/rfc5647"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.MinimumSize">
|
||
<summary>
|
||
Gets the minimum block size.
|
||
The reader is reminded that SSH requires that the data to be
|
||
encrypted MUST be padded out to a multiple of the block size
|
||
(16-octets for AES-GCM).
|
||
<see href="https://datatracker.ietf.org/doc/html/rfc5647#section-7.1"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.TagSize">
|
||
<summary>
|
||
Gets the tag size in bytes.
|
||
Both AEAD_AES_128_GCM and AEAD_AES_256_GCM produce a 16-octet
|
||
Authentication Tag
|
||
<see href="https://datatracker.ietf.org/doc/html/rfc5647#section-6.3"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.#ctor(System.Byte[],System.Byte[],System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="iv">The IV.</param>
|
||
<param name="aadLength">The length of additional associated data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Encrypts the specified input.
|
||
</summary>
|
||
<param name="input">
|
||
The input data with below format:
|
||
<code>
|
||
[----(offset)][----AAD----][----Plain Text----(length)]
|
||
</code>
|
||
</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin encrypting.</param>
|
||
<param name="length">The number of bytes to encrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The encrypted data with below format:
|
||
<code>
|
||
[----AAD----][----Cipher Text----][----TAG----]
|
||
</code>
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decrypts the specified input.
|
||
</summary>
|
||
<param name="input">
|
||
The input data with below format:
|
||
<code>
|
||
[----][----AAD----(offset)][----Cipher Text----(length)][----TAG----]
|
||
</code>
|
||
</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin decrypting and authenticating.</param>
|
||
<param name="length">The number of bytes to decrypt and authenticate from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The decrypted data with below format:
|
||
<code>
|
||
[----Plain Text----]
|
||
</code>
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.IncrementCounter">
|
||
<summary>
|
||
With AES-GCM, the 12-octet IV is broken into two fields: a 4-octet
|
||
fixed field and an 8 - octet invocation counter field.The invocation
|
||
field is treated as a 64 - bit integer and is incremented after each
|
||
invocation of AES - GCM to process a binary packet.
|
||
<see href="https://datatracker.ietf.org/doc/html/rfc5647#section-7.1"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.Dispose(System.Boolean)">
|
||
<summary>
|
||
Dispose the instance.
|
||
</summary>
|
||
<param name="disposing">Set to True to dispose of resources.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.AesGcmCipher.Dispose">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher">
|
||
<summary>
|
||
ChaCha20Poly1305 cipher implementation.
|
||
<see href="https://datatracker.ietf.org/doc/html/draft-josefsson-ssh-chacha20-poly1305-openssh-00"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.MinimumSize">
|
||
<summary>
|
||
Gets the minimum block size.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.TagSize">
|
||
<summary>
|
||
Gets the tag size in bytes.
|
||
Poly1305 [Poly1305], also by Daniel Bernstein, is a one-time Carter-
|
||
Wegman MAC that computes a 128 bit integrity tag given a message
|
||
<see href="https://datatracker.ietf.org/doc/html/draft-josefsson-ssh-chacha20-poly1305-openssh-00#section-1"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.#ctor(System.Byte[],System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="aadLength">The length of additional associated data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Encrypts the specified input.
|
||
</summary>
|
||
<param name="input">
|
||
The input data with below format:
|
||
<code>
|
||
[----(offset)][----AAD----][----Plain Text----(length)]
|
||
</code>
|
||
</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin encrypting.</param>
|
||
<param name="length">The number of bytes to encrypt from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The encrypted data with below format:
|
||
<code>
|
||
[----Cipher AAD----][----Cipher Text----][----TAG----]
|
||
</code>
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.Decrypt(System.Byte[])">
|
||
<summary>
|
||
Decrypts the AAD.
|
||
</summary>
|
||
<param name="input">The encrypted AAD.</param>
|
||
<returns>The decrypted AAD.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.ChaCha20Poly1305Cipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Decrypts the specified input.
|
||
</summary>
|
||
<param name="input">
|
||
The input data with below format:
|
||
<code>
|
||
[----][----Cipher AAD----(offset)][----Cipher Text----(length)][----TAG----]
|
||
</code>
|
||
</param>
|
||
<param name="offset">The zero-based offset in <paramref name="input"/> at which to begin decrypting and authenticating.</param>
|
||
<param name="length">The number of bytes to decrypt and authenticate from <paramref name="input"/>.</param>
|
||
<returns>
|
||
The decrypted data with below format:
|
||
<code>
|
||
[----Plain Text----]
|
||
</code>
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode">
|
||
<summary>
|
||
Base class for cipher mode implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.Cipher">
|
||
<summary>
|
||
Gets the cipher.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.IV">
|
||
<summary>
|
||
Gets the IV vector.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode._blockSize">
|
||
<summary>
|
||
Holds block size of the cipher.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode"/> class.
|
||
</summary>
|
||
<param name="iv">The iv.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.Init(Renci.SshNet.Security.Cryptography.BlockCipher)">
|
||
<summary>
|
||
Initializes the specified cipher mode.
|
||
</summary>
|
||
<param name="cipher">The cipher.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.CipherMode.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CbcCipherMode">
|
||
<summary>
|
||
Implements CBC cipher mode.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CbcCipherMode.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CbcCipherMode"/> class.
|
||
</summary>
|
||
<param name="iv">The iv.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CbcCipherMode.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CbcCipherMode.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CfbCipherMode">
|
||
<summary>
|
||
Implements CFB cipher mode.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CfbCipherMode.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CfbCipherMode"/> class.
|
||
</summary>
|
||
<param name="iv">The iv.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CfbCipherMode.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CfbCipherMode.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CtrCipherMode">
|
||
<summary>
|
||
Implements CTR cipher mode.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CtrCipherMode.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CtrCipherMode"/> class.
|
||
</summary>
|
||
<param name="iv">The iv.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CtrCipherMode.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.CtrCipherMode.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.OfbCipherMode">
|
||
<summary>
|
||
Implements OFB cipher mode.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.OfbCipherMode.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.Modes.OfbCipherMode"/> class.
|
||
</summary>
|
||
<param name="iv">The iv.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.OfbCipherMode.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to encrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write encrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes encrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.Modes.OfbCipherMode.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<summary>
|
||
Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array.
|
||
</summary>
|
||
<param name="inputBuffer">The input data to decrypt.</param>
|
||
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
|
||
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
|
||
<param name="outputBuffer">The output to which to write decrypted data.</param>
|
||
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
|
||
<returns>
|
||
The number of bytes decrypted.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher">
|
||
<summary>
|
||
Implements 3DES cipher algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.#ctor(System.Byte[],System.Byte[],System.Security.Cryptography.CipherMode,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<param name="iv">The IV.</param>
|
||
<param name="mode">The mode.</param>
|
||
<param name="pkcs7Padding">Enable PKCS7 padding.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.Encrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.Decrypt(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.EncryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.DecryptBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.Ciphers.TripleDesCipher.Dispose">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.DigitalSignature">
|
||
<summary>
|
||
Base class for signature implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.DigitalSignature.Verify(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="signature">The signature.</param>
|
||
<returns>
|
||
<see langword="true"/> if signature was successfully verified; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.DigitalSignature.Sign(System.Byte[])">
|
||
<summary>
|
||
Creates the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<returns>Signed input data.</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature">
|
||
<summary>
|
||
Implements ECDSA digital signature algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature.#ctor(Renci.SshNet.Security.EcdsaKey)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature" /> class.
|
||
</summary>
|
||
<param name="key">The ECDSA key.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature.Verify(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="signature">The signature.</param>
|
||
<returns>
|
||
<see langword="true"/> if signature was successfully verified; otherwise <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature.Sign(System.Byte[])">
|
||
<summary>
|
||
Creates the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<returns>
|
||
Signed input data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.EcdsaDigitalSignature.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature">
|
||
<summary>
|
||
Implements ECDSA digital signature algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature.#ctor(Renci.SshNet.Security.ED25519Key)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature" /> class.
|
||
</summary>
|
||
<param name="key">The ED25519Key key.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature.Verify(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<param name="signature">The signature.</param>
|
||
<returns>
|
||
<see langword="true"/> if signature was successfully verified; otherwise <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Invalid signature.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature.Sign(System.Byte[])">
|
||
<summary>
|
||
Creates the signature.
|
||
</summary>
|
||
<param name="input">The input.</param>
|
||
<returns>
|
||
Signed input data.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Invalid ED25519Key key.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.ED25519DigitalSignature.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.RsaDigitalSignature">
|
||
<summary>
|
||
Implements RSA digital signature algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.#ctor(Renci.SshNet.Security.RsaKey)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.RsaDigitalSignature"/> class with the SHA-1 hash algorithm.
|
||
</summary>
|
||
<param name="rsaKey">The RSA key.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.#ctor(Renci.SshNet.Security.RsaKey,System.Security.Cryptography.HashAlgorithmName)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.RsaDigitalSignature"/> class.
|
||
</summary>
|
||
<param name="rsaKey">The RSA key.</param>
|
||
<param name="hashAlgorithmName">The hash algorithm to use in the digital signature.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.Verify(System.Byte[],System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.Sign(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.RsaDigitalSignature.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Cryptography.SymmetricCipher">
|
||
<summary>
|
||
Base class for symmetric cipher implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Cryptography.SymmetricCipher.Key">
|
||
<summary>
|
||
Gets the key.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Cryptography.SymmetricCipher.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.Cryptography.SymmetricCipher"/> class.
|
||
</summary>
|
||
<param name="key">The key.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="key"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.EcdsaKey">
|
||
<summary>
|
||
Contains ECDSA (ecdsa-sha2-nistp{256,384,521}) private and public key.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.ToString">
|
||
<summary>
|
||
Gets the SSH name of the ECDSA Key.
|
||
</summary>
|
||
<returns>
|
||
The SSH name of the ECDSA Key.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.HashAlgorithm">
|
||
<summary>
|
||
Gets the HashAlgorithm to use.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.KeyLength">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.DigitalSignature">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.Public">
|
||
<summary>
|
||
Gets the ECDSA public key.
|
||
</summary>
|
||
<value>
|
||
An array with the ASCII-encoded curve identifier (e.g. "nistp256")
|
||
at index 0, and the public curve point Q at index 1.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.PrivateKey">
|
||
<summary>
|
||
Gets the PrivateKey Bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.EcdsaKey.Ecdsa">
|
||
<summary>
|
||
Gets the <see cref="T:System.Security.Cryptography.ECDsa"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.#ctor(Renci.SshNet.Security.SshKeyData)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.EcdsaKey"/> class.
|
||
</summary>
|
||
<param name="publicKeyData">The encoded public key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.#ctor(System.String,System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.EcdsaKey"/> class.
|
||
</summary>
|
||
<param name="curve">The curve name or oid.</param>
|
||
<param name="publickey">Value of publickey.</param>
|
||
<param name="privatekey">Value of privatekey.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.EcdsaKey"/> class.
|
||
</summary>
|
||
<param name="data">DER encoded private key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.EcdsaKey.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.ED25519Key">
|
||
<summary>
|
||
Contains ED25519 private and public key.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.ED25519Key.ToString">
|
||
<summary>
|
||
Gets the name of the key.
|
||
</summary>
|
||
<returns>
|
||
The name of the key.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.ED25519Key.Public">
|
||
<summary>
|
||
Gets the Ed25519 public key.
|
||
</summary>
|
||
<value>
|
||
An array with <see cref="P:Renci.SshNet.Security.ED25519Key.PublicKey"/> encoded at index 0.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.ED25519Key.KeyLength">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.ED25519Key.DigitalSignature">
|
||
<summary>
|
||
Gets the digital signature.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.ED25519Key.PublicKey">
|
||
<summary>
|
||
Gets the PublicKey Bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.ED25519Key.PrivateKey">
|
||
<summary>
|
||
Gets the PrivateKey Bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.ED25519Key.#ctor(Renci.SshNet.Security.SshKeyData)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.ED25519Key"/> class.
|
||
</summary>
|
||
<param name="publicKeyData">The encoded public key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.ED25519Key.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.ED25519Key"/> class.
|
||
</summary>
|
||
<param name="privateKeyData">
|
||
The private key data <c>k || ENC(A)</c> as described in RFC 8032.
|
||
</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.ED25519Key.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.ED25519Key.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.Key">
|
||
<summary>
|
||
Base class for asymmetric cipher algorithms.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Key.DigitalSignature">
|
||
<summary>
|
||
Gets the default digital signature implementation for this key.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Key.Public">
|
||
<summary>
|
||
Gets the public key.
|
||
</summary>
|
||
<value>
|
||
The public.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Key.KeyLength">
|
||
<summary>
|
||
Gets the length of the key in bits.
|
||
</summary>
|
||
<value>
|
||
The bit-length of the key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.Key.Comment">
|
||
<summary>
|
||
Gets or sets the key comment.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Key.Sign(System.Byte[])">
|
||
<summary>
|
||
Signs the specified data with the key.
|
||
</summary>
|
||
<param name="data">The data to sign.</param>
|
||
<returns>
|
||
Signed data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.Key.VerifySignature(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="data">The data to verify.</param>
|
||
<param name="signature">The signature to verify against.</param>
|
||
<returns><see langword="true"/> is signature was successfully verifies; otherwise <see langword="false"/>.</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.RsaKey">
|
||
<summary>
|
||
Contains the RSA private and public key.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.ToString">
|
||
<summary>
|
||
Gets the name of the key.
|
||
</summary>
|
||
<returns>
|
||
The name of the key.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.Modulus">
|
||
<summary>
|
||
Gets the modulus.
|
||
</summary>
|
||
<value>
|
||
The modulus.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.Exponent">
|
||
<summary>
|
||
Gets the exponent.
|
||
</summary>
|
||
<value>
|
||
The exponent.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.D">
|
||
<summary>
|
||
Gets the D.
|
||
</summary>
|
||
<value>
|
||
The D.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.P">
|
||
<summary>
|
||
Gets the P.
|
||
</summary>
|
||
<value>
|
||
The P.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.Q">
|
||
<summary>
|
||
Gets the Q.
|
||
</summary>
|
||
<value>
|
||
The Q.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.DP">
|
||
<summary>
|
||
Gets the DP.
|
||
</summary>
|
||
<value>
|
||
The DP.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.DQ">
|
||
<summary>
|
||
Gets the DQ.
|
||
</summary>
|
||
<value>
|
||
The DQ.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.InverseQ">
|
||
<summary>
|
||
Gets the inverse Q.
|
||
</summary>
|
||
<value>
|
||
The inverse Q.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.KeyLength">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.DigitalSignature">
|
||
<summary>
|
||
Gets the digital signature implementation for this key.
|
||
</summary>
|
||
<value>
|
||
An implementation of an RSA digital signature using the SHA-1 hash algorithm.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.RsaKey.Public">
|
||
<summary>
|
||
Gets the RSA public key.
|
||
</summary>
|
||
<value>
|
||
An array with <see cref="P:Renci.SshNet.Security.RsaKey.Exponent"/> at index 0, and <see cref="P:Renci.SshNet.Security.RsaKey.Modulus"/>
|
||
at index 1.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.#ctor(Renci.SshNet.Security.SshKeyData)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.RsaKey"/> class.
|
||
</summary>
|
||
<param name="publicKeyData">The encoded public key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.RsaKey"/> class.
|
||
</summary>
|
||
<param name="privateKeyData">DER encoded private key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.#ctor(System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.RsaKey"/> class.
|
||
</summary>
|
||
<param name="modulus">The modulus.</param>
|
||
<param name="exponent">The exponent.</param>
|
||
<param name="d">The d.</param>
|
||
<param name="p">The p.</param>
|
||
<param name="q">The q.</param>
|
||
<param name="inverseQ">The inverse Q.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.RsaKey.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.GroupExchangeHashData.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.HostAlgorithm">
|
||
<summary>
|
||
Base class for SSH host algorithms.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.HostAlgorithm.Name">
|
||
<summary>
|
||
Gets the host key name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.HostAlgorithm.Data">
|
||
<summary>
|
||
Gets the host key data.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.HostAlgorithm.#ctor(System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.HostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The host key name.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.HostAlgorithm.Sign(System.Byte[])">
|
||
<summary>
|
||
Signs the specified data.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
<returns>Signed data.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.HostAlgorithm.VerifySignature(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
<param name="signature">The signature.</param>
|
||
<returns><see langword="true"/> is signature was successfully verifies; otherwise <see langword="false"/>.</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.IKeyExchange">
|
||
<summary>
|
||
Represents a key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Security.IKeyExchange.HostKeyReceived">
|
||
<summary>
|
||
Occurs when the host key is received.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.IKeyExchange.Name">
|
||
<summary>
|
||
Gets the name of the algorithm.
|
||
</summary>
|
||
<value>
|
||
The name of the algorithm.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.IKeyExchange.ExchangeHash">
|
||
<summary>
|
||
Gets the exchange hash.
|
||
</summary>
|
||
<value>
|
||
The exchange hash.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<summary>
|
||
Starts the key exchange algorithm.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="message">The key exchange init message received from the server.</param>
|
||
<param name="sendClientInitMessage">Whether to send a key exchange init message in response.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.Finish">
|
||
<summary>
|
||
Finishes the key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateClientCipher(System.Boolean@)">
|
||
<summary>
|
||
Creates the client-side cipher to use.
|
||
</summary>
|
||
<param name="isAead"><see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.</param>
|
||
<returns>
|
||
The client cipher.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateServerCipher(System.Boolean@)">
|
||
<summary>
|
||
Creates the server-side cipher to use.
|
||
</summary>
|
||
<param name="isAead"><see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.</param>
|
||
<returns>
|
||
The server cipher.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateServerHash(System.Boolean@)">
|
||
<summary>
|
||
Creates the server-side hash algorithm to use.
|
||
</summary>
|
||
<param name="isEncryptThenMAC"><see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.</param>
|
||
<returns>
|
||
The server hash algorithm.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateClientHash(System.Boolean@)">
|
||
<summary>
|
||
Creates the client-side hash algorithm to use.
|
||
</summary>
|
||
<param name="isEncryptThenMAC"><see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.</param>
|
||
<returns>
|
||
The client hash algorithm.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateCompressor">
|
||
<summary>
|
||
Creates the compression algorithm to use to deflate data.
|
||
</summary>
|
||
<returns>
|
||
The compression method to deflate data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.IKeyExchange.CreateDecompressor">
|
||
<summary>
|
||
Creates the compression algorithm to use to inflate data.
|
||
</summary>
|
||
<returns>
|
||
The compression method to inflate data.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.KeyExchange">
|
||
<summary>
|
||
Represents base class for different key exchange algorithm implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchange.Session">
|
||
<summary>
|
||
Gets the session.
|
||
</summary>
|
||
<value>
|
||
The session.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchange.SharedKey">
|
||
<summary>
|
||
Gets or sets key exchange shared key.
|
||
</summary>
|
||
<value>
|
||
The shared key.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchange.ExchangeHash">
|
||
<summary>
|
||
Gets the exchange hash.
|
||
</summary>
|
||
<value>The exchange hash.</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Security.KeyExchange.HostKeyReceived">
|
||
<summary>
|
||
Occurs when host key received.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyExchange"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.Finish">
|
||
<summary>
|
||
Finishes key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateServerCipher(System.Boolean@)">
|
||
<summary>
|
||
Creates the server side cipher to use.
|
||
</summary>
|
||
<param name="isAead"><see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.</param>
|
||
<returns>Server cipher.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateClientCipher(System.Boolean@)">
|
||
<summary>
|
||
Creates the client side cipher to use.
|
||
</summary>
|
||
<param name="isAead"><see langword="true"/> to indicate the cipher is AEAD, <see langword="false"/> to indicate the cipher is not AEAD.</param>
|
||
<returns>Client cipher.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateServerHash(System.Boolean@)">
|
||
<summary>
|
||
Creates the server side hash algorithm to use.
|
||
</summary>
|
||
<param name="isEncryptThenMAC"><see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.</param>
|
||
<returns>
|
||
The server-side hash algorithm.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateClientHash(System.Boolean@)">
|
||
<summary>
|
||
Creates the client side hash algorithm to use.
|
||
</summary>
|
||
<param name="isEncryptThenMAC"><see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.</param>
|
||
<returns>
|
||
The client-side hash algorithm.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateCompressor">
|
||
<summary>
|
||
Creates the compression algorithm to use to deflate data.
|
||
</summary>
|
||
<returns>
|
||
The compression method.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CreateDecompressor">
|
||
<summary>
|
||
Creates the compression algorithm to use to inflate data.
|
||
</summary>
|
||
<returns>
|
||
The decompression method.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CanTrustHostKey(Renci.SshNet.Security.KeyHostAlgorithm)">
|
||
<summary>
|
||
Determines whether the specified host key can be trusted.
|
||
</summary>
|
||
<param name="host">The host algorithm.</param>
|
||
<returns>
|
||
<see langword="true"/> if the specified host can be trusted; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.ValidateExchangeHash">
|
||
<summary>
|
||
Validates the exchange hash.
|
||
</summary>
|
||
<returns><see langword="true"/> if exchange hash is valid; otherwise <see langword="false"/>.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.CalculateHash">
|
||
<summary>
|
||
Calculates key exchange hash value.
|
||
</summary>
|
||
<returns>Key exchange hash.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.SendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends SSH message to the server.
|
||
</summary>
|
||
<param name="message">The message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.GenerateSessionKey(System.Byte[],System.Byte[],System.Byte[],System.Int32)">
|
||
<summary>
|
||
Generates the session key.
|
||
</summary>
|
||
<param name="sharedKey">The shared key.</param>
|
||
<param name="exchangeHash">The exchange hash.</param>
|
||
<param name="key">The key.</param>
|
||
<param name="size">The size.</param>
|
||
<returns>
|
||
The session key.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.GenerateSessionKey(System.Byte[],System.Byte[],System.Char,System.Byte[])">
|
||
<summary>
|
||
Generates the session key.
|
||
</summary>
|
||
<param name="sharedKey">The shared key.</param>
|
||
<param name="exchangeHash">The exchange hash.</param>
|
||
<param name="p">The p.</param>
|
||
<param name="sessionId">The session id.</param>
|
||
<returns>
|
||
The session key.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchange.SessionKeyGeneration.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchange.SessionKeyAdjustment.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchange.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.KeyExchangeDiffieHellman">
|
||
<summary>
|
||
Provides the implementation of "diffie-hellman-groupN" algorithms.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeDiffieHellman.Name">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.#ctor(System.String,Org.BouncyCastle.Crypto.Parameters.DHParameters,System.Security.Cryptography.HashAlgorithmName)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyExchangeDiffieHellman"/> class.
|
||
</summary>
|
||
<param name="name">The name of the key exchange algorithm.</param>
|
||
<param name="parameters">The Diffie-Hellman parameters to be used.</param>
|
||
<param name="hashAlgorithm">The hash algorithm to be used.</param>
|
||
<exception cref="T:System.ArgumentNullException">
|
||
<paramref name="name"/>, <paramref name="parameters"/>, or <see cref="P:System.Security.Cryptography.HashAlgorithmName.Name"/> is <see langword="null"/>.
|
||
</exception>
|
||
<exception cref="T:System.ArgumentException">
|
||
<paramref name="hashAlgorithm"/> is not a valid hash algorithm.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.CalculateHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.ValidateExchangeHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.Hash(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellman.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange">
|
||
<summary>
|
||
Provides the implementation of "diffie-hellman-group-exchange" algorithms.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.Name">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.#ctor(System.String,System.Security.Cryptography.HashAlgorithmName)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange"/> class.
|
||
</summary>
|
||
<param name="name">The name of the key exchange algorithm.</param>
|
||
<param name="hashAlgorithm">The hash algorithm to be used.</param>
|
||
<exception cref="T:System.ArgumentNullException">
|
||
<paramref name="name"/> or <see cref="P:System.Security.Cryptography.HashAlgorithmName.Name"/> is <see langword="null"/>.
|
||
</exception>
|
||
<exception cref="T:System.ArgumentException">
|
||
<paramref name="hashAlgorithm"/> is not a valid hash algorithm.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.#ctor(System.String,System.Security.Cryptography.HashAlgorithmName,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange"/> class.
|
||
</summary>
|
||
<param name="name">The name of the key exchange algorithm.</param>
|
||
<param name="hashAlgorithm">The hash algorithm to be used.</param>
|
||
<param name="minimumGroupSize">The minimum size in bits of an acceptable group.</param>
|
||
<param name="preferredGroupSize">The preferred size in bits of an acceptable group.</param>
|
||
<param name="maximumGroupSize">The maximum size in bits of an acceptable group.</param>
|
||
<exception cref="T:System.ArgumentNullException">
|
||
<paramref name="name"/> or <see cref="P:System.Security.Cryptography.HashAlgorithmName.Name"/> is <see langword="null"/>.
|
||
</exception>
|
||
<exception cref="T:System.ArgumentException">
|
||
<paramref name="hashAlgorithm"/> is not a valid hash algorithm.
|
||
</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||
<paramref name="preferredGroupSize"/> is not between <paramref name="minimumGroupSize"/> and <paramref name="maximumGroupSize"/>.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.CalculateHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.ValidateExchangeHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.Hash(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeDiffieHellmanGroupExchange.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._clientPayload">
|
||
<summary>
|
||
Specifies client payload.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._serverPayload">
|
||
<summary>
|
||
Specifies server payload.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._clientExchangeValue">
|
||
<summary>
|
||
Specifies client exchange.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._serverExchangeValue">
|
||
<summary>
|
||
Specifies server exchange.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._hostKey">
|
||
<summary>
|
||
Specifies host key data.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Security.KeyExchangeEC._signature">
|
||
<summary>
|
||
Specifies signature data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeEC.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeEC.CalculateHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeEC.ValidateExchangeHash">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeEC.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECCurve25519.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECCurve25519.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.StartImpl">
|
||
<summary>
|
||
The implementation of start key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.Finish">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.FinishImpl">
|
||
<summary>
|
||
The implementation of finish key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.HandleServerEcdhReply(System.Byte[],System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Handles the server DH reply message.
|
||
</summary>
|
||
<param name="hostKey">The host key.</param>
|
||
<param name="serverExchangeValue">The server exchange value.</param>
|
||
<param name="signature">The signature.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECCurve25519.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH.Curve">
|
||
<summary>
|
||
Gets the curve.
|
||
</summary>
|
||
<value>
|
||
The curve.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH.CurveParameter">
|
||
<summary>
|
||
Gets the parameter of the curve.
|
||
</summary>
|
||
<value>
|
||
The parameter of the curve.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH.Start(Renci.SshNet.Session,Renci.SshNet.Messages.Transport.KeyExchangeInitMessage,System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH.Finish">
|
||
<summary>
|
||
Finishes key exchange algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH.HandleServerEcdhReply(System.Byte[],System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Handles the server DH reply message.
|
||
</summary>
|
||
<param name="hostKey">The host key.</param>
|
||
<param name="serverExchangeValue">The server exchange value.</param>
|
||
<param name="signature">The signature.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH256.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH256.Curve">
|
||
<summary>
|
||
Gets the curve.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH256.CurveParameter">
|
||
<summary>
|
||
Gets Curve Parameter.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH256.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH256.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH384.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH384.Curve">
|
||
<summary>
|
||
Gets the curve.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH384.CurveParameter">
|
||
<summary>
|
||
Gets Curve Parameter.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH384.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH384.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH521.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH521.Curve">
|
||
<summary>
|
||
Gets the curve.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH521.CurveParameter">
|
||
<summary>
|
||
Gets Curve Parameter.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeECDH521.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeECDH521.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeHashData.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.StartImpl">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.FinishImpl">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeMLKem768X25519Sha256.HandleServerHybridReply(System.Byte[],System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Handles the server hybrid reply message.
|
||
</summary>
|
||
<param name="hostKey">The host key.</param>
|
||
<param name="serverExchangeValue">The server exchange value.</param>
|
||
<param name="signature">The signature.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.Name">
|
||
<summary>
|
||
Gets algorithm name.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.HashSize">
|
||
<summary>
|
||
Gets the size, in bits, of the computed hash code.
|
||
</summary>
|
||
<value>
|
||
The size, in bits, of the computed hash code.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.StartImpl">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.FinishImpl">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.Hash(System.Byte[])">
|
||
<summary>
|
||
Hashes the specified data bytes.
|
||
</summary>
|
||
<param name="hashData">The hash data.</param>
|
||
<returns>
|
||
The hash of the data.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyExchangeSNtruP761X25519Sha512.HandleServerEcdhReply(System.Byte[],System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Handles the server DH reply message.
|
||
</summary>
|
||
<param name="hostKey">The host key.</param>
|
||
<param name="serverExchangeValue">The server exchange value.</param>
|
||
<param name="signature">The signature.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.KeyHostAlgorithm">
|
||
<summary>
|
||
Implements key support for host algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.Key">
|
||
<summary>
|
||
Gets the key used in this host key algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.DigitalSignature">
|
||
<summary>
|
||
Gets the signature implementation used in this host key algorithm.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.KeyData">
|
||
<summary>
|
||
Gets the encoded public key data.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.Data">
|
||
<summary>
|
||
Gets the encoded public key data.
|
||
</summary>
|
||
<value>
|
||
The encoded public key data.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Key)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The signature format identifier.</param>
|
||
<param name="key">The key used in this host key algorithm.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.#ctor(System.String,Renci.SshNet.Security.Key,Renci.SshNet.Security.Cryptography.DigitalSignature)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.KeyHostAlgorithm"/> class.
|
||
</summary>
|
||
<param name="name">The signature format identifier.</param>
|
||
<param name="key">The key used in this host key algorithm.</param>
|
||
<param name="digitalSignature">The signature implementation used in this host key algorithm.</param>
|
||
<remarks>
|
||
The key used by <paramref name="digitalSignature"/> is intended to be equal to <paramref name="key"/>.
|
||
This is not verified.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.Sign(System.Byte[])">
|
||
<summary>
|
||
Signs and encodes the specified data.
|
||
</summary>
|
||
<param name="data">The data to be signed.</param>
|
||
<returns>
|
||
The encoded signature.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.VerifySignature(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the encoded signature.
|
||
</summary>
|
||
<param name="data">The data to verify the signature against.</param>
|
||
<param name="signature">
|
||
The encoded signature data, as the signature format identifier followed by the signature blob.
|
||
</param>
|
||
<returns>
|
||
<see langword="true"/> if <paramref name="signature"/> is the result of signing and encoding
|
||
<paramref name="data"/> with the corresponding private key to <see cref="P:Renci.SshNet.Security.KeyHostAlgorithm.Key"/>.
|
||
</returns>
|
||
<remarks>See <see href="https://datatracker.ietf.org/doc/html/rfc4253#section-6.6"/>.</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.VerifySignatureBlob(System.Byte[],System.Byte[])">
|
||
<summary>
|
||
Verifies the signature.
|
||
</summary>
|
||
<param name="data">The data to verify the signature against.</param>
|
||
<param name="signatureBlob">The signature blob in format specific encoding.</param>
|
||
<returns>
|
||
<see langword="true"/> if <paramref name="signatureBlob"/> is the result of signing <paramref name="data"/>
|
||
with the corresponding private key to <see cref="P:Renci.SshNet.Security.KeyHostAlgorithm.Key"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.SignatureKeyData.AlgorithmName">
|
||
<summary>
|
||
Gets or sets the signature format identifier.
|
||
</summary>
|
||
<value>
|
||
The signature format identifier.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.SignatureKeyData.Signature">
|
||
<summary>
|
||
Gets the signature.
|
||
</summary>
|
||
<value>
|
||
The signature.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.KeyHostAlgorithm.SignatureKeyData.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.SignatureKeyData.LoadData">
|
||
<summary>
|
||
Called when type specific data need to be loaded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.KeyHostAlgorithm.SignatureKeyData.SaveData">
|
||
<summary>
|
||
Called when type specific data need to be saved.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Security.SshKeyData">
|
||
<summary>
|
||
Facilitates (de)serializing encoded public key data in the format
|
||
specified by RFC 4253 section 6.6.
|
||
</summary>
|
||
<remarks>
|
||
See https://datatracker.ietf.org/doc/html/rfc4253#section-6.6.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.SshKeyData.Name">
|
||
<summary>
|
||
Gets the public key format identifier.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.SshKeyData.Keys">
|
||
<summary>
|
||
Gets the public key constituents.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Security.SshKeyData.BufferCapacity">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.SshKeyData.#ctor(System.Byte[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.SshKeyData"/> class.
|
||
</summary>
|
||
<param name="data">The encoded public key data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.SshKeyData.#ctor(System.String,System.Numerics.BigInteger[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Security.SshKeyData"/> class.
|
||
</summary>
|
||
<param name="name">The public key format identifier.</param>
|
||
<param name="keys">The public key constituents.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.SshKeyData.LoadData">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Security.SshKeyData.SaveData">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ServiceFactory">
|
||
<summary>
|
||
Basic factory for creating new services.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.ServiceFactory.PartialSuccessLimit">
|
||
<summary>
|
||
Defines the number of times an authentication attempt with any given <see cref="T:Renci.SshNet.IAuthenticationMethod"/>
|
||
can result in <see cref="F:Renci.SshNet.AuthenticationResult.PartialSuccess"/> before it is disregarded.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateClientAuthentication">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.IClientAuthentication"/>.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.IClientAuthentication"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateSession(Renci.SshNet.ConnectionInfo,Renci.SshNet.Connection.ISocketFactory)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.ISession"/> with the specified <see cref="T:Renci.SshNet.ConnectionInfo"/> and
|
||
<see cref="T:Renci.SshNet.Connection.ISocketFactory"/>.
|
||
</summary>
|
||
<param name="connectionInfo">The <see cref="T:Renci.SshNet.ConnectionInfo"/> to use for creating a new session.</param>
|
||
<param name="socketFactory">A factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.ISession"/> for the specified <see cref="T:Renci.SshNet.ConnectionInfo"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="socketFactory"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateSftpSession(Renci.SshNet.ISession,System.Int32,System.Text.Encoding,Renci.SshNet.Sftp.ISftpResponseFactory)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.Sftp.ISftpSession"/> in a given <see cref="T:Renci.SshNet.ISession"/> and with
|
||
the specified operation timeout and encoding.
|
||
</summary>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> to create the <see cref="T:Renci.SshNet.Sftp.ISftpSession"/> in.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for an operation to complete, or <c>-1</c> to wait indefinitely.</param>
|
||
<param name="encoding">The encoding.</param>
|
||
<param name="sftpMessageFactory">The factory to use for creating SFTP messages.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Sftp.ISftpSession"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreatePipeStream">
|
||
<summary>
|
||
Create a new <see cref="T:Renci.SshNet.Common.PipeStream"/>.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Common.PipeStream"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateKeyExchange(System.Collections.Generic.IDictionary{System.String,System.Func{Renci.SshNet.Security.IKeyExchange}},System.String[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateNetConfSession(Renci.SshNet.ISession,System.Int32)">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.NetConf.INetConfSession"/> in a given <see cref="T:Renci.SshNet.ISession"/>
|
||
and with the specified operation timeout.
|
||
</summary>
|
||
<param name="session">The <see cref="T:Renci.SshNet.ISession"/> to create the <see cref="T:Renci.SshNet.NetConf.INetConfSession"/> in.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for an operation to complete, or <c>-1</c> to wait indefinitely.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.NetConf.INetConfSession"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateSftpResponseFactory">
|
||
<summary>
|
||
Creates a new <see cref="T:Renci.SshNet.Sftp.ISftpResponseFactory"/> instance.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Sftp.ISftpResponseFactory"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateShellStream(Renci.SshNet.ISession,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateShellStreamNoTerminal(Renci.SshNet.ISession,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateRemotePathDoubleQuoteTransformation">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that encloses a path in double quotes, and escapes
|
||
any embedded double quote with a backslash.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.IRemotePathTransformation"/> that encloses a path in double quotes, and escapes any
|
||
embedded double quote with a backslash.
|
||
with a shell.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateConnector(Renci.SshNet.IConnectionInfo,Renci.SshNet.Connection.ISocketFactory)">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.Connection.IConnector"/> that can be used to establish a connection
|
||
to the server identified by the specified <paramref name="connectionInfo"/>.
|
||
</summary>
|
||
<param name="connectionInfo">A <see cref="T:Renci.SshNet.IConnectionInfo"/> detailing the server to establish a connection to.</param>
|
||
<param name="socketFactory">A factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.</param>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.IConnector"/> that can be used to establish a connection to the
|
||
server identified by the specified <paramref name="connectionInfo"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="socketFactory"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.NotSupportedException">The <see cref="P:Renci.SshNet.IConnectionInfo.ProxyType"/> value of <paramref name="connectionInfo"/> is not supported.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateProtocolVersionExchange">
|
||
<summary>
|
||
Creates an <see cref="T:Renci.SshNet.Connection.IProtocolVersionExchange"/> that deals with the SSH protocol
|
||
version exchange.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.IProtocolVersionExchange"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ServiceFactory.CreateSocketFactory">
|
||
<summary>
|
||
Creates a factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:Renci.SshNet.Connection.ISocketFactory"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Session">
|
||
<summary>
|
||
Provides functionality to connect and interact with SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session.MaximumSshPacketSize">
|
||
<summary>
|
||
Specifies maximum packet size defined by the protocol.
|
||
</summary>
|
||
<value>
|
||
68536 (64 KB + 3000 bytes).
|
||
</value>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session.InitialLocalWindowSize">
|
||
<summary>
|
||
Holds the initial local window size for the channels.
|
||
</summary>
|
||
<value>
|
||
2147483647 (2^31 - 1) bytes.
|
||
</value>
|
||
<remarks>
|
||
We currently do not define a maximum (remote) window size.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session.LocalChannelDataPacketSize">
|
||
<summary>
|
||
Holds the maximum size of channel data packets that we receive.
|
||
</summary>
|
||
<value>
|
||
64 KB.
|
||
</value>
|
||
<remarks>
|
||
<para>
|
||
This is the maximum size (in bytes) we support for the data (payload) of a
|
||
<c>SSH_MSG_CHANNEL_DATA</c> message we receive.
|
||
</para>
|
||
<para>
|
||
We currently do not enforce this limit.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._serviceFactory">
|
||
<summary>
|
||
Holds the factory to use for creating new services.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._socketWriteLock">
|
||
<summary>
|
||
Holds an object that is used to ensure only a single thread can write to
|
||
<see cref="F:Renci.SshNet.Session._socket"/> at any given time.
|
||
</summary>
|
||
<remarks>
|
||
This is also used to ensure that <see cref="F:Renci.SshNet.Session._outboundPacketSequence"/> is
|
||
incremented atomatically.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._socketDisposeLock">
|
||
<summary>
|
||
Holds an object that is used to ensure only a single thread can dispose
|
||
<see cref="F:Renci.SshNet.Session._socket"/> at any given time.
|
||
</summary>
|
||
<remarks>
|
||
This is also used to ensure that <see cref="F:Renci.SshNet.Session._socket"/> will not be disposed
|
||
while performing a given operation or set of operations on <see cref="F:Renci.SshNet.Session._socket"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._connectLock">
|
||
<summary>
|
||
Holds an object that is used to ensure only a single thread can connect
|
||
at any given time.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._sshMessageFactory">
|
||
<summary>
|
||
Holds metadata about session messages.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._messageListenerCompleted">
|
||
<summary>
|
||
Holds a <see cref="T:System.Threading.WaitHandle"/> that is signaled when the message listener loop has completed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._outboundPacketSequence">
|
||
<summary>
|
||
Specifies outbound packet number.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._inboundPacketSequence">
|
||
<summary>
|
||
Specifies incoming packet number.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._serviceAccepted">
|
||
<summary>
|
||
WaitHandle to signal that last service request was accepted.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._exceptionWaitHandle">
|
||
<summary>
|
||
WaitHandle to signal that exception was thrown by another thread.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._keyExchangeCompletedWaitHandle">
|
||
<summary>
|
||
WaitHandle to signal that key exchange was completed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._exception">
|
||
<summary>
|
||
Exception that need to be thrown by waiting thread.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._isAuthenticated">
|
||
<summary>
|
||
Specifies whether connection is authenticated.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._isDisconnecting">
|
||
<summary>
|
||
Specifies whether user issued Disconnect command or not.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._isInitialKex">
|
||
<summary>
|
||
Indicates whether it is the init kex.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._isStrictKex">
|
||
<summary>
|
||
Indicates whether server supports strict key exchange.
|
||
<see href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL"/> 1.10.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Session._socket">
|
||
<summary>
|
||
Holds connection socket.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.SessionSemaphore">
|
||
<summary>
|
||
Gets the session semaphore that controls session channels.
|
||
</summary>
|
||
<value>
|
||
The session semaphore.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.NextChannelNumber">
|
||
<summary>
|
||
Gets the next channel number.
|
||
</summary>
|
||
<value>
|
||
The next channel number.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether the session is connected.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the session is connected; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<remarks>
|
||
This methods returns <see langword="true"/> in all but the following cases:
|
||
<list type="bullet">
|
||
<item>
|
||
<description>The <see cref="T:Renci.SshNet.Session"/> is disposed.</description>
|
||
</item>
|
||
<item>
|
||
<description>The <c>SSH_MSG_DISCONNECT</c> message - which is used to disconnect from the server - has been sent.</description>
|
||
</item>
|
||
<item>
|
||
<description>The client has not been authenticated successfully.</description>
|
||
</item>
|
||
<item>
|
||
<description>The listener thread - which is used to receive messages from the server - has stopped.</description>
|
||
</item>
|
||
<item>
|
||
<description>The socket used to communicate with the server is no longer connected.</description>
|
||
</item>
|
||
</list>
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.SessionId">
|
||
<summary>
|
||
Gets the session id.
|
||
</summary>
|
||
<value>
|
||
The session id, or <see langword="null"/> if the client has not been authenticated.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.ClientInitMessage">
|
||
<summary>
|
||
Gets the client init message.
|
||
</summary>
|
||
<value>The client init message.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.ServerVersion">
|
||
<summary>
|
||
Gets the server version string.
|
||
</summary>
|
||
<value>
|
||
The server version.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.ClientVersion">
|
||
<summary>
|
||
Gets the client version string.
|
||
</summary>
|
||
<value>
|
||
The client version.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>
|
||
The connection info.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.SessionLoggerFactory">
|
||
<summary>
|
||
Gets the logger factory for this session.
|
||
</summary>
|
||
<value>
|
||
The logger factory for this session.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ErrorOccured">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
<remarks>A known misspelling of "occurred" preserved for backward compatibility.</remarks>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.Disconnected">
|
||
<summary>
|
||
Occurs when session has been disconnected from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ServerIdentificationReceived">
|
||
<summary>
|
||
Occurs when server identification received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.HostKeyReceived">
|
||
<summary>
|
||
Occurs when host key received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationBannerReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.BannerMessage"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationInformationRequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.InformationRequestMessage"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationPasswordChangeRequiredReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.PasswordChangeRequiredMessage"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationPublicKeyReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.PublicKeyMessage"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeDhGroupExchangeGroupReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeGroup"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeDhGroupExchangeReplyReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhGroupExchangeReply"/> message is received from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.DisconnectReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.DisconnectMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.IgnoreReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.IgnoreMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UnimplementedReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.UnimplementedMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.DebugReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.DebugMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ServiceRequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.ServiceRequestMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ServiceAcceptReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.ServiceAcceptMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeInitReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeDhReplyMessageReceived">
|
||
<summary>
|
||
Occurs when a <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeDhReplyMessage"/> message is received from the SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeEcdhReplyMessageReceived">
|
||
<summary>
|
||
Occurs when a <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeEcdhReplyMessage"/> message is received from the SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.KeyExchangeHybridReplyMessageReceived">
|
||
<summary>
|
||
Occurs when a <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeHybridReplyMessage"/> message is received from the SSH server.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.NewKeysReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Transport.NewKeysMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationRequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.FailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.UserAuthenticationSuccessReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Authentication.SuccessMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.RequestSuccessReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.RequestFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.RequestFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelOpenReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelOpenConfirmationReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelOpenFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelWindowAdjustReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelExtendedDataReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelEofReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelEofMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelCloseReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelRequestReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelSuccessReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Session.ChannelFailureReceived">
|
||
<summary>
|
||
Occurs when <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> message received
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.#ctor(Renci.SshNet.ConnectionInfo,Renci.SshNet.IServiceFactory,Renci.SshNet.Connection.ISocketFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Session"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<param name="socketFactory">A factory to create <see cref="T:System.Net.Sockets.Socket"/> instances.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="socketFactory"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Connect">
|
||
<summary>
|
||
Connects to the server.
|
||
</summary>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.ConnectAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously connects to the server.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous connect operation.</returns>
|
||
<exception cref="T:System.Net.Sockets.SocketException">Socket connection to the SSH server or proxy server could not be established, or an error occurred while resolving the hostname.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">SSH session could not be established.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshAuthenticationException">Authentication of SSH session failed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.ProxyException">Failed to establish proxy connection.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Disconnect">
|
||
<summary>
|
||
Disconnects from the server.
|
||
</summary>
|
||
<remarks>
|
||
This sends a <b>SSH_MSG_DISCONNECT</b> message to the server, waits for the
|
||
server to close the socket on its end and subsequently closes the client socket.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#WaitOnHandle(System.Threading.WaitHandle)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the connection timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
<remarks>
|
||
When neither handles are signaled in time and the session is not closing, then the
|
||
session is disconnected.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#WaitOnHandle(System.Threading.WaitHandle,System.TimeSpan)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the specified timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<param name="timeout">The time to wait for any of the handles to become signaled.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
<remarks>
|
||
When neither handles are signaled in time and the session is not closing, then the
|
||
session is disconnected.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#TryWait(System.Threading.WaitHandle,System.TimeSpan)">
|
||
<summary>
|
||
Waits for the specified <seec ref="WaitHandle"/> to receive a signal, using a <see cref="T:System.TimeSpan"/>
|
||
to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandle">The <see cref="T:System.Threading.WaitHandle"/> that should be signaled.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan"/> that represents <c>-1</c> milliseconds to wait indefinitely.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.WaitResult"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#TryWait(System.Threading.WaitHandle,System.TimeSpan,System.Exception@)">
|
||
<summary>
|
||
Waits for the specified <seec ref="WaitHandle"/> to receive a signal, using a <see cref="T:System.TimeSpan"/>
|
||
to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandle">The <see cref="T:System.Threading.WaitHandle"/> that should be signaled.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan"/> that represents <c>-1</c> milliseconds to wait indefinitely.</param>
|
||
<param name="exception">When this method returns <see cref="F:Renci.SshNet.WaitResult.Failed"/>, contains the <see cref="T:System.Exception"/>.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.WaitResult"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.TryWait(System.Threading.WaitHandle,System.TimeSpan,System.Exception@)">
|
||
<summary>
|
||
Waits for the specified <seec ref="WaitHandle"/> to receive a signal, using a <see cref="T:System.TimeSpan"/>
|
||
to specify the time interval.
|
||
</summary>
|
||
<param name="waitHandle">The <see cref="T:System.Threading.WaitHandle"/> that should be signaled.</param>
|
||
<param name="timeout">A <see cref="T:System.TimeSpan"/> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan"/> that represents <c>-1</c> milliseconds to wait indefinitely.</param>
|
||
<param name="exception">When this method returns <see cref="F:Renci.SshNet.WaitResult.Failed"/>, contains the <see cref="T:System.Exception"/>.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.WaitResult"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.WaitOnHandle(System.Threading.WaitHandle)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the connection timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
<remarks>
|
||
When neither handles are signaled in time and the session is not closing, then the
|
||
session is disconnected.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.WaitOnHandle(System.Threading.WaitHandle,System.TimeSpan)">
|
||
<summary>
|
||
Waits for the specified handle or the exception handle for the receive thread
|
||
to signal within the specified timeout.
|
||
</summary>
|
||
<param name="waitHandle">The wait handle.</param>
|
||
<param name="timeout">The time to wait for any of the handles to become signaled.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">A received package was invalid or failed the message integrity check.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">None of the handles are signaled in time and the session is not disconnecting.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">A socket error was signaled while receiving messages from the server.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.SendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The operation timed out.</exception>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.SendPacket(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Sends an SSH packet to the server.
|
||
</summary>
|
||
<param name="packet">A byte array containing the packet to send.</param>
|
||
<param name="offset">The offset of the packet.</param>
|
||
<param name="length">The length of the packet.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected to the server.</exception>
|
||
<remarks>
|
||
<para>
|
||
The send is performed in a dispose lock to avoid <see cref="T:System.NullReferenceException"/>
|
||
and/or <see cref="T:System.ObjectDisposedException"/> when sending the packet.
|
||
</para>
|
||
<para>
|
||
This method is only to be used when the connection is established, as the locking
|
||
overhead is not required while establishing the connection.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.TrySendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<returns>
|
||
<see langword="true"/> if the message was sent to the server; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
<remarks>
|
||
This methods returns <see langword="false"/> when the attempt to send the message results in a
|
||
<see cref="T:System.Net.Sockets.SocketException"/> or a <see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.ReceiveMessage(System.Net.Sockets.Socket)">
|
||
<summary>
|
||
Receives the message from the server.
|
||
</summary>
|
||
<returns>
|
||
The incoming SSH message, or <see langword="null"/> if the connection with the SSH server was closed.
|
||
</returns>
|
||
<remarks>
|
||
We need no locking here since all messages are read by a single thread.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnDisconnectReceived(Renci.SshNet.Messages.Transport.DisconnectMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.DisconnectMessage"/> received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.DisconnectMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnIgnoreReceived(Renci.SshNet.Messages.Transport.IgnoreMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.IgnoreMessage"/> received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.IgnoreMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUnimplementedReceived(Renci.SshNet.Messages.Transport.UnimplementedMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.UnimplementedMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.UnimplementedMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnDebugReceived(Renci.SshNet.Messages.Transport.DebugMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.DebugMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.DebugMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnServiceRequestReceived(Renci.SshNet.Messages.Transport.ServiceRequestMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.ServiceRequestMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.ServiceRequestMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnServiceAcceptReceived(Renci.SshNet.Messages.Transport.ServiceAcceptMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.ServiceAcceptMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.ServiceAcceptMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnKeyExchangeInitReceived(Renci.SshNet.Messages.Transport.KeyExchangeInitMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.KeyExchangeInitMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnNewKeysReceived(Renci.SshNet.Messages.Transport.NewKeysMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Transport.NewKeysMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Transport.NewKeysMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUserAuthenticationRequestReceived(Renci.SshNet.Messages.Authentication.RequestMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Authentication.RequestMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Authentication.RequestMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUserAuthenticationFailureReceived(Renci.SshNet.Messages.Authentication.FailureMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Authentication.FailureMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Authentication.FailureMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUserAuthenticationSuccessReceived(Renci.SshNet.Messages.Authentication.SuccessMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Authentication.SuccessMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Authentication.SuccessMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUserAuthenticationBannerReceived(Renci.SshNet.Messages.Authentication.BannerMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Authentication.BannerMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Authentication.BannerMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnUserAuthenticationInformationRequestReceived(Renci.SshNet.Messages.Authentication.InformationRequestMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Authentication.InformationRequestMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Authentication.InformationRequestMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnGlobalRequestReceived(Renci.SshNet.Messages.Connection.GlobalRequestMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.GlobalRequestMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.GlobalRequestMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnRequestSuccessReceived(Renci.SshNet.Messages.Connection.RequestSuccessMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.RequestSuccessMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnRequestFailureReceived(Renci.SshNet.Messages.Connection.RequestFailureMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.RequestFailureMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.RequestFailureMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelOpenReceived(Renci.SshNet.Messages.Connection.ChannelOpenMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelOpenConfirmationReceived(Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenConfirmationMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelOpenFailureReceived(Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelOpenFailureMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelWindowAdjustReceived(Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelWindowAdjustMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelDataReceived(Renci.SshNet.Messages.Connection.ChannelDataMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelDataMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelExtendedDataReceived(Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelExtendedDataMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelEofReceived(Renci.SshNet.Messages.Connection.ChannelEofMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelCloseReceived(Renci.SshNet.Messages.Connection.ChannelCloseMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelCloseMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelRequestReceived(Renci.SshNet.Messages.Connection.ChannelRequestMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelRequestMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelSuccessReceived(Renci.SshNet.Messages.Connection.ChannelSuccessMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelSuccessMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.OnChannelFailureReceived(Renci.SshNet.Messages.Connection.ChannelFailureMessage)">
|
||
<summary>
|
||
Called when <see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> message received.
|
||
</summary>
|
||
<param name="message"><see cref="T:Renci.SshNet.Messages.Connection.ChannelFailureMessage"/> message.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.RegisterMessage(System.String)">
|
||
<summary>
|
||
Registers SSH message with the session.
|
||
</summary>
|
||
<param name="messageName">The name of the message to register with the session.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.UnRegisterMessage(System.String)">
|
||
<summary>
|
||
Unregister SSH message from the session.
|
||
</summary>
|
||
<param name="messageName">The name of the message to unregister with the session.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.LoadMessage(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Loads a message from a given buffer.
|
||
</summary>
|
||
<param name="data">An array of bytes from which to construct the message.</param>
|
||
<param name="offset">The zero-based byte offset in <paramref name="data"/> at which to begin reading.</param>
|
||
<param name="count">The number of bytes to load.</param>
|
||
<returns>
|
||
A message constructed from <paramref name="data"/>.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The type of the message is not supported.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.TrySocketRead(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Performs a blocking read on the socket until <paramref name="length"/> bytes are received.
|
||
</summary>
|
||
<param name="socket">The <see cref="T:System.Net.Sockets.Socket"/> to read from.</param>
|
||
<param name="buffer">An array of type <see cref="T:System.Byte"/> that is the storage location for the received data.</param>
|
||
<param name="offset">The position in <paramref name="buffer"/> parameter to store the received data.</param>
|
||
<param name="length">The number of bytes to read.</param>
|
||
<returns>
|
||
The number of bytes read.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The read has timed-out.</exception>
|
||
<exception cref="T:System.Net.Sockets.SocketException">The read failed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.SocketDisconnectAndDispose">
|
||
<summary>
|
||
Shuts down and disposes the socket.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.MessageListener">
|
||
<summary>
|
||
Listens for incoming message from the server and handles them. This method run as a task on separate thread.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.RaiseError(System.Exception)">
|
||
<summary>
|
||
Raises the <see cref="E:Renci.SshNet.Session.ErrorOccured"/> event.
|
||
</summary>
|
||
<param name="exp">The <see cref="T:System.Exception"/>.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Reset">
|
||
<summary>
|
||
Resets connection-specific information to ensure state of a previous connection
|
||
does not affect new connections.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.Renci#SshNet#ISession#ConnectionInfo">
|
||
<summary>
|
||
Gets the connection info.
|
||
</summary>
|
||
<value>The connection info.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Session.Renci#SshNet#ISession#MessageListenerCompleted">
|
||
<summary>
|
||
Gets a <see cref="T:System.Threading.WaitHandle"/> that can be used to wait for the message listener loop to complete.
|
||
</summary>
|
||
<value>
|
||
A <see cref="T:System.Threading.WaitHandle"/> that can be used to wait for the message listener loop to complete, or
|
||
<see langword="null"/> when the session has not been connected.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#CreateChannelSession">
|
||
<summary>
|
||
Create a new SSH session channel.
|
||
</summary>
|
||
<returns>
|
||
A new SSH session channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#CreateChannelDirectTcpip">
|
||
<summary>
|
||
Create a new channel for a locally forwarded TCP/IP port.
|
||
</summary>
|
||
<returns>
|
||
A new channel for a locally forwarded TCP/IP port.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#CreateChannelForwardedTcpip(System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Creates a "forwarded-tcpip" SSH channel.
|
||
</summary>
|
||
<param name="remoteChannelNumber">The number of the remote channel.</param>
|
||
<param name="remoteWindowSize">The window size of the remote channel.</param>
|
||
<param name="remoteChannelDataPacketSize">The data packet size of the remote channel.</param>
|
||
<returns>
|
||
A new "forwarded-tcpip" SSH channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#SendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">The client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The operation timed out.</exception>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Session.Renci#SshNet#ISession#TrySendMessage(Renci.SshNet.Messages.Message)">
|
||
<summary>
|
||
Sends a message to the server.
|
||
</summary>
|
||
<param name="message">The message to send.</param>
|
||
<returns>
|
||
<see langword="true"/> if the message was sent to the server; otherwise, <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">The size of the packet exceeds the maximum size defined by the protocol.</exception>
|
||
<remarks>
|
||
This methods returns <see langword="false"/> when the attempt to send the message results in a
|
||
<see cref="T:System.Net.Sockets.SocketException"/> or a <see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.WaitResult">
|
||
<summary>
|
||
Represents the result of a wait operations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.WaitResult.Success">
|
||
<summary>
|
||
The <see cref="T:System.Threading.WaitHandle"/> was signaled within the specified interval.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.WaitResult.TimedOut">
|
||
<summary>
|
||
The <see cref="T:System.Threading.WaitHandle"/> was not signaled within the specified interval.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.WaitResult.Disconnected">
|
||
<summary>
|
||
The session is in a disconnected state.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.WaitResult.Failed">
|
||
<summary>
|
||
The session is in a failed state.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.SftpClient">
|
||
<summary>
|
||
Implementation of the SSH File Transfer Protocol (SFTP) over SSH.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SftpClient._sftpSession">
|
||
<summary>
|
||
Holds the <see cref="T:Renci.SshNet.Sftp.ISftpSession"/> instance that is used to communicate to the
|
||
SFTP server.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SftpClient._operationTimeout">
|
||
<summary>
|
||
Holds the operation timeout.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SftpClient._bufferSize">
|
||
<summary>
|
||
Holds the size of the buffer.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.OperationTimeout">
|
||
<summary>
|
||
Gets or sets the operation timeout.
|
||
</summary>
|
||
<value>
|
||
The timeout to wait until an operation completes. The default value is negative
|
||
one (-1) milliseconds, which indicates an infinite timeout period.
|
||
</value>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> represents a value that is less than -1 or greater than <see cref="F:System.Int32.MaxValue"/> milliseconds.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.BufferSize">
|
||
<summary>
|
||
Gets or sets the maximum size of the buffer in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the buffer. The default buffer size is 32768 bytes (32 KB).
|
||
</value>
|
||
<remarks>
|
||
<para>
|
||
For write operations, this limits the size of the payload for
|
||
individual SSH_FXP_WRITE messages. The actual size is always
|
||
capped at the maximum packet size supported by the peer
|
||
(minus the size of protocol fields).
|
||
</para>
|
||
<para>
|
||
For read operations, this controls the size of the payload which
|
||
is requested from the peer in a SSH_FXP_READ message. The peer
|
||
will send the requested number of bytes in a SSH_FXP_DATA message,
|
||
possibly split over multiple SSH_MSG_CHANNEL_DATA messages.
|
||
</para>
|
||
<para>
|
||
To optimize the size of the SSH packets sent by the peer,
|
||
the actual requested size will take into account the size of the
|
||
SSH_FXP_DATA protocol fields.
|
||
</para>
|
||
<para>
|
||
The size of the each individual SSH_FXP_DATA message is limited to the
|
||
local maximum packet size of the channel, which is set to <c>64 KB</c>
|
||
for SSH.NET. However, the peer can limit this even further.
|
||
</para>
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.IsConnected">
|
||
<summary>
|
||
Gets a value indicating whether this client is connected to the server and
|
||
the SFTP session is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this client is connected and the SFTP session is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.WorkingDirectory">
|
||
<summary>
|
||
Gets remote working directory.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.ProtocolVersion">
|
||
<summary>
|
||
Gets sftp protocol version.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SftpClient.SftpSession">
|
||
<summary>
|
||
Gets the current SFTP session.
|
||
</summary>
|
||
<value>
|
||
The current SFTP session.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(Renci.SshNet.ConnectionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid. <para>-or-</para> <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, the connection info will be disposed when this
|
||
instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SftpClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, the connection info will be disposed when this
|
||
instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ChangeDirectory(System.String)">
|
||
<summary>
|
||
Changes remote directory to path.
|
||
</summary>
|
||
<param name="path">New directory path.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ChangeDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously requests to change the current working directory to the specified path.
|
||
</summary>
|
||
<param name="path">The new working directory.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that tracks the asynchronous change working directory request.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change directory denied by remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ChangePermissions(System.String,System.Int16)">
|
||
<summary>
|
||
Changes permissions of file(s) to specified mode.
|
||
</summary>
|
||
<param name="path">File(s) path, may match multiple files.</param>
|
||
<param name="mode">The mode.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to change permission on the path(s) was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.CreateDirectory(System.String)">
|
||
<summary>
|
||
Creates remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory path to create.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.CreateDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously requests to create a remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory path to create.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous create directory operation.</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DeleteDirectory(System.String)">
|
||
<summary>
|
||
Deletes remote directory specified by path.
|
||
</summary>
|
||
<param name="path">Directory to be deleted path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DeleteDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DeleteFile(System.String)">
|
||
<summary>
|
||
Deletes remote file specified by path.
|
||
</summary>
|
||
<param name="path">File to be deleted path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to delete the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DeleteFileAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.RenameFile(System.String,System.String)">
|
||
<summary>
|
||
Renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.RenameFile(System.String,System.String,System.Boolean)">
|
||
<summary>
|
||
Renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<param name="isPosix">if set to <see langword="true"/> then perform a posix rename.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath" /> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.RenameFileAsync(System.String,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously renames remote file from old path to new path.
|
||
</summary>
|
||
<param name="oldPath">Path to the old file location.</param>
|
||
<param name="newPath">Path to the new file location.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous rename operation.</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="oldPath"/> is <see langword="null"/>. <para>-or-</para> or <paramref name="newPath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to rename the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SymbolicLink(System.String,System.String)">
|
||
<summary>
|
||
Creates a symbolic link from old path to new path.
|
||
</summary>
|
||
<param name="path">The old path.</param>
|
||
<param name="linkPath">The new path.</param>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="linkPath"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to create the symbolic link was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ListDirectory(System.String,System.Action{System.Int32})">
|
||
<summary>
|
||
Retrieves list of files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="listCallback">The list callback.</param>
|
||
<returns>
|
||
A list of files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ListDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously enumerates the files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
An <see cref="T:System.Collections.Generic.IAsyncEnumerable`1"/> of <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> that represents the asynchronous enumeration operation.
|
||
The enumeration contains an async stream of <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> for the files in the directory specified by <paramref name="path" />.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginListDirectory(System.String,System.AsyncCallback,System.Object,System.Action{System.Int32})">
|
||
<summary>
|
||
Begins an asynchronous operation of retrieving list of files in remote directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="listCallback">The list callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.EndListDirectory(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous operation of retrieving list of files in remote directory.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<returns>
|
||
A list of files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndListDirectory(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Get(System.String)">
|
||
<summary>
|
||
Gets reference to remote file or directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A reference to <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> file object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets reference to remote file or directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the get operation.
|
||
The task result contains the reference to <see cref="T:Renci.SshNet.Sftp.ISftpFile"/> file object.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Exists(System.String)">
|
||
<summary>
|
||
Checks whether file or directory exists.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
<see langword="true"/> if directory or file exists; otherwise <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ExistsAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Checks whether file or directory exists.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the exists operation.
|
||
The task result contains <see langword="true"/> if directory or file exists; otherwise <see langword="false"/>.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message"/> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DownloadFile(System.String,System.IO.Stream,System.Action{System.UInt64})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DownloadFileAsync(System.String,System.IO.Stream,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginDownloadFile(System.String,System.IO.Stream)">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginDownloadFile(System.String,System.IO.Stream,System.AsyncCallback)">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginDownloadFile(System.String,System.IO.Stream,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="downloadCallback">The download callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="output" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
Method calls made by this method to <paramref name="output" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.EndDownloadFile(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous file downloading into the stream.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndDownloadFile(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to perform the operation was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The path was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.UploadFile(System.IO.Stream,System.String,System.Action{System.UInt64})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.UploadFile(System.IO.Stream,System.String,System.Boolean,System.Action{System.UInt64})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.UploadFileAsync(System.IO.Stream,System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginUploadFile(System.IO.Stream,System.String)">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginUploadFile(System.IO.Stream,System.String,System.AsyncCallback)">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginUploadFile(System.IO.Stream,System.String,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to list the contents of the directory was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
If the remote file already exists, it is overwritten and truncated.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginUploadFile(System.IO.Stream,System.String,System.Boolean,System.AsyncCallback,System.Object,System.Action{System.UInt64})">
|
||
<summary>
|
||
Begins an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="input">Data input stream.</param>
|
||
<param name="path">Remote file path.</param>
|
||
<param name="canOverride">Specified whether an existing file can be overwritten.</param>
|
||
<param name="asyncCallback">The method to be called when the asynchronous write operation is completed.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
|
||
<param name="uploadCallback">The upload callback.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="input" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="path" /> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
<para>
|
||
Method calls made by this method to <paramref name="input" />, may under certain conditions result in exceptions thrown by the stream.
|
||
</para>
|
||
<para>
|
||
When <paramref name="path"/> refers to an existing file, set <paramref name="canOverride"/> to <see langword="true"/> to overwrite and truncate that file.
|
||
If <paramref name="canOverride"/> is <see langword="false"/>, the upload will fail and <see cref="M:Renci.SshNet.SftpClient.EndUploadFile(System.IAsyncResult)"/> will throw an
|
||
<see cref="T:Renci.SshNet.Common.SshException"/>.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.EndUploadFile(System.IAsyncResult)">
|
||
<summary>
|
||
Ends an asynchronous uploading the stream into remote file.
|
||
</summary>
|
||
<param name="asyncResult">The pending asynchronous SFTP request.</param>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndUploadFile(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The directory of the file was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPermissionDeniedException">Permission to upload the file was denied by the remote host. <para>-or-</para> A SSH command was denied by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">A SSH error where <see cref="P:System.Exception.Message" /> is the message from the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetStatus(System.String)">
|
||
<summary>
|
||
Gets status using statvfs@openssh.com request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation"/> instance that contains file status information.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetStatusAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously gets status using statvfs@openssh.com request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the status operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation"/> instance that contains file status information.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendAllLines(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>
|
||
Appends lines to a file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
||
<param name="contents">The lines to append to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
The characters are written to the file using UTF-8 encoding without a byte-order mark (BOM).
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendAllLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding)">
|
||
<summary>
|
||
Appends lines to a file by using a specified encoding, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the lines to. The file is created if it does not already exist.</param>
|
||
<param name="contents">The lines to append to the file.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendAllText(System.String,System.String)">
|
||
<summary>
|
||
Appends the specified string to the file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the specified string to.</param>
|
||
<param name="contents">The string to append to the file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendAllText(System.String,System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Appends the specified string to the file, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The file to append the specified string to.</param>
|
||
<param name="contents">The string to append to the file.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="contents"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendText(System.String)">
|
||
<summary>
|
||
Creates a <see cref="T:System.IO.StreamWriter"/> that appends UTF-8 encoded text to the specified file,
|
||
creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The path to the file to append to.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that appends text to a file using UTF-8 encoding without a
|
||
Byte-Order Mark (BOM).
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.AppendText(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Creates a <see cref="T:System.IO.StreamWriter"/> that appends text to a file using the specified
|
||
encoding, creating the file if it does not already exist.
|
||
</summary>
|
||
<param name="path">The path to the file to append to.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamWriter"/> that appends text to a file using the specified encoding.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. <para>-or-</para> <paramref name="encoding"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Create(System.String)">
|
||
<summary>
|
||
Creates or overwrites a file in the specified path.
|
||
</summary>
|
||
<param name="path">The path and name of the file to create.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides read/write access to the file specified in path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the target file already exists, it is first truncated to zero bytes.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Create(System.String,System.Int32)">
|
||
<summary>
|
||
Creates or overwrites the specified file.
|
||
</summary>
|
||
<param name="path">The path and name of the file to create.</param>
|
||
<param name="bufferSize">The maximum number of bytes buffered for reads and writes to the file.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides read/write access to the file specified in path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the target file already exists, it is first truncated to zero bytes.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.CreateText(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.CreateText(System.String,System.Text.Encoding)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Delete(System.String)">
|
||
<summary>
|
||
Deletes the specified file or directory.
|
||
</summary>
|
||
<param name="path">The name of the file or directory to be deleted. Wildcard characters are not supported.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.DeleteAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetLastAccessTime(System.String)">
|
||
<summary>
|
||
Returns the date and time the specified file or directory was last accessed.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain access date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
||
This value is expressed in local time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetLastAccessTimeUtc(System.String)">
|
||
<summary>
|
||
Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last accessed.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain access date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last accessed.
|
||
This value is expressed in UTC time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetLastWriteTime(System.String)">
|
||
<summary>
|
||
Returns the date and time the specified file or directory was last written to.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain write date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
||
This value is expressed in local time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetLastWriteTimeUtc(System.String)">
|
||
<summary>
|
||
Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last written to.
|
||
</summary>
|
||
<param name="path">The file or directory for which to obtain write date and time information.</param>
|
||
<returns>
|
||
A <see cref="T:System.DateTime"/> structure set to the date and time that the specified file or directory was last written to.
|
||
This value is expressed in UTC time.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Open(System.String,System.IO.FileMode)">
|
||
<summary>
|
||
Opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path with read/write access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and read/write access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Open(System.String,System.IO.FileMode,System.IO.FileAccess)">
|
||
<summary>
|
||
Opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path, with the specified mode and access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<param name="access">A <see cref="T:System.IO.FileAccess"/> value that specifies the operations that can be performed on the file.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OpenAsync(System.String,System.IO.FileMode,System.IO.FileAccess,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously opens a <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path, with the specified mode and access.
|
||
</summary>
|
||
<param name="path">The file to open.</param>
|
||
<param name="mode">A <see cref="T:System.IO.FileMode"/> value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
|
||
<param name="access">A <see cref="T:System.IO.FileAccess"/> value that specifies the operations that can be performed on the file.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous open operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> that provides access to the specified file, with the specified mode and access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OpenRead(System.String)">
|
||
<summary>
|
||
Opens an existing file for reading.
|
||
</summary>
|
||
<param name="path">The file to be opened for reading.</param>
|
||
<returns>
|
||
A read-only <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> on the specified path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OpenText(System.String)">
|
||
<summary>
|
||
Opens an existing UTF-8 encoded text file for reading.
|
||
</summary>
|
||
<param name="path">The file to be opened for reading.</param>
|
||
<returns>
|
||
A <see cref="T:System.IO.StreamReader"/> on the specified path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OpenWrite(System.String)">
|
||
<summary>
|
||
Opens a file for writing.
|
||
</summary>
|
||
<param name="path">The file to be opened for writing.</param>
|
||
<returns>
|
||
An unshared <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> object on the specified path with <see cref="F:System.IO.FileAccess.Write"/> access.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
<remarks>
|
||
If the file does not exist, it is created.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadAllBytes(System.String)">
|
||
<summary>
|
||
Opens a binary file, reads the contents of the file into a byte array, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A byte array containing the contents of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadAllLines(System.String)">
|
||
<summary>
|
||
Opens a text file, reads all lines of the file using UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A string array containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadAllLines(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Opens a file, reads all lines of the file with the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<param name="encoding">The encoding applied to the contents of the file.</param>
|
||
<returns>
|
||
A string array containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadAllText(System.String)">
|
||
<summary>
|
||
Opens a text file, reads all lines of the file with the UTF-8 encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<returns>
|
||
A string containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadAllText(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Opens a file, reads all lines of the file with the specified encoding, and closes the file.
|
||
</summary>
|
||
<param name="path">The file to open for reading.</param>
|
||
<param name="encoding">The encoding applied to the contents of the file.</param>
|
||
<returns>
|
||
A string containing all lines of the file.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadLines(System.String)">
|
||
<summary>
|
||
Reads the lines of a file with the UTF-8 encoding.
|
||
</summary>
|
||
<param name="path">The file to read.</param>
|
||
<returns>
|
||
The lines of the file.
|
||
</returns>
|
||
<remarks>
|
||
The lines are enumerated lazily. The opening of the file and any resulting exceptions occur
|
||
upon enumeration.
|
||
</remarks>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. Thrown eagerly.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected upon enumeration.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The return value is enumerated after the client is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.ReadLines(System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Read the lines of a file that has a specified encoding.
|
||
</summary>
|
||
<param name="path">The file to read.</param>
|
||
<param name="encoding">The encoding that is applied to the contents of the file.</param>
|
||
<returns>
|
||
The lines of the file.
|
||
</returns>
|
||
<remarks>
|
||
The lines are enumerated lazily. The opening of the file and any resulting exceptions occur
|
||
upon enumeration.
|
||
</remarks>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>. Thrown eagerly.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected upon enumeration.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The return value is enumerated after the client is disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SetLastAccessTime(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time the specified file was last accessed.
|
||
</summary>
|
||
<param name="path">The file for which to set the access date and time information.</param>
|
||
<param name="lastAccessTime">A <see cref="T:System.DateTime"/> containing the value to set for the last access date and time of path. This value is expressed in local time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SetLastAccessTimeUtc(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time, in coordinated universal time (UTC), that the specified file was last accessed.
|
||
</summary>
|
||
<param name="path">The file for which to set the access date and time information.</param>
|
||
<param name="lastAccessTimeUtc">A <see cref="T:System.DateTime"/> containing the value to set for the last access date and time of path. This value is expressed in UTC time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SetLastWriteTime(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time that the specified file was last written to.
|
||
</summary>
|
||
<param name="path">The file for which to set the date and time information.</param>
|
||
<param name="lastWriteTime">A <see cref="T:System.DateTime"/> containing the value to set for the last write date and time of path. This value is expressed in local time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SetLastWriteTimeUtc(System.String,System.DateTime)">
|
||
<summary>
|
||
Sets the date and time, in coordinated universal time (UTC), that the specified file was last written to.
|
||
</summary>
|
||
<param name="path">The file for which to set the date and time information.</param>
|
||
<param name="lastWriteTimeUtc">A <see cref="T:System.DateTime"/> containing the value to set for the last write date and time of path. This value is expressed in UTC time.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllBytes(System.String,System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllLines(System.String,System.String[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllLines(System.String,System.String[],System.Text.Encoding)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllText(System.String,System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.WriteAllText(System.String,System.String,System.Text.Encoding)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetAttributes(System.String)">
|
||
<summary>
|
||
Gets the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<returns>
|
||
The <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.GetAttributesAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Gets the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>
|
||
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the attribute retrieval operation.
|
||
The task result contains the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the path.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SetAttributes(System.String,Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<summary>
|
||
Sets the specified <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file on the specified path.
|
||
</summary>
|
||
<param name="path">The path to the file.</param>
|
||
<param name="fileAttributes">The desired <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/>.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the client was disposed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.SynchronizeDirectories(System.String,System.String,System.String)">
|
||
<summary>
|
||
Synchronizes the directories.
|
||
</summary>
|
||
<param name="sourcePath">The source path.</param>
|
||
<param name="destinationPath">The destination path.</param>
|
||
<param name="searchPattern">The search pattern.</param>
|
||
<returns>
|
||
A list of uploaded files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="sourcePath"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException"><paramref name="destinationPath"/> was not found on the remote host.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">If a problem occurs while copying the file.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.BeginSynchronizeDirectories(System.String,System.String,System.String,System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Begins the synchronize directories.
|
||
</summary>
|
||
<param name="sourcePath">The source path.</param>
|
||
<param name="destinationPath">The destination path.</param>
|
||
<param name="searchPattern">The search pattern.</param>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous directory synchronization.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="sourcePath"/> or <paramref name="searchPattern"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="destinationPath"/> is <see langword="null"/> or contains only whitespace.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">If a problem occurs while copying the file.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.EndSynchronizeDirectories(System.IAsyncResult)">
|
||
<summary>
|
||
Ends the synchronize directories.
|
||
</summary>
|
||
<param name="asyncResult">The async result.</param>
|
||
<returns>
|
||
A list of uploaded files.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentException">The <see cref="T:System.IAsyncResult"/> object did not come from the corresponding async method on this type.<para>-or-</para><see cref="M:Renci.SshNet.SftpClient.EndSynchronizeDirectories(System.IAsyncResult)"/> was called multiple times with the same <see cref="T:System.IAsyncResult"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SftpPathNotFoundException">The destination path was not found on the remote host.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.InternalListDirectory(System.String,Renci.SshNet.Sftp.SftpListDirectoryAsyncResult,System.Action{System.Int32})">
|
||
<summary>
|
||
Internals the list directory.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="asyncResult">An <see cref="T:System.IAsyncResult"/> that references the asynchronous request.</param>
|
||
<param name="listCallback">The list callback.</param>
|
||
<returns>
|
||
A list of files in the specified directory.
|
||
</returns>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="path" /> is <see langword="null"/>.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client not connected.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OnConnected">
|
||
<summary>
|
||
Called when client is connected to the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SftpClient.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.None">
|
||
<summary>
|
||
None.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.Read">
|
||
<summary>
|
||
SSH_FXF_READ.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.Write">
|
||
<summary>
|
||
SSH_FXF_WRITE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.Append">
|
||
<summary>
|
||
SSH_FXF_APPEND.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.CreateNewOrOpen">
|
||
<summary>
|
||
SSH_FXF_CREAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.Truncate">
|
||
<summary>
|
||
SSH_FXF_TRUNC.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.Flags.CreateNew">
|
||
<summary>
|
||
SSH_FXF_EXCL.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.ISftpFile">
|
||
<summary>
|
||
Represents SFTP file information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.Attributes">
|
||
<summary>
|
||
Gets the file attributes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.FullName">
|
||
<summary>
|
||
Gets the full path of the file or directory.
|
||
</summary>
|
||
<value>
|
||
The full path of the file or directory.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.Name">
|
||
<summary>
|
||
Gets the name of the file or directory.
|
||
</summary>
|
||
<value>
|
||
The name of the file or directory.
|
||
</value>
|
||
<remarks>
|
||
For directories, this is the name of the last directory in the hierarchy if a hierarchy exists;
|
||
otherwise, the name of the directory.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.LastAccessTime">
|
||
<summary>
|
||
Gets or sets the time the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.LastWriteTime">
|
||
<summary>
|
||
Gets or sets the time when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.LastAccessTimeUtc">
|
||
<summary>
|
||
Gets or sets the time, in coordinated universal time (UTC), the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.LastWriteTimeUtc">
|
||
<summary>
|
||
Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.Length">
|
||
<summary>
|
||
Gets the size, in bytes, of the current file.
|
||
</summary>
|
||
<value>
|
||
The size of the current file in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.UserId">
|
||
<summary>
|
||
Gets or sets file user id.
|
||
</summary>
|
||
<value>
|
||
File user id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.GroupId">
|
||
<summary>
|
||
Gets or sets file group id.
|
||
</summary>
|
||
<value>
|
||
File group id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsSocket">
|
||
<summary>
|
||
Gets a value indicating whether file represents a socket.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a socket; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsSymbolicLink">
|
||
<summary>
|
||
Gets a value indicating whether file represents a symbolic link.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a symbolic link; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsRegularFile">
|
||
<summary>
|
||
Gets a value indicating whether file represents a regular file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a regular file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsBlockDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a block device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a block device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsDirectory">
|
||
<summary>
|
||
Gets a value indicating whether file represents a directory.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a directory; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsCharacterDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a character device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a character device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.IsNamedPipe">
|
||
<summary>
|
||
Gets a value indicating whether file represents a named pipe.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a named pipe; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OwnerCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OwnerCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OwnerCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.GroupCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.GroupCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.GroupCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OthersCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OthersCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpFile.OthersCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpFile.SetPermissions(System.Int16)">
|
||
<summary>
|
||
Sets file permissions.
|
||
</summary>
|
||
<param name="mode">The mode.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpFile.Delete">
|
||
<summary>
|
||
Permanently deletes a file on remote machine.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpFile.DeleteAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Permanently deletes a file on the remote machine.
|
||
</summary>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous delete operation.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpFile.MoveTo(System.String)">
|
||
<summary>
|
||
Moves a specified file to a new location on remote machine, providing the option to specify a new file name.
|
||
</summary>
|
||
<param name="destFileName">The path to move the file to, which can specify a different file name.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="destFileName"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpFile.UpdateStatus">
|
||
<summary>
|
||
Updates file status on the server.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.ISftpResponseFactory">
|
||
<summary>
|
||
Represents a factory for creating SFTP response messages.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpResponseFactory.Create(System.UInt32,System.Byte,System.Text.Encoding)">
|
||
<summary>
|
||
Creates a SFTP response message for the specified protocol version and message type, and
|
||
with the specified <see cref="T:System.Text.Encoding"/>.
|
||
</summary>
|
||
<param name="protocolVersion">The protocol version.</param>
|
||
<param name="messageType">The message type.</param>
|
||
<param name="encoding">The <see cref="T:System.Text.Encoding"/>.</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpMessage"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.ISftpSession">
|
||
<summary>
|
||
Represents an SFTP session.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpSession.ProtocolVersion">
|
||
<summary>
|
||
Gets the SFTP protocol version.
|
||
</summary>
|
||
<value>
|
||
The SFTP protocol version.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.ISftpSession.WorkingDirectory">
|
||
<summary>
|
||
Gets the remote working directory.
|
||
</summary>
|
||
<value>
|
||
The remote working directory.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.ChangeDirectory(System.String)">
|
||
<summary>
|
||
Changes the current working directory to the specified path.
|
||
</summary>
|
||
<param name="path">The new working directory.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.ChangeDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously requests to change the current working directory to the specified path.
|
||
</summary>
|
||
<param name="path">The new working directory.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that tracks the asynchronous change working directory request.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.GetCanonicalPath(System.String)">
|
||
<summary>
|
||
Resolves a given path into an absolute path on the server.
|
||
</summary>
|
||
<param name="path">The path to resolve.</param>
|
||
<returns>
|
||
The absolute path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.GetCanonicalPathAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously resolves a given path into an absolute path on the server.
|
||
</summary>
|
||
<param name="path">The path to resolve.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents an asynchronous operation to resolve <paramref name="path"/> into
|
||
an absolute path. The value of its <see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the absolute
|
||
path of the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestFStat(System.Byte[])">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_FSTAT</c> request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<returns>
|
||
The file attributes.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestFStatAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_FSTAT</c> request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task the represents the asynchronous <c>SSH_FXP_FSTAT</c> request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the file attributes of the specified handle.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestStat(System.String)">
|
||
<summary>
|
||
Performs SSH_FXP_STAT request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
File attributes.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestLStat(System.String)">
|
||
<summary>
|
||
Performs SSH_FXP_LSTAT request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
File attributes.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestLStatAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs SSH_FXP_LSTAT request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task the represents the asynchronous <c>SSH_FXP_LSTAT</c> request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the file attributes of the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestMkDir(System.String)">
|
||
<summary>
|
||
Performs SSH_FXP_MKDIR request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestMkDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs SSH_FXP_MKDIR request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to observe.</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous <c>SSH_FXP_MKDIR</c> operation.</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestOpen(System.String,Renci.SshNet.Sftp.Flags)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_OPEN</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="flags">The flags.</param>
|
||
<returns>
|
||
The file handle for the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestOpenAsync(System.String,Renci.SshNet.Sftp.Flags,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_OPEN</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="flags">The flags.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task the represents the asynchronous <c>SSH_FXP_OPEN</c> request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the file handle of the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestOpenDir(System.String)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_OPENDIR</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
A file handle for the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestOpenDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_OPENDIR</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_OPENDIR</c> request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the handle of the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestPosixRename(System.String,System.String)">
|
||
<summary>
|
||
Performs posix-rename@openssh.com extended request.
|
||
</summary>
|
||
<param name="oldPath">The old path.</param>
|
||
<param name="newPath">The new path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRead(System.Byte[],System.UInt64,System.UInt32)">
|
||
<summary>
|
||
Performs SSH_FXP_READ request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="offset">The offset.</param>
|
||
<param name="length">The length.</param>
|
||
<returns>
|
||
The data that was read, or an empty array when the end of the file was reached.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestReadAsync(System.Byte[],System.UInt64,System.UInt32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_READ</c> request.
|
||
</summary>
|
||
<param name="handle">The handle to the file to read from.</param>
|
||
<param name="offset">The offset in the file to start reading from.</param>
|
||
<param name="length">The number of bytes to read.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_READ</c> request. The value of
|
||
its <see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the data read from the file, or an empty
|
||
array when the end of the file is reached.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestReadDir(System.Byte[])">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_READDIR</c> request.
|
||
</summary>
|
||
<param name="handle">The handle of the directory to read.</param>
|
||
<returns>
|
||
A <see cref="T:System.Collections.Generic.Dictionary`2"/> where the <c>key</c> is the name of a file in the directory
|
||
and the <c>value</c> is the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestReadDirAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_READDIR</c> request.
|
||
</summary>
|
||
<param name="handle">The handle of the directory to read.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_READDIR</c> request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains a <see cref="T:System.Collections.Generic.Dictionary`2"/> where the
|
||
<c>key</c> is the name of a file in the directory and the <c>value</c> is the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/>
|
||
of the file.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRemove(System.String)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_REMOVE</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRemoveAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_REMOVE</c> request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_REMOVE</c> request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRename(System.String,System.String)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_RENAME</c> request.
|
||
</summary>
|
||
<param name="oldPath">The old path.</param>
|
||
<param name="newPath">The new path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRenameAsync(System.String,System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>SSH_FXP_RENAME</c> request.
|
||
</summary>
|
||
<param name="oldPath">The old path.</param>
|
||
<param name="newPath">The new path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_RENAME</c> request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRmDir(System.String)">
|
||
<summary>
|
||
Performs SSH_FXP_RMDIR request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestRmDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs an SSH_FXP_RMDIR request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_RMDIR</c> request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestSetStat(System.String,Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<summary>
|
||
Performs SSH_FXP_SETSTAT request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="attributes">The attributes.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestStatVfs(System.String)">
|
||
<summary>
|
||
Performs a <c>statvfs@openssh.com</c> extended request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<returns>
|
||
The file system information for the specified path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestStatVfsAsync(System.String,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronously performs a <c>statvfs@openssh.com</c> extended request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the <c>statvfs@openssh.com</c> extended request. The value of its
|
||
<see cref="P:System.Threading.Tasks.Task`1.Result"/> contains the file system information for the specified
|
||
path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestSymLink(System.String,System.String)">
|
||
<summary>
|
||
Performs SSH_FXP_SYMLINK request.
|
||
</summary>
|
||
<param name="linkpath">The linkpath.</param>
|
||
<param name="targetpath">The targetpath.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestFSetStat(System.Byte[],Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<summary>
|
||
Performs SSH_FXP_FSETSTAT request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="attributes">The attributes.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestWrite(System.Byte[],System.UInt64,System.Byte[],System.Int32,System.Int32,System.Threading.AutoResetEvent,System.Action{Renci.SshNet.Sftp.Responses.SftpStatusResponse})">
|
||
<summary>
|
||
Performs SSH_FXP_WRITE request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="serverOffset">The the zero-based offset (in bytes) relative to the beginning of the file that the write must start at.</param>
|
||
<param name="data">The buffer holding the data to write.</param>
|
||
<param name="offset">the zero-based offset in <paramref name="data" /> at which to begin taking bytes to write.</param>
|
||
<param name="length">The length (in bytes) of the data to write.</param>
|
||
<param name="wait">The wait event handle if needed.</param>
|
||
<param name="writeCompleted">The callback to invoke when the write has completed.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestWriteAsync(System.Byte[],System.UInt64,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<summary>
|
||
Asynchronouly performs a <c>SSH_FXP_WRITE</c> request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="serverOffset">The the zero-based offset (in bytes) relative to the beginning of the file that the write must start at.</param>
|
||
<param name="data">The buffer holding the data to write.</param>
|
||
<param name="offset">the zero-based offset in <paramref name="data" /> at which to begin taking bytes to write.</param>
|
||
<param name="length">The length (in bytes) of the data to write.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_WRITE</c> request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestClose(System.Byte[])">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_CLOSE</c> request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.RequestCloseAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<summary>
|
||
Performs a <c>SSH_FXP_CLOSE</c> request.
|
||
</summary>
|
||
<param name="handle">The handle.</param>
|
||
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
|
||
<returns>
|
||
A task that represents the asynchronous <c>SSH_FXP_CLOSE</c> request.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.CalculateOptimalReadLength(System.UInt32)">
|
||
<summary>
|
||
Calculates the optimal size of the buffer to read data from the channel.
|
||
</summary>
|
||
<param name="bufferSize">The buffer size configured on the client.</param>
|
||
<returns>
|
||
The optimal size of the buffer to read data from the channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.ISftpSession.CalculateOptimalWriteLength(System.UInt32,System.Byte[])">
|
||
<summary>
|
||
Calculates the optimal size of the buffer to write data on the channel.
|
||
</summary>
|
||
<param name="bufferSize">The buffer size configured on the client.</param>
|
||
<param name="handle">The file handle.</param>
|
||
<returns>
|
||
The optimal size of the buffer to write data on the channel.
|
||
</returns>
|
||
<remarks>
|
||
Currently, we do not take the remote window size into account.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.FStatVfsRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.HardLinkRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.PosixRenameRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.StatVfsRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpBlockRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpCloseRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpExtendedRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpFSetStatRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpFStatRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpInitRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpLinkRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.Requests.SftpLinkRequest.#ctor(System.UInt32,System.UInt32,System.String,System.String,System.Boolean,System.Action{Renci.SshNet.Sftp.Responses.SftpStatusResponse})">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.Requests.SftpLinkRequest" /> class.
|
||
</summary>
|
||
<param name="protocolVersion">The protocol version.</param>
|
||
<param name="requestId">The request id.</param>
|
||
<param name="newLinkPath">Specifies the path name of the new link to create.</param>
|
||
<param name="existingPath">Specifies the path of a target object to which the newly created link will refer. In the case of a symbolic link, this path may not exist.</param>
|
||
<param name="isSymLink">if set to <see langword="false"/> the link should be a hard link, or a second directory entry referring to the same file or directory object.</param>
|
||
<param name="statusAction">The status action.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpLStatRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpMkDirRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpOpenDirRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpOpenRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpReadDirRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpReadLinkRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpReadRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpRealPathRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpRemoveRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpRenameRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpRmDirRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpSetStatRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpStatRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpSymLinkRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpUnblockRequest.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.ServerFileOffset">
|
||
<summary>
|
||
Gets the zero-based offset (in bytes) relative to the beginning of the file that the write
|
||
must start at.
|
||
</summary>
|
||
<value>
|
||
The zero-based offset (in bytes) relative to the beginning of the file that the write must
|
||
start at.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.Data">
|
||
<summary>
|
||
Gets the buffer holding the data to write.
|
||
</summary>
|
||
<value>
|
||
The buffer holding the data to write.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.Offset">
|
||
<summary>
|
||
Gets the zero-based offset in <see cref="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.Data" /> at which to begin taking bytes to
|
||
write.
|
||
</summary>
|
||
<value>
|
||
The zero-based offset in <see cref="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.Data" /> at which to begin taking bytes to write.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.Requests.SftpWriteRequest.Length">
|
||
<summary>
|
||
Gets the length (in bytes) of the data to write.
|
||
</summary>
|
||
<value>
|
||
The length (in bytes) of the data to write.
|
||
</value>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.Responses.IExtendedReplyInfo">
|
||
<summary>
|
||
Extended Reply Info.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.Responses.IExtendedReplyInfo.LoadData(Renci.SshNet.Common.SshDataStream)">
|
||
<summary>
|
||
Loads the data from the stream into the instance.
|
||
</summary>
|
||
<param name="stream">The stream.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpDownloadAsyncResult">
|
||
<summary>
|
||
Encapsulates the results of an asynchronous download operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpDownloadAsyncResult.IsDownloadCanceled">
|
||
<summary>
|
||
Gets or sets a value indicating whether to cancel asynchronous download operation.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if download operation to be canceled; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<remarks>
|
||
Download operation will be canceled after finishing uploading current buffer.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpDownloadAsyncResult.DownloadedBytes">
|
||
<summary>
|
||
Gets the number of downloaded bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpDownloadAsyncResult.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpDownloadAsyncResult"/> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpDownloadAsyncResult.Update(System.UInt64)">
|
||
<summary>
|
||
Updates asynchronous operation status information.
|
||
</summary>
|
||
<param name="downloadedBytes">Number of downloaded bytes.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpFile">
|
||
<summary>
|
||
Represents SFTP file information.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.Attributes">
|
||
<summary>
|
||
Gets the file attributes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.#ctor(Renci.SshNet.Sftp.ISftpSession,System.String,Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpFile"/> class.
|
||
</summary>
|
||
<param name="sftpSession">The SFTP session.</param>
|
||
<param name="fullName">Full path of the directory or file.</param>
|
||
<param name="attributes">Attributes of the directory or file.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="sftpSession"/> or <paramref name="fullName"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.FullName">
|
||
<summary>
|
||
Gets the full path of the file or directory.
|
||
</summary>
|
||
<value>
|
||
The full path of the file or directory.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.Name">
|
||
<summary>
|
||
Gets the name of the file or directory.
|
||
</summary>
|
||
<value>
|
||
The name of the file or directory.
|
||
</value>
|
||
<remarks>
|
||
For directories, this is the name of the last directory in the hierarchy if a hierarchy exists;
|
||
otherwise, the name of the directory.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.LastAccessTime">
|
||
<summary>
|
||
Gets or sets the time the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.LastWriteTime">
|
||
<summary>
|
||
Gets or sets the time when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.LastAccessTimeUtc">
|
||
<summary>
|
||
Gets or sets the time, in coordinated universal time (UTC), the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.LastWriteTimeUtc">
|
||
<summary>
|
||
Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.Length">
|
||
<summary>
|
||
Gets the size, in bytes, of the current file.
|
||
</summary>
|
||
<value>
|
||
The size of the current file in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.UserId">
|
||
<summary>
|
||
Gets or sets file user id.
|
||
</summary>
|
||
<value>
|
||
File user id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.GroupId">
|
||
<summary>
|
||
Gets or sets file group id.
|
||
</summary>
|
||
<value>
|
||
File group id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsSocket">
|
||
<summary>
|
||
Gets a value indicating whether file represents a socket.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a socket; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsSymbolicLink">
|
||
<summary>
|
||
Gets a value indicating whether file represents a symbolic link.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a symbolic link; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsRegularFile">
|
||
<summary>
|
||
Gets a value indicating whether file represents a regular file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a regular file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsBlockDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a block device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a block device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsDirectory">
|
||
<summary>
|
||
Gets a value indicating whether file represents a directory.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a directory; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsCharacterDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a character device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a character device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.IsNamedPipe">
|
||
<summary>
|
||
Gets a value indicating whether file represents a named pipe.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a named pipe; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OwnerCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OwnerCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OwnerCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.GroupCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.GroupCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.GroupCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OthersCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OthersCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFile.OthersCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.SetPermissions(System.Int16)">
|
||
<summary>
|
||
Sets file permissions.
|
||
</summary>
|
||
<param name="mode">The mode.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.Delete">
|
||
<summary>
|
||
Permanently deletes a file on remote machine.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.DeleteAsync(System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.MoveTo(System.String)">
|
||
<summary>
|
||
Moves a specified file to a new location on remote machine, providing the option to specify a new file name.
|
||
</summary>
|
||
<param name="destFileName">The path to move the file to, which can specify a different file name.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="destFileName"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.UpdateStatus">
|
||
<summary>
|
||
Updates file status on the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFile.ToString">
|
||
<summary>
|
||
Returns a <see cref="T:System.String"/> that represents this instance.
|
||
</summary>
|
||
<returns>
|
||
A <see cref="T:System.String"/> that represents this instance.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpFileAttributes">
|
||
<summary>
|
||
Contains SFTP file attributes.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.LastAccessTime">
|
||
<summary>
|
||
Gets or sets the local time the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The local time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.LastWriteTime">
|
||
<summary>
|
||
Gets or sets the local time when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The local time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.LastAccessTimeUtc">
|
||
<summary>
|
||
Gets or sets the UTC time the current file or directory was last accessed.
|
||
</summary>
|
||
<value>
|
||
The UTC time that the current file or directory was last accessed.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.LastWriteTimeUtc">
|
||
<summary>
|
||
Gets or sets the UTC time when the current file or directory was last written to.
|
||
</summary>
|
||
<value>
|
||
The UTC time the current file was last written.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.Size">
|
||
<summary>
|
||
Gets or sets the size, in bytes, of the current file.
|
||
</summary>
|
||
<value>
|
||
The size of the current file in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.UserId">
|
||
<summary>
|
||
Gets or sets file user id.
|
||
</summary>
|
||
<value>
|
||
File user id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.GroupId">
|
||
<summary>
|
||
Gets or sets file group id.
|
||
</summary>
|
||
<value>
|
||
File group id.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsSocket">
|
||
<summary>
|
||
Gets a value indicating whether file represents a socket.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a socket; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsSymbolicLink">
|
||
<summary>
|
||
Gets a value indicating whether file represents a symbolic link.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a symbolic link; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsRegularFile">
|
||
<summary>
|
||
Gets a value indicating whether file represents a regular file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a regular file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsBlockDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a block device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a block device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsDirectory">
|
||
<summary>
|
||
Gets a value indicating whether file represents a directory.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a directory; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsCharacterDevice">
|
||
<summary>
|
||
Gets a value indicating whether file represents a character device.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a character device; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsNamedPipe">
|
||
<summary>
|
||
Gets a value indicating whether file represents a named pipe.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if file represents a named pipe; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsUIDBitSet">
|
||
<summary>
|
||
Gets or sets a value indicating whether the setuid bit is set.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the setuid bit is set; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsGroupIDBitSet">
|
||
<summary>
|
||
Gets or sets a value indicating whether the setgid bit is set.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the setgid bit is set; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.IsStickyBitSet">
|
||
<summary>
|
||
Gets or sets a value indicating whether the sticky bit is set.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the sticky bit is set; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OwnerCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OwnerCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OwnerCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the owner can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if owner can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.GroupCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.GroupCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.GroupCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the group members can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if group members can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OthersCanRead">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can read from this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can read from this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OthersCanWrite">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can write into this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can write into this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.OthersCanExecute">
|
||
<summary>
|
||
Gets or sets a value indicating whether the others can execute this file.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if others can execute this file; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileAttributes.Extensions">
|
||
<summary>
|
||
Gets the extensions.
|
||
</summary>
|
||
<value>
|
||
The extensions.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileAttributes.SetPermissions(System.Int16)">
|
||
<summary>
|
||
Sets the POSIX permissions for this file.
|
||
</summary>
|
||
<param name="mode">
|
||
The permission mode as an octal number (e.g., <c>755</c>, <c>644</c>, <c>1777</c>).
|
||
</param>
|
||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||
<paramref name="mode"/> has more than 4 digits or cannot be interpreted as an octal number.
|
||
</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileAttributes.ToString">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileAttributes.GetBytes">
|
||
<summary>
|
||
Returns a byte array representing the current <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/>.
|
||
</summary>
|
||
<returns>
|
||
A byte array representing the current <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/>.
|
||
</returns>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpFileStream">
|
||
<summary>
|
||
Exposes a <see cref="T:System.IO.Stream"/> around a remote SFTP file, supporting
|
||
both synchronous and asynchronous read and write operations.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.SftpFileReader.#ctor(System.Byte[],Renci.SshNet.Sftp.ISftpSession,System.Int32,System.Int64,System.Int32,System.Nullable{System.UInt64},System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpFileStream.SftpFileReader"/> class with the specified handle,
|
||
<see cref="T:Renci.SshNet.Sftp.ISftpSession"/> and the maximum number of pending reads.
|
||
</summary>
|
||
<param name="handle">The file handle.</param>
|
||
<param name="sftpSession">The SFTP session.</param>
|
||
<param name="chunkSize">The size of a individual read-ahead chunk.</param>
|
||
<param name="position">The starting offset in the file.</param>
|
||
<param name="maxPendingReads">The maximum number of pending reads.</param>
|
||
<param name="fileSize">The size of the file, if known; otherwise, <see langword="null"/>.</param>
|
||
<param name="initialMaxRequests">The initial number of pending reads.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.CanRead">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.CanSeek">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.CanWrite">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.CanTimeout">
|
||
<summary>
|
||
Gets a value indicating whether timeout properties are usable for <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/>.
|
||
</summary>
|
||
<value>
|
||
<see langword="false"/> in all cases.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.Length">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.Position">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.Name">
|
||
<summary>
|
||
Gets the name of the path that was used to construct the current <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/>.
|
||
</summary>
|
||
<value>
|
||
The name of the path that was used to construct the current <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.Handle">
|
||
<summary>
|
||
Gets the operating system file handle for the file that the current <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> encapsulates.
|
||
</summary>
|
||
<value>
|
||
The operating system file handle for the file that the current <see cref="T:Renci.SshNet.Sftp.SftpFileStream"/> encapsulates.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileStream.Timeout">
|
||
<summary>
|
||
Gets or sets the operation timeout.
|
||
</summary>
|
||
<value>
|
||
The timeout.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Flush">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.FlushAsync(System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Read(System.Span{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.ReadByte">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.EndRead(System.IAsyncResult)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Write(System.ReadOnlySpan{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.WriteByte(System.Byte)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.EndWrite(System.IAsyncResult)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.SetLength(System.Int64)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileStream.DisposeAsync">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpFileSystemInformation">
|
||
<summary>
|
||
Contains file system information exposed by statvfs@openssh.com request.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.FileSystemBlockSize">
|
||
<summary>
|
||
Gets the file system block size.
|
||
</summary>
|
||
<value>
|
||
The file system block size.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.BlockSize">
|
||
<summary>
|
||
Gets the fundamental file system size of the block.
|
||
</summary>
|
||
<value>
|
||
The fundamental file system block size.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.TotalBlocks">
|
||
<summary>
|
||
Gets the total blocks.
|
||
</summary>
|
||
<value>
|
||
The total blocks.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.FreeBlocks">
|
||
<summary>
|
||
Gets the free blocks.
|
||
</summary>
|
||
<value>
|
||
The free blocks.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.AvailableBlocks">
|
||
<summary>
|
||
Gets the available blocks.
|
||
</summary>
|
||
<value>
|
||
The available blocks.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.TotalNodes">
|
||
<summary>
|
||
Gets the total nodes.
|
||
</summary>
|
||
<value>
|
||
The total nodes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.FreeNodes">
|
||
<summary>
|
||
Gets the free nodes.
|
||
</summary>
|
||
<value>
|
||
The free nodes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.AvailableNodes">
|
||
<summary>
|
||
Gets the available nodes.
|
||
</summary>
|
||
<value>
|
||
The available nodes.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.Sid">
|
||
<summary>
|
||
Gets the sid.
|
||
</summary>
|
||
<value>
|
||
The sid.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.IsReadOnly">
|
||
<summary>
|
||
Gets a value indicating whether this instance is read only.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this instance is read only; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.SupportsSetUid">
|
||
<summary>
|
||
Gets a value indicating whether [supports set uid].
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if [supports set uid]; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpFileSystemInformation.MaxNameLenght">
|
||
<summary>
|
||
Gets the max name length.
|
||
</summary>
|
||
<value>
|
||
The max name length.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpFileSystemInformation.#ctor(System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64,System.UInt64)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation" /> class.
|
||
</summary>
|
||
<param name="bsize">The bsize.</param>
|
||
<param name="frsize">The frsize.</param>
|
||
<param name="blocks">The blocks.</param>
|
||
<param name="bfree">The bfree.</param>
|
||
<param name="bavail">The bavail.</param>
|
||
<param name="files">The files.</param>
|
||
<param name="ffree">The ffree.</param>
|
||
<param name="favail">The favail.</param>
|
||
<param name="sid">The sid.</param>
|
||
<param name="flag">The flag.</param>
|
||
<param name="namemax">The namemax.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpListDirectoryAsyncResult">
|
||
<summary>
|
||
Encapsulates the results of an asynchronous directory list operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpListDirectoryAsyncResult.FilesRead">
|
||
<summary>
|
||
Gets the number of files read so far.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpListDirectoryAsyncResult.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpListDirectoryAsyncResult"/> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpListDirectoryAsyncResult.Update(System.Int32)">
|
||
<summary>
|
||
Updates asynchronous operation status information.
|
||
</summary>
|
||
<param name="filesRead">The files read.</param>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpMessage.BufferCapacity">
|
||
<summary>
|
||
Gets the size of the message in bytes.
|
||
</summary>
|
||
<value>
|
||
The size of the messages in bytes.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpMessage.WriteBytes(Renci.SshNet.Common.SshDataStream)">
|
||
<summary>
|
||
Writes the current message to the specified <see cref="T:Renci.SshNet.Common.SshDataStream"/>.
|
||
</summary>
|
||
<param name="stream">The <see cref="T:Renci.SshNet.Common.SshDataStream"/> to write the message to.</param>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Init">
|
||
<summary>
|
||
SSH_FXP_INIT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Version">
|
||
<summary>
|
||
SSH_FXP_VERSION.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Open">
|
||
<summary>
|
||
SSH_FXP_OPEN.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Close">
|
||
<summary>
|
||
SSH_FXP_CLOSE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Read">
|
||
<summary>
|
||
SSH_FXP_READ.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Write">
|
||
<summary>
|
||
SSH_FXP_WRITE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.LStat">
|
||
<summary>
|
||
SSH_FXP_LSTAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.FStat">
|
||
<summary>
|
||
SSH_FXP_FSTAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.SetStat">
|
||
<summary>
|
||
SSH_FXP_SETSTAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.FSetStat">
|
||
<summary>
|
||
SSH_FXP_FSETSTAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.OpenDir">
|
||
<summary>
|
||
SSH_FXP_OPENDIR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.ReadDir">
|
||
<summary>
|
||
SSH_FXP_READDIR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Remove">
|
||
<summary>
|
||
SSH_FXP_REMOVE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.MkDir">
|
||
<summary>
|
||
SSH_FXP_MKDIR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.RmDir">
|
||
<summary>
|
||
SSH_FXP_RMDIR.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.RealPath">
|
||
<summary>
|
||
SSH_FXP_REALPATH.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Stat">
|
||
<summary>
|
||
SSH_FXP_STAT.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Rename">
|
||
<summary>
|
||
SSH_FXP_RENAME.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.ReadLink">
|
||
<summary>
|
||
SSH_FXP_READLINK.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.SymLink">
|
||
<summary>
|
||
SSH_FXP_SYMLINK.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Link">
|
||
<summary>
|
||
SSH_FXP_LINK.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Block">
|
||
<summary>
|
||
SSH_FXP_BLOCK.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Unblock">
|
||
<summary>
|
||
SSH_FXP_UNBLOCK.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Status">
|
||
<summary>
|
||
SSH_FXP_STATUS.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Handle">
|
||
<summary>
|
||
SSH_FXP_HANDLE.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Data">
|
||
<summary>
|
||
SSH_FXP_DATA.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Name">
|
||
<summary>
|
||
SSH_FXP_NAME.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Attrs">
|
||
<summary>
|
||
SSH_FXP_ATTRS.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.Extended">
|
||
<summary>
|
||
SSH_FXP_EXTENDED.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.SftpMessageTypes.ExtendedReply">
|
||
<summary>
|
||
SSH_FXP_EXTENDED_REPLY.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpSession">
|
||
<summary>
|
||
Represents an SFTP session.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpSession.WorkingDirectory">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpSession.ProtocolVersion">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpSession.NextRequestId">
|
||
<summary>
|
||
Gets the next request id for sftp session.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.#ctor(Renci.SshNet.ISession,System.Int32,System.Text.Encoding,Renci.SshNet.Sftp.ISftpResponseFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpSession"/> class.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="operationTimeout">The operation timeout.</param>
|
||
<param name="encoding">The character encoding to use.</param>
|
||
<param name="sftpResponseFactory">The factory to create SFTP responses.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.ChangeDirectory(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.ChangeDirectoryAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.GetCanonicalPath(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.GetCanonicalPathAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestOpen(System.String,Renci.SshNet.Sftp.Flags)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestOpenAsync(System.String,Renci.SshNet.Sftp.Flags,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestClose(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestCloseAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRead(System.Byte[],System.UInt64,System.UInt32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestReadAsync(System.Byte[],System.UInt64,System.UInt32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestWrite(System.Byte[],System.UInt64,System.Byte[],System.Int32,System.Int32,System.Threading.AutoResetEvent,System.Action{Renci.SshNet.Sftp.Responses.SftpStatusResponse})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestWriteAsync(System.Byte[],System.UInt64,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestLStat(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestLStatAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestFStat(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestFStatAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestSetStat(System.String,Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestFSetStat(System.Byte[],Renci.SshNet.Sftp.SftpFileAttributes)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestOpenDir(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestOpenDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestReadDir(System.Byte[])">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestReadDirAsync(System.Byte[],System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRemove(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRemoveAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestMkDir(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestMkDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRmDir(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRmDirAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRealPath(System.String,System.Boolean)">
|
||
<summary>
|
||
Performs SSH_FXP_REALPATH request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="nullOnError">if set to <see langword="true"/> returns null instead of throwing an exception.</param>
|
||
<returns>
|
||
The absolute path.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestStat(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRename(System.String,System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestRenameAsync(System.String,System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestReadLink(System.String,System.Boolean)">
|
||
<summary>
|
||
Performs SSH_FXP_READLINK request.
|
||
</summary>
|
||
<param name="path">The path.</param>
|
||
<param name="nullOnError">if set to <see langword="true"/> returns <see langword="null"/> instead of throwing an exception.</param>
|
||
<returns>
|
||
An array of <see cref="T:System.Collections.Generic.KeyValuePair`2"/> where the <c>key</c> is the name of
|
||
a file and the <c>value</c> is the <see cref="T:Renci.SshNet.Sftp.SftpFileAttributes"/> of the file.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestSymLink(System.String,System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestPosixRename(System.String,System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestStatVfs(System.String)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestStatVfsAsync(System.String,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.RequestFStatVfs(System.Byte[],System.Boolean)">
|
||
<summary>
|
||
Performs fstatvfs@openssh.com extended request.
|
||
</summary>
|
||
<param name="handle">The file handle.</param>
|
||
<param name="nullOnError">if set to <see langword="true"/> [null on error].</param>
|
||
<returns>
|
||
A <see cref="T:Renci.SshNet.Sftp.SftpFileSystemInformation"/> for the specified path.
|
||
</returns>
|
||
<exception cref="T:System.NotSupportedException">This operation is not supported for the current SFTP protocol version.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.HardLink(System.String,System.String)">
|
||
<summary>
|
||
Performs hardlink@openssh.com extended request.
|
||
</summary>
|
||
<param name="oldPath">The old path.</param>
|
||
<param name="newPath">The new path.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.CalculateOptimalReadLength(System.UInt32)">
|
||
<summary>
|
||
Calculates the optimal size of the buffer to read data from the channel.
|
||
</summary>
|
||
<param name="bufferSize">The buffer size configured on the client.</param>
|
||
<returns>
|
||
The optimal size of the buffer to read data from the channel.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSession.CalculateOptimalWriteLength(System.UInt32,System.Byte[])">
|
||
<summary>
|
||
Calculates the optimal size of the buffer to write data on the channel.
|
||
</summary>
|
||
<param name="bufferSize">The buffer size configured on the client.</param>
|
||
<param name="handle">The file handle.</param>
|
||
<returns>
|
||
The optimal size of the buffer to write data on the channel.
|
||
</returns>
|
||
<remarks>
|
||
Currently, we do not take the remote window size into account.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpSynchronizeDirectoriesAsyncResult">
|
||
<summary>
|
||
Encapsulates the results of an asynchronous directory synchronization operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpSynchronizeDirectoriesAsyncResult.FilesRead">
|
||
<summary>
|
||
Gets the number of files read so far.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSynchronizeDirectoriesAsyncResult.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpSynchronizeDirectoriesAsyncResult" /> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpSynchronizeDirectoriesAsyncResult.Update(System.Int32)">
|
||
<summary>
|
||
Updates asynchronous operation status information.
|
||
</summary>
|
||
<param name="filesRead">The files read.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.SftpUploadAsyncResult">
|
||
<summary>
|
||
Encapsulates the results of an asynchronous upload operation.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpUploadAsyncResult.IsUploadCanceled">
|
||
<summary>
|
||
Gets or sets a value indicating whether to cancel asynchronous upload operation.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if upload operation to be canceled; otherwise, <see langword="false"/>.
|
||
</value>
|
||
<remarks>
|
||
Upload operation will be canceled after finishing uploading current buffer.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Sftp.SftpUploadAsyncResult.UploadedBytes">
|
||
<summary>
|
||
Gets the number of uploaded bytes.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpUploadAsyncResult.#ctor(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Sftp.SftpUploadAsyncResult"/> class.
|
||
</summary>
|
||
<param name="asyncCallback">The async callback.</param>
|
||
<param name="state">The state.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Sftp.SftpUploadAsyncResult.Update(System.UInt64)">
|
||
<summary>
|
||
Updates asynchronous operation status information.
|
||
</summary>
|
||
<param name="uploadedBytes">Number of uploaded bytes.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Sftp.StatusCode">
|
||
<summary>
|
||
Specifies status codes returned by the server in response to SFTP requests.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.Ok">
|
||
<summary>
|
||
SSH_FX_OK.
|
||
</summary>
|
||
<remarks>
|
||
The operation completed successfully.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.Eof">
|
||
<summary>
|
||
SSH_FX_EOF.
|
||
</summary>
|
||
<remarks>
|
||
An attempt was made to read past the end of the file,
|
||
or no more directory entries were available.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.NoSuchFile">
|
||
<summary>
|
||
SSH_FX_NO_SUCH_FILE.
|
||
</summary>
|
||
<remarks>
|
||
A reference was made to a file that does not exist.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.PermissionDenied">
|
||
<summary>
|
||
SSH_FX_PERMISSION_DENIED.
|
||
</summary>
|
||
<remarks>
|
||
The user does not have sufficient permissions to perform the operation.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.Failure">
|
||
<summary>
|
||
SSH_FX_FAILURE.
|
||
</summary>
|
||
<remarks>
|
||
An error occurred, but no specific error code exists to describe
|
||
the failure.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.BadMessage">
|
||
<summary>
|
||
SSH_FX_BAD_MESSAGE.
|
||
</summary>
|
||
<remarks>
|
||
A badly formatted packet or SFTP protocol incompatibility was detected.
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.NoConnection">
|
||
<summary>
|
||
SSH_FX_NO_CONNECTION.
|
||
</summary>
|
||
<remarks>
|
||
A pseudo-error which indicates that the client has no
|
||
connection to the server (it can only be generated locally
|
||
by the client, and MUST NOT be returned by servers).
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.ConnectionLost">
|
||
<summary>
|
||
SSH_FX_CONNECTION_LOST.
|
||
</summary>
|
||
<remarks>
|
||
A pseudo-error which indicates that the connection to the
|
||
server has been lost (it can only be generated locally by
|
||
the client, and MUST NOT be returned by servers).
|
||
</remarks>
|
||
</member>
|
||
<member name="F:Renci.SshNet.Sftp.StatusCode.OperationUnsupported">
|
||
<summary>
|
||
SSH_FX_OP_UNSUPPORTED.
|
||
</summary>
|
||
<remarks>
|
||
The operation could not be completed because the server did not support it.
|
||
</remarks>
|
||
</member>
|
||
<member name="T:Renci.SshNet.Shell">
|
||
<summary>
|
||
Represents instance of the SSH shell object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.Shell.IsStarted">
|
||
<summary>
|
||
Gets a value indicating whether this shell is started.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if started is started; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Shell.Starting">
|
||
<summary>
|
||
Occurs when shell is starting.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Shell.Started">
|
||
<summary>
|
||
Occurs when shell is started.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Shell.Stopping">
|
||
<summary>
|
||
Occurs when shell is stopping.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Shell.Stopped">
|
||
<summary>
|
||
Occurs when shell is stopped.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.Shell.ErrorOccurred">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.#ctor(Renci.SshNet.ISession,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Shell"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="terminalName">Name of the terminal.</param>
|
||
<param name="columns">The columns.</param>
|
||
<param name="rows">The rows.</param>
|
||
<param name="width">The width.</param>
|
||
<param name="height">The height.</param>
|
||
<param name="terminalModes">The terminal modes.</param>
|
||
<param name="bufferSize">Size of the buffer for output stream.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.#ctor(Renci.SshNet.ISession,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Shell"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="bufferSize">Size of the buffer for output stream.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.#ctor(Renci.SshNet.ISession,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.Shell"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="input">The input.</param>
|
||
<param name="output">The output.</param>
|
||
<param name="extendedOutput">The extended output.</param>
|
||
<param name="bufferSize">Size of the buffer for output stream.</param>
|
||
<param name="noTerminal">Disables pseudo terminal allocation or not.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.Start">
|
||
<summary>
|
||
Starts this shell.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Shell is started.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The pseudo-terminal request was not accepted by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The request to start a shell was not accepted by the server.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.Stop">
|
||
<summary>
|
||
Stops this shell.
|
||
</summary>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Shell is not started.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.UnsubscribeFromSessionEvents(Renci.SshNet.ISession)">
|
||
<summary>
|
||
Unsubscribes the current <see cref="T:Renci.SshNet.Shell"/> from session events.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<remarks>
|
||
Does nothing when <paramref name="session"/> is <see langword="null"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.Shell.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.ShellStream">
|
||
<summary>
|
||
Contains operation for working with SSH Shell.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ShellStream.DataReceived">
|
||
<summary>
|
||
Occurs when data was received.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ShellStream.ErrorOccurred">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.ShellStream.Closed">
|
||
<summary>
|
||
Occurs when the channel was closed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.DataAvailable">
|
||
<summary>
|
||
Gets a value indicating whether data is available on the <see cref="T:Renci.SshNet.ShellStream"/> to be read.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if data is available to be read; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.#ctor(Renci.SshNet.ISession,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ShellStream"/> class.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="terminalName">The <c>TERM</c> environment variable.</param>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal width in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<param name="terminalModeValues">The terminal mode values.</param>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel could not be opened.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The pseudo-terminal request was not accepted by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The request to start a shell was not accepted by the server.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.#ctor(Renci.SshNet.ISession,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ShellStream"/> class.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel could not be opened.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The request to start a shell was not accepted by the server.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.#ctor(Renci.SshNet.ISession,System.Int32,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.ShellStream"/> class.
|
||
</summary>
|
||
<param name="session">The SSH session.</param>
|
||
<param name="bufferSize">The size of the buffer.</param>
|
||
<param name="noTerminal">Disables pseudo terminal allocation or not.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel could not be opened.</exception>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.CanRead">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports reading.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/>.
|
||
</value>
|
||
<remarks>
|
||
It is safe to read from <see cref="T:Renci.SshNet.ShellStream"/> even after disposal.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.CanSeek">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports seeking.
|
||
</summary>
|
||
<value>
|
||
<see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.CanWrite">
|
||
<summary>
|
||
Gets a value indicating whether the current stream supports writing.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this stream has not been disposed and the underlying channel
|
||
is still open, otherwise <see langword="false"/>.
|
||
</value>
|
||
<remarks>
|
||
A value of <see langword="true"/> does not necessarily mean a write will succeed. It is possible
|
||
that the channel is closed and/or the stream is disposed by another thread between a call to
|
||
<see cref="P:Renci.SshNet.ShellStream.CanWrite"/> and the call to write.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Flush">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.Length">
|
||
<summary>
|
||
Gets the number of bytes currently available for reading.
|
||
</summary>
|
||
<value>A value representing the length of the stream in bytes.</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.ShellStream.Position">
|
||
<summary>
|
||
This property always returns 0, and throws <see cref="T:System.NotSupportedException"/>
|
||
when calling the setter.
|
||
</summary>
|
||
<value>
|
||
0.
|
||
</value>
|
||
<exception cref="T:System.NotSupportedException">The setter is called.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<summary>
|
||
This method always throws <see cref="T:System.NotSupportedException"/>.
|
||
</summary>
|
||
<param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
|
||
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
|
||
<returns>Never.</returns>
|
||
<exception cref="T:System.NotSupportedException">Always.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.SetLength(System.Int64)">
|
||
<summary>
|
||
This method always throws <see cref="T:System.NotSupportedException"/>.
|
||
</summary>
|
||
<param name="value">The desired length of the current stream in bytes.</param>
|
||
<exception cref="T:System.NotSupportedException">Always.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.ChangeWindowSize(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
|
||
<summary>
|
||
Sends new dimensions of the window (terminal) to the server.
|
||
</summary>
|
||
<param name="columns">The terminal width in columns.</param>
|
||
<param name="rows">The terminal height in rows.</param>
|
||
<param name="width">The terminal width in pixels.</param>
|
||
<param name="height">The terminal height in pixels.</param>
|
||
<remarks>
|
||
The column/row dimensions override the pixel dimensions (when nonzero). Pixel dimensions refer
|
||
to the drawable area of the window.
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Expects the specified expression and performs action when one is found.
|
||
</summary>
|
||
<param name="expectActions">The expected expressions and actions to perform.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.TimeSpan,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Expects the specified expression and performs action when one is found.
|
||
</summary>
|
||
<param name="timeout">Time to wait for input. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="expectActions">The expected expressions and actions to perform, if the specified time elapsed and expected condition have not met, that method will exit without executing any action.</param>
|
||
<remarks>
|
||
If a TimeSpan representing -1 millisecond is specified for the <paramref name="timeout"/> parameter,
|
||
this method blocks indefinitely until either the regex matches the data in the buffer, or the stream
|
||
is closed (via disposal or via the underlying channel closing).
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.TimeSpan,System.Int32,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Expects the specified expression and performs action when one is found.
|
||
</summary>
|
||
<param name="timeout">Time to wait for input. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="lookback">The amount of data to search through from the most recent data in the buffer, or -1 to always search the entire buffer.</param>
|
||
<param name="expectActions">The expected expressions and actions to perform, if the specified time elapsed and expected condition have not met, that method will exit without executing any action.</param>
|
||
<remarks>
|
||
<para>
|
||
If a TimeSpan representing -1 millisecond is specified for the <paramref name="timeout"/> parameter,
|
||
this method blocks indefinitely until either the regex matches the data in the buffer, or the stream
|
||
is closed (via disposal or via the underlying channel closing).
|
||
</para>
|
||
<para>
|
||
Use the <paramref name="lookback"/> parameter to constrain the search space to a fixed-size rolling window at the end of the buffer.
|
||
This can reduce the amount of work done in cases where lots of output from the shell is expected to be received before the matching expression is found.
|
||
</para>
|
||
<para>
|
||
Note: in situations with high volumes of data and a small value for <paramref name="lookback"/>, some data may not be searched through.
|
||
It is recommended to set <paramref name="lookback"/> to a large enough value to be able to search all data as it comes in,
|
||
but which still places a limit on the amount of work needed.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.String)">
|
||
<summary>
|
||
Expects the expression specified by text.
|
||
</summary>
|
||
<param name="text">The text to expect.</param>
|
||
<returns>
|
||
The text available in the shell up to and including the expected text,
|
||
or <see langword="null"/> if the the stream is closed without a match.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.String,System.TimeSpan,System.Int32)">
|
||
<summary>
|
||
Expects the expression specified by text.
|
||
</summary>
|
||
<param name="text">The text to expect.</param>
|
||
<param name="timeout">Time to wait for input. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="lookback">The amount of data to search through from the most recent data in the buffer, or -1 to always search the entire buffer.</param>
|
||
<returns>
|
||
The text available in the shell up to and including the expected expression,
|
||
or <see langword="null"/> if the specified time has elapsed or the stream is closed
|
||
without a match.
|
||
</returns>
|
||
<remarks><inheritdoc cref="M:Renci.SshNet.ShellStream.Expect(System.TimeSpan,System.Int32,Renci.SshNet.ExpectAction[])"/></remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.Text.RegularExpressions.Regex)">
|
||
<summary>
|
||
Expects the expression specified by regular expression.
|
||
</summary>
|
||
<param name="regex">The regular expression to expect.</param>
|
||
<returns>
|
||
The text available in the shell up to and including the expected expression,
|
||
or <see langword="null"/> if the stream is closed without a match.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Expect(System.Text.RegularExpressions.Regex,System.TimeSpan,System.Int32)">
|
||
<summary>
|
||
Expects the expression specified by regular expression.
|
||
</summary>
|
||
<param name="regex">The regular expression to expect.</param>
|
||
<param name="timeout">Time to wait for input. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="lookback">The amount of data to search through from the most recent data in the buffer, or -1 to always search the entire buffer.</param>
|
||
<returns>
|
||
The text available in the shell up to and including the expected expression,
|
||
or <see langword="null"/> if the specified timeout has elapsed or the stream
|
||
is closed without a match.
|
||
</returns>
|
||
<remarks>
|
||
<inheritdoc cref="M:Renci.SshNet.ShellStream.Expect(System.TimeSpan,System.Int32,Renci.SshNet.ExpectAction[])"/>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginExpect(Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Begins the expect.
|
||
</summary>
|
||
<param name="expectActions">The expect actions.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginExpect(System.AsyncCallback,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Begins the expect.
|
||
</summary>
|
||
<param name="callback">The callback.</param>
|
||
<param name="expectActions">The expect actions.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginExpect(System.AsyncCallback,System.Object,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Begins the expect.
|
||
</summary>
|
||
<param name="callback">The callback.</param>
|
||
<param name="state">The state.</param>
|
||
<param name="expectActions">The expect actions.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginExpect(System.TimeSpan,System.AsyncCallback,System.Object,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Begins the expect.
|
||
</summary>
|
||
<param name="timeout">The timeout. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="callback">The callback.</param>
|
||
<param name="state">The state.</param>
|
||
<param name="expectActions">The expect actions.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginExpect(System.TimeSpan,System.Int32,System.AsyncCallback,System.Object,Renci.SshNet.ExpectAction[])">
|
||
<summary>
|
||
Begins the expect.
|
||
</summary>
|
||
<param name="timeout">The timeout. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<param name="lookback">The amount of data to search through from the most recent data in the buffer, or -1 to always search the entire buffer.</param>
|
||
<param name="callback">The callback.</param>
|
||
<param name="state">The state.</param>
|
||
<param name="expectActions">The expect actions.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.EndExpect(System.IAsyncResult)">
|
||
<summary>
|
||
Ends the execute.
|
||
</summary>
|
||
<param name="asyncResult">The async result.</param>
|
||
<returns>
|
||
The text available in the shell up to and including the expected expression.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.ReadLine">
|
||
<summary>
|
||
Reads the next line from the shell. If a line is not available it will block and wait for a new line.
|
||
</summary>
|
||
<returns>
|
||
The line read from the shell.
|
||
</returns>
|
||
<remarks>
|
||
<para>
|
||
This method blocks indefinitely until either a line is available in the buffer, or the stream is closed
|
||
(via disposal or via the underlying channel closing).
|
||
</para>
|
||
<para>
|
||
When the stream is closed and there are no more newlines in the buffer, this method returns the remaining data
|
||
(if any) and then <see langword="null"/> indicating that no more data is in the buffer.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.ReadLine(System.TimeSpan)">
|
||
<summary>
|
||
Reads a line from the shell. If line is not available it will block the execution and will wait for new line.
|
||
</summary>
|
||
<param name="timeout">Time to wait for input. Must non-negative or equal to -1 millisecond (for infinite timeout).</param>
|
||
<returns>
|
||
The line read from the shell, or <see langword="null"/> when no input is received for the specified timeout.
|
||
</returns>
|
||
<remarks>
|
||
<para>
|
||
If a TimeSpan representing -1 millisecond is specified for the <paramref name="timeout"/> parameter, this method
|
||
blocks indefinitely until either a line is available in the buffer, or the stream is closed (via disposal or via
|
||
the underlying channel closing).
|
||
</para>
|
||
<para>
|
||
When the stream is closed and there are no more newlines in the buffer, this method returns the remaining data
|
||
(if any) and then <see langword="null"/> indicating that no more data is in the buffer.
|
||
</para>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Read">
|
||
<summary>
|
||
Reads all of the text currently available in the shell.
|
||
</summary>
|
||
<returns>
|
||
The text available in the shell.
|
||
</returns>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Read(System.Span{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.ReadByte">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Write(System.String)">
|
||
<summary>
|
||
Writes the specified text to the shell.
|
||
</summary>
|
||
<param name="text">The text to be written to the shell.</param>
|
||
<remarks>
|
||
If <paramref name="text"/> is <see langword="null"/>, nothing is written.
|
||
Otherwise, <see cref="M:Renci.SshNet.ShellStream.Flush"/> is called after writing the data to the buffer.
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Write(System.ReadOnlySpan{System.Byte})">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.WriteByte(System.Byte)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.EndWrite(System.IAsyncResult)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.WriteLine(System.String)">
|
||
<summary>
|
||
Writes the line to the shell.
|
||
</summary>
|
||
<param name="line">The line to be written to the shell.</param>
|
||
<remarks>
|
||
If <paramref name="line"/> is <see langword="null"/>, only the line terminator is written.
|
||
<see cref="M:Renci.SshNet.ShellStream.Flush"/> is called once the data is written.
|
||
</remarks>
|
||
<exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.ShellStream.Dispose(System.Boolean)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="T:Renci.SshNet.SshClient">
|
||
<inheritdoc cref="T:Renci.SshNet.ISshClient" />
|
||
</member>
|
||
<member name="F:Renci.SshNet.SshClient._forwardedPorts">
|
||
<summary>
|
||
Holds the list of forwarded ports.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SshClient._isDisposed">
|
||
<summary>
|
||
Holds a value indicating whether the current instance is disposed.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if the current instance is disposed; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshClient.ForwardedPorts">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(Renci.SshNet.ConnectionInfo)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient" /> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(System.String,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(System.String,System.String,System.String)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="password">Authentication password.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="password"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(System.String,System.Int32,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="port">Connection port.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="F:System.Net.IPEndPoint.MinPort"/> and <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(System.String,System.String,Renci.SshNet.IPrivateKeySource[])">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="host">Connection host.</param>
|
||
<param name="username">Authentication username.</param>
|
||
<param name="keyFiles">Authentication private key file(s) .</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="keyFiles"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentException"><paramref name="host"/> is invalid, -or- <paramref name="username"/> is <see langword="null"/> or contains only whitespace characters.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.#ctor(Renci.SshNet.ConnectionInfo,System.Boolean,Renci.SshNet.IServiceFactory)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshClient"/> class.
|
||
</summary>
|
||
<param name="connectionInfo">The connection info.</param>
|
||
<param name="ownsConnectionInfo">Specified whether this instance owns the connection info.</param>
|
||
<param name="serviceFactory">The factory to use for creating new services.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="connectionInfo"/> is <see langword="null"/>.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="serviceFactory"/> is <see langword="null"/>.</exception>
|
||
<remarks>
|
||
If <paramref name="ownsConnectionInfo"/> is <see langword="true"/>, then the
|
||
connection info will be disposed when this instance is disposed.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.OnDisconnecting">
|
||
<summary>
|
||
Called when client is disconnecting from the server.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.AddForwardedPort(Renci.SshNet.ForwardedPort)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.RemoveForwardedPort(Renci.SshNet.ForwardedPort)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateCommand(System.String)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateCommand(System.String,System.Text.Encoding)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.RunCommand(System.String)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.IO.Stream,System.IO.Stream,System.IO.Stream)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32},System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream,System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShell(System.Text.Encoding,System.String,System.IO.Stream,System.IO.Stream)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShellNoTerminal(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShellStream(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShellStream(System.String,System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Int32,System.Collections.Generic.IDictionary{Renci.SshNet.Common.TerminalModes,System.UInt32})">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.CreateShellStreamNoTerminal(System.Int32)">
|
||
<inheritdoc />
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.OnDisconnected">
|
||
<summary>
|
||
Stops forwarded ports.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshClient.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.SshCommand">
|
||
<summary>
|
||
Represents an SSH command that can be executed.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SshCommand._userToken">
|
||
<summary>
|
||
The token supplied as an argument to <see cref="M:Renci.SshNet.SshCommand.ExecuteAsync(System.Threading.CancellationToken)"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SshCommand._cancellationRequested">
|
||
<summary>
|
||
Whether <see cref="M:Renci.SshNet.SshCommand.CancelAsync(System.Boolean,System.Int32)"/> has been called
|
||
(either by a token or manually).
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.CommandText">
|
||
<summary>
|
||
Gets the command text.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.CommandTimeout">
|
||
<summary>
|
||
Gets or sets the command timeout.
|
||
</summary>
|
||
<value>
|
||
The command timeout.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.ExitStatus">
|
||
<summary>
|
||
Gets the number representing the exit status of the command, if applicable,
|
||
otherwise <see langword="null"/>.
|
||
</summary>
|
||
<remarks>
|
||
The value is not <see langword="null"/> when an exit status code has been returned
|
||
from the server. If the command terminated due to a signal, <see cref="P:Renci.SshNet.SshCommand.ExitSignal"/>
|
||
may be not <see langword="null"/> instead.
|
||
</remarks>
|
||
<seealso cref="P:Renci.SshNet.SshCommand.ExitSignal"/>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.ExitSignal">
|
||
<summary>
|
||
Gets the name of the signal due to which the command
|
||
terminated violently, if applicable, otherwise <see langword="null"/>.
|
||
</summary>
|
||
<remarks>
|
||
The value (if it exists) is supplied by the server and is usually one of the
|
||
following, as described in https://datatracker.ietf.org/doc/html/rfc4254#section-6.10:
|
||
ABRT, ALRM, FPE, HUP, ILL, INT, KILL, PIPE, QUIT, SEGV, TER, USR1, USR2.
|
||
</remarks>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.OutputStream">
|
||
<summary>
|
||
Gets the output stream.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.ExtendedOutputStream">
|
||
<summary>
|
||
Gets the extended output stream.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.CreateInputStream">
|
||
<summary>
|
||
Creates and returns the input stream for the command.
|
||
</summary>
|
||
<returns>
|
||
The stream that can be used to transfer data to the command's input stream.
|
||
</returns>
|
||
<remarks>
|
||
Callers should ensure that <see cref="M:System.IO.Stream.Dispose"/> is called on the
|
||
returned instance in order to notify the command that no more data will be sent.
|
||
Failure to do so may result in the command executing indefinitely.
|
||
</remarks>
|
||
<example>
|
||
This example shows how to stream some data to 'cat' and have the server echo it back.
|
||
<code>
|
||
using (SshCommand command = mySshClient.CreateCommand("cat"))
|
||
{
|
||
Task executeTask = command.ExecuteAsync(CancellationToken.None);
|
||
|
||
using (Stream inputStream = command.CreateInputStream())
|
||
{
|
||
inputStream.Write("Hello World!"u8);
|
||
}
|
||
|
||
await executeTask;
|
||
|
||
Console.WriteLine(command.ExitStatus); // 0
|
||
Console.WriteLine(command.Result); // "Hello World!"
|
||
}
|
||
</code>
|
||
</example>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.Result">
|
||
<summary>
|
||
Gets the standard output of the command by reading <see cref="P:Renci.SshNet.SshCommand.OutputStream"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SshCommand.Error">
|
||
<summary>
|
||
Gets the standard error of the command by reading <see cref="P:Renci.SshNet.SshCommand.ExtendedOutputStream"/>,
|
||
when extended data has been sent which has been marked as stderr.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.#ctor(Renci.SshNet.ISession,System.String,System.Text.Encoding)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshCommand"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="commandText">The command text.</param>
|
||
<param name="encoding">The encoding to use for the results.</param>
|
||
<exception cref="T:System.ArgumentNullException">Either <paramref name="session"/>, <paramref name="commandText"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.ExecuteAsync(System.Threading.CancellationToken)">
|
||
<summary>
|
||
Executes the command asynchronously.
|
||
</summary>
|
||
<param name="cancellationToken">
|
||
The <see cref="T:System.Threading.CancellationToken"/>. When triggered, attempts to terminate the
|
||
remote command by sending a signal.
|
||
</param>
|
||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the lifetime of the command.</returns>
|
||
<exception cref="T:System.InvalidOperationException">Command is already executing. Thrown synchronously.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">Instance has been disposed. Thrown synchronously.</exception>
|
||
<exception cref="T:System.OperationCanceledException">The <see cref="T:System.Threading.Tasks.Task"/> has been cancelled.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The command timed out according to <see cref="P:Renci.SshNet.SshCommand.CommandTimeout"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.BeginExecute">
|
||
<summary>
|
||
Begins an asynchronous command execution.
|
||
</summary>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous command execution, which could still be pending.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Asynchronous operation is already in progress.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Invalid operation.</exception>
|
||
<exception cref="T:System.ArgumentException">CommandText property is empty.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.BeginExecute(System.AsyncCallback)">
|
||
<summary>
|
||
Begins an asynchronous command execution.
|
||
</summary>
|
||
<param name="callback">An optional asynchronous callback, to be called when the command execution is complete.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous command execution, which could still be pending.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Asynchronous operation is already in progress.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Invalid operation.</exception>
|
||
<exception cref="T:System.ArgumentException">CommandText property is empty.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.BeginExecute(System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Begins an asynchronous command execution.
|
||
</summary>
|
||
<param name="callback">An optional asynchronous callback, to be called when the command execution is complete.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous command execution, which could still be pending.
|
||
</returns>
|
||
<exception cref="T:System.InvalidOperationException">Asynchronous operation is already in progress.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">Invalid operation.</exception>
|
||
<exception cref="T:System.ArgumentException">CommandText property is empty.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.BeginExecute(System.String,System.AsyncCallback,System.Object)">
|
||
<summary>
|
||
Begins an asynchronous command execution.
|
||
</summary>
|
||
<param name="commandText">The command text.</param>
|
||
<param name="callback">An optional asynchronous callback, to be called when the command execution is complete.</param>
|
||
<param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
|
||
<returns>
|
||
An <see cref="T:System.IAsyncResult" /> that represents the asynchronous command execution, which could still be pending.
|
||
</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.EndExecute(System.IAsyncResult)">
|
||
<summary>
|
||
Waits for the pending asynchronous command execution to complete.
|
||
</summary>
|
||
<param name="asyncResult">The reference to the pending asynchronous request to finish.</param>
|
||
<returns><see cref="P:Renci.SshNet.SshCommand.Result"/>.</returns>
|
||
<exception cref="T:System.ArgumentException"><paramref name="asyncResult"/> does not correspond to the currently executing command.</exception>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="asyncResult"/> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.CancelAsync(System.Boolean,System.Int32)">
|
||
<summary>
|
||
Cancels a running command by sending a signal to the remote process.
|
||
</summary>
|
||
<param name="forceKill">if true send SIGKILL instead of SIGTERM.</param>
|
||
<param name="millisecondsTimeout">Time to wait for the server to reply.</param>
|
||
<remarks>
|
||
<para>
|
||
This method stops the command running on the server by sending a SIGTERM
|
||
(or SIGKILL, depending on <paramref name="forceKill"/>) signal to the remote
|
||
process. When the server implements signals, it will send a response which
|
||
populates <see cref="P:Renci.SshNet.SshCommand.ExitSignal"/> with the signal with which the command terminated.
|
||
</para>
|
||
<para>
|
||
When the server does not implement signals, it may send no response. As a fallback,
|
||
this method waits up to <paramref name="millisecondsTimeout"/> for a response
|
||
and then completes the <see cref="T:Renci.SshNet.SshCommand"/> object anyway if there was none.
|
||
</para>
|
||
<para>
|
||
If the command has already finished (with or without cancellation), this method does
|
||
nothing.
|
||
</para>
|
||
</remarks>
|
||
<exception cref="T:System.InvalidOperationException">Command has not been started.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.Execute">
|
||
<summary>
|
||
Executes the command specified by <see cref="P:Renci.SshNet.SshCommand.CommandText"/>.
|
||
</summary>
|
||
<returns><see cref="P:Renci.SshNet.SshCommand.Result"/>.</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.Execute(System.String)">
|
||
<summary>
|
||
Executes the specified command.
|
||
</summary>
|
||
<param name="commandText">The command text.</param>
|
||
<returns><see cref="P:Renci.SshNet.SshCommand.Result"/>.</returns>
|
||
<exception cref="T:Renci.SshNet.Common.SshConnectionException">Client is not connected.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">Operation has timed out.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.UnsubscribeFromChannelEvents(System.Boolean)">
|
||
<summary>
|
||
Unsubscribes the current <see cref="T:Renci.SshNet.SshCommand"/> from channel events, and optionally,
|
||
disposes <see cref="F:Renci.SshNet.SshCommand._channel"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshCommand.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SshMessageFactory.HighestMessageNumber">
|
||
<summary>
|
||
Defines the highest message number that is currently supported.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshMessageFactory.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SshMessageFactory"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshMessageFactory.Reset">
|
||
<summary>
|
||
Disables and deactivate all messages.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshMessageFactory.DisableNonKeyExchangeMessages(System.Boolean)">
|
||
<summary>
|
||
Disables non-KeyExchange messages.
|
||
</summary>
|
||
<param name="strict">
|
||
<see langword="true"/> to indicate the strict key exchange mode; otherwise <see langword="false"/>.
|
||
<para>In strict key exchange mode, only below messages are allowed:</para>
|
||
<list type="bullet">
|
||
<item>SSH_MSG_KEXINIT -> 20</item>
|
||
<item>SSH_MSG_NEWKEYS -> 21</item>
|
||
<item>SSH_MSG_DISCONNECT -> 1</item>
|
||
</list>
|
||
<para>Note:</para>
|
||
<para> The relevant KEX Reply MSG will be allowed from a sub class of KeyExchange class.</para>
|
||
<para> For example, it calls <c>Session.RegisterMessage("SSH_MSG_KEX_ECDH_REPLY");</c> if the curve25519-sha256 KEX algorithm is selected per negotiation.</para>
|
||
</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.SshNetLoggingConfiguration">
|
||
<summary>
|
||
Allows configuring the logging for internal logs of SSH.NET.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SshNetLoggingConfiguration.InitializeLogging(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||
<summary>
|
||
Initializes the logging for SSH.NET.
|
||
</summary>
|
||
<param name="loggerFactory">The logger factory.</param>
|
||
</member>
|
||
<member name="T:Renci.SshNet.SubsystemSession">
|
||
<summary>
|
||
Base class for SSH subsystem implementations.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Renci.SshNet.SubsystemSession.SystemWaitHandleCount">
|
||
<summary>
|
||
Holds the number of system wait handles that are returned as the leading entries in the array returned
|
||
in <see cref="M:Renci.SshNet.SubsystemSession.CreateWaitHandleArray(System.Threading.WaitHandle,System.Threading.WaitHandle)"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SubsystemSession.OperationTimeout">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="E:Renci.SshNet.SubsystemSession.ErrorOccurred">
|
||
<summary>
|
||
Occurs when an error occurred.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Renci.SshNet.SubsystemSession.Disconnected">
|
||
<summary>
|
||
Occurs when the server has disconnected from the session.
|
||
</summary>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SubsystemSession.Channel">
|
||
<summary>
|
||
Gets the channel associated with this session.
|
||
</summary>
|
||
<value>
|
||
The channel associated with this session.
|
||
</value>
|
||
</member>
|
||
<member name="P:Renci.SshNet.SubsystemSession.IsOpen">
|
||
<summary>
|
||
Gets a value indicating whether this session is open.
|
||
</summary>
|
||
<value>
|
||
<see langword="true"/> if this session is open; otherwise, <see langword="false"/>.
|
||
</value>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.#ctor(Renci.SshNet.ISession,System.String,System.Int32)">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:Renci.SshNet.SubsystemSession"/> class.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<param name="subsystemName">Name of the subsystem.</param>
|
||
<param name="operationTimeout">The number of milliseconds to wait for a given operation to complete, or -1 to wait indefinitely.</param>
|
||
<exception cref="T:System.ArgumentNullException"><paramref name="session" /> or <paramref name="subsystemName" /> is <see langword="null"/>.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.Connect">
|
||
<summary>
|
||
Connects the subsystem using a new SSH channel session.
|
||
</summary>
|
||
<exception cref="T:System.InvalidOperationException">The session is already connected.</exception>
|
||
<exception cref="T:System.ObjectDisposedException">The method was called after the session was disposed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel session could not be opened, or the subsystem could not be executed.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.Disconnect">
|
||
<summary>
|
||
Disconnects the subsystem channel.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.SendData(System.Byte[])">
|
||
<summary>
|
||
Sends data to the subsystem.
|
||
</summary>
|
||
<param name="data">The data to be sent.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.OnChannelOpen">
|
||
<summary>
|
||
Called when channel is open.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.OnDataReceived(System.ArraySegment{System.Byte})">
|
||
<summary>
|
||
Called when data is received.
|
||
</summary>
|
||
<param name="data">The data.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.RaiseError(System.Exception)">
|
||
<summary>
|
||
Raises the error.
|
||
</summary>
|
||
<param name="error">The error.</param>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.WaitOnHandle(System.Threading.WaitHandle,System.Int32)">
|
||
<summary>
|
||
Waits a specified time for a given <see cref="T:System.Threading.WaitHandle"/> to get signaled.
|
||
</summary>
|
||
<param name="waitHandle">The handle to wait for.</param>
|
||
<param name="millisecondsTimeout">To number of milliseconds to wait for <paramref name="waitHandle"/> to get signaled, or -1 to wait indefinitely.</param>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The connection was closed by the server.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshException">The channel was closed.</exception>
|
||
<exception cref="T:Renci.SshNet.Common.SshOperationTimeoutException">The handle did not get signaled within the specified timeout.</exception>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.WaitAny(System.Threading.WaitHandle[],System.Int32)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.CreateWaitHandleArray(System.Threading.WaitHandle,System.Threading.WaitHandle)">
|
||
<inheritdoc/>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.UnsubscribeFromSessionEvents(Renci.SshNet.ISession)">
|
||
<summary>
|
||
Unsubscribes the current <see cref="T:Renci.SshNet.SubsystemSession"/> from session events.
|
||
</summary>
|
||
<param name="session">The session.</param>
|
||
<remarks>
|
||
Does nothing when <paramref name="session"/> is <see langword="null"/>.
|
||
</remarks>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.Dispose">
|
||
<summary>
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Renci.SshNet.SubsystemSession.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases unmanaged and - optionally - managed resources.
|
||
</summary>
|
||
<param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetHttpResponseRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpResponseRegex_0.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetHttpHeaderRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetHttpHeaderRegex_1.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetServerVersionRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetServerVersionRegex_2.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetLengthRegex_3">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetLengthRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetLengthRegex_3.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetLengthRegex_3.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetLengthRegex_3.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetReplyRegex_4">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetReplyRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetReplyRegex_4.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetReplyRegex_4.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetReplyRegex_4.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetReplyRegex_4.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetReplyRegex_4.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetReplyRegex_4.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetReplyRegex_4.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetPrivateKeyRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyRegex_5.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetPrivateKeyPuTTYRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetPrivateKeyPuTTYRegex_6.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetCertificateRegex_7">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetCertificateRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetCertificateRegex_7.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetFileInfoRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetFileInfoRegex_8.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetDirectoryInfoRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetDirectoryInfoRegex_9.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetTimestampRegex_10">
|
||
<summary>Custom <see cref="T:System.Text.RegularExpressions.Regex"/>-derived type for the GetTimestampRegex method.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.Instance">
|
||
<summary>Cached, thread-safe singleton instance.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.#ctor">
|
||
<summary>Initializes the instance.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory">
|
||
<summary>Provides a factory for creating <see cref="T:System.Text.RegularExpressions.RegexRunner"/> instances to be used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory.CreateInstance">
|
||
<summary>Creates an instance of a <see cref="T:System.Text.RegularExpressions.RegexRunner"/> used by methods on <see cref="T:System.Text.RegularExpressions.Regex"/>.</summary>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory.Runner">
|
||
<summary>Provides the runner that contains the custom logic implementing the specified regular expression.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory.Runner.Scan(System.ReadOnlySpan{System.Char})">
|
||
<summary>Scan the <paramref name="inputSpan"/> starting from base.runtextstart for the next match.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory.Runner.TryFindNextPossibleStartingPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Search <paramref name="inputSpan"/> starting from base.runtextpos for the next location a match could possibly start.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if a possible match was found; false if no more matches are possible.</returns>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.GetTimestampRegex_10.RunnerFactory.Runner.TryMatchAtCurrentPosition(System.ReadOnlySpan{System.Char})">
|
||
<summary>Determine whether <paramref name="inputSpan"/> at base.runtextpos is a match for the regular expression.</summary>
|
||
<param name="inputSpan">The text being scanned by the regular expression.</param>
|
||
<returns>true if the regular expression matches at the current position; otherwise, false.</returns>
|
||
</member>
|
||
<member name="T:System.Text.RegularExpressions.Generated.Utilities">
|
||
<summary>Helper methods used by generated <see cref="T:System.Text.RegularExpressions.Regex"/>-derived implementations.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_defaultTimeout">
|
||
<summary>Default timeout value set in <see cref="T:System.AppContext"/>, or <see cref="F:System.Text.RegularExpressions.Regex.InfiniteMatchTimeout"/> if none was set.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_hasTimeout">
|
||
<summary>Whether <see cref="F:System.Text.RegularExpressions.Generated.Utilities.s_defaultTimeout"/> is non-infinite.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.IndexOfNonAsciiOrAny_215AA4A611886BDACDBBE3CDA300E5F2D4BF9ACBCFA3DFE6EAF9DABFC4107B6A(System.ReadOnlySpan{System.Char})">
|
||
<summary>Finds the next index of any character that matches a character in the set [-\w].</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.IsWordChar(System.Char)">
|
||
<summary>Determines whether the character is part of the [\w] set.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.StackPop(System.Int32[],System.Int32@,System.Int32@,System.Int32@)">
|
||
<summary>Pops 2 values from the backtracking stack.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.StackPush(System.Int32[]@,System.Int32@,System.Int32)">
|
||
<summary>Pushes 1 value onto the backtracking stack.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.StackPush(System.Int32[]@,System.Int32@,System.Int32,System.Int32)">
|
||
<summary>Pushes 2 values onto the backtracking stack.</summary>
|
||
</member>
|
||
<member name="M:System.Text.RegularExpressions.Generated.Utilities.StackPush(System.Int32[]@,System.Int32@,System.Int32,System.Int32,System.Int32)">
|
||
<summary>Pushes 3 values onto the backtracking stack.</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_asciiHexDigits">
|
||
<summary>Supports searching for characters in or not in "0123456789ABCDEFabcdef".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_ascii_20FF03FEFFFF0700000000">
|
||
<summary>Supports searching for characters in or not in "-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_ascii_88FF23FEFFFF07FEFFFF07">
|
||
<summary>Supports searching for characters in or not in "+/0123456789=ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_ascii_FFFFFFFFFFDF00FC01000078010000F8">
|
||
<summary>Supports searching for characters in or not in "\0\u0001\u0002\u0003\u0004\u0005\u0006\a\b\t\n\v\f\r\u000e\u000f\u0010\u0011\u0012\u0013\u0014\u0015\u0016\u0017\u0018\u0019\u001a\u001b\u001c\u001d\u001e\u001f !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~\u007f".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_indexOfString_0ECE0B06F4AB22E162AF828328AD8A524368A05028C6526E2CBB462D91A422B9">
|
||
<summary>Supports searching for the string "HTTP/".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_indexOfString_1BB487E0D0AE229609EC5E98D2BBEC4E344C49380F21C2CDE70F79FC22886B55">
|
||
<summary>Supports searching for the string "\n#".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_indexOfString_235A71B8F6E3AB73111D85F23634D5DD5A46FF99373832ECAEE1BCA72488E978">
|
||
<summary>Supports searching for the string "\n##\n".</summary>
|
||
</member>
|
||
<member name="F:System.Text.RegularExpressions.Generated.Utilities.s_indexOfString_B23305EF0D2F7847477C2D0284ACE7CA58A17E522D750B9B4AA3990104523EBA">
|
||
<summary>Supports searching for the string "PuTTY-User-Key-File-".</summary>
|
||
</member>
|
||
</members>
|
||
</doc>
|