Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.SftpMessage

Modifier and Type	Field and Description
private final IoWriteFuture	future
private final int	id
private final Duration	timeout

Constructor Summary

Access	Constructor and Description
public	SftpMessage(int SFTP message id id, IoWriteFuture `IoWriteFuture` of the SFTP message; can be used to wait until the message has been actually sent future, Duration the configured SFTP write timeout timeout) Creates a new instance.

Modifier and Type	Method and Description
public IoWriteFuture	Returns: the `IoWriteFuture`, never `null` getFuture() Retrieves the `IoWriteFuture` of the message; can be used to wait until the message has been actually sent.
public int	Returns: the SFTP message id getId() Retrieves the SFTP message id.
public Duration	Returns: the timeout, never `null` getTimeout() Retrieves the write timeout configured when the message was sent.
public void	waitUntilSent() Waits with the configured timeout until the message has been sent.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

future	back to summary
private final IoWriteFuture future

id	back to summary
private final int id

timeout	back to summary
private final Duration timeout

SftpMessage back to summary

SftpMessage	back to summary
public SftpMessage(int id, IoWriteFuture future, Duration timeout) Creates a new instance. Parameters id:int SFTP message id future:IoWriteFuture `IoWriteFuture` of the SFTP message; can be used to wait until the message has been actually sent timeout:Duration the configured SFTP write timeout

public SftpMessage(int id, IoWriteFuture future, Duration timeout)

Creates a new instance.

Parameters

id:int: SFTP message id
future:IoWriteFuture: IoWriteFuture of the SFTP message; can be used to wait until the message has been actually sent
timeout:Duration: the configured SFTP write timeout

getFuture back to summary

getFuture	back to summary
public IoWriteFuture getFuture() Retrieves the `IoWriteFuture` of the message; can be used to wait until the message has been actually sent. Returns:IoWriteFuture the `IoWriteFuture`, never `null`

public IoWriteFuture getFuture()

Retrieves the IoWriteFuture of the message; can be used to wait until the message has been actually sent.

getId	back to summary
public int getId() Retrieves the SFTP message id. Returns:int the SFTP message id

getId

public int getId()

Retrieves the SFTP message id.

getTimeout back to summary

getTimeout	back to summary
public Duration getTimeout() Retrieves the write timeout configured when the message was sent. Returns:Duration the timeout, never `null`

public Duration getTimeout()

Retrieves the write timeout configured when the message was sent.

waitUntilSent	back to summary
public void waitUntilSent() throws IOException Waits with the configured timeout until the message has been sent. Exceptions IOException: if the message could not be sent, or waiting is interrupted.

waitUntilSent

public void waitUntilSent() throws IOException

Waits with the configured timeout until the message has been sent.

Exceptions