sshnet / sshnet/SSH.NET

Missing async methods.

Open
#1,415 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
4.4k
Forks
993
Avg merge
9d 21h
Merged PRs (30d)
1

Description

I have noticed that some methods in SftpClient do not have async equivalents, such as Get, CreateDirectory, DeleteDirectory etc.

A workaround is to use Task.Run but the I/O done can be asynchronous, like ListDirectoryAsync and others. I need it to resolve files-community/Files#2407, instead of resorting to Task.Run.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in SftpClient and compare the synchronous methods named in the issue with the existing ListDirectoryAsync method and other async methods. Determine the intended scope for async equivalents and verify that the resulting SFTP I/O is asynchronous rather than relying on Task.Run; done means the required methods support async use for the stated Files scenario.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.