Async/Await and synchronous code common?

Question

5.00/5 (1 vote)

See more:

.NET4.5

I have created a library that has both synchronous and asynchronous versions of each method. Each method has a lot of common code, but the differences within the methods are the presence of the await keyword and the method signature.

What I would like to do is have a way so that I don't have to replicate code between the two methods. I am just not sure as to how to do this. I have read that wrapping either version and calling from the other one is a bad idea.

Below is an example of what I am talking about. I have two methods for GetDirectoryListing - GetDirectoryListing and GetDirectoryListingAsync. I'd like to have a way to eliminate the duplicated code.

Thanks.

C#

public static List<string> GetDirectoryListing(FTPLoginCredentials credentials)
        {
            List<string> directoryListing = new List<string>();
                FtpWebRequest ftpReq = CreateFtpWebRequest(credentials, WebRequestMethods.Ftp.ListDirectory);

                using (FtpWebResponse ftpResp = (FtpWebResponse)ftpReq.GetResponse())
                {
                    string html;
                    using (StreamReader sr = new StreamReader(ftpResp.GetResponseStream(), System.Text.Encoding.UTF8))
                        html = sr.ReadToEnd();
                    directoryListing.AddRange(html.Split(new string[] { Environment.NewLine, "\r" }, StringSplitOptions.RemoveEmptyEntries));
                }
                return directoryListing;
            }
        }

public static async Task<List<string>> GetDirectoryListingAsync(FTPLoginCredentials credentials)
        {
            List<string> directoryListing = new List<string>();
            FtpWebRequest ftpReq = CreateFtpWebRequest(credentials, WebRequestMethods.Ftp.ListDirectory);

                using (FtpWebResponse ftpResp = (FtpWebResponse)await ftpReq.GetResponseAsync())
                {
                    string html;
                    using (StreamReader sr = new StreamReader(ftpResp.GetResponseStream(), System.Text.Encoding.UTF8))
                        html = await sr.ReadToEndAsync().ConfigureAwait(false);
                    directoryListing.AddRange(html.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries));
                }
                return directoryListing;
        }

Posted 26-Jan-16 10:17am

David Knechtges

Add a Solution

Comments

BillWoodruff 27-Jan-16 4:58am

Probably useful:

http://stackoverflow.com/questions/16976726/providing-synchronous-and-asynchronous-versions-of-an-api-in-library-code?rq=1

http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx

http://blogs.msdn.com/b/pfxteam/archive/2012/03/24/10287244.aspx

David Knechtges 27-Jan-16 9:26am

Bill, thanks I ended up using http://blogs.msdn.com/b/pfxteam/archive/2012/04/13/10293638.aspx

under the sections avoid unnecessary marshalling and offloading to another thread.

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

bling · Answer 1 · 2016-01-26T12:16:00

The easy way out is to have the blocking code implemented as a thin wrapper around the async code.

C++

public static async Task<list<string>> GetDirectoryListingAsync(FTPLoginCredentials credentials)
{
    List<string> directoryListing = new List<string>();
    FtpWebRequest ftpReq = CreateFtpWebRequest(credentials, WebRequestMethods.Ftp.ListDirectory);

        using (FtpWebResponse ftpResp = (FtpWebResponse)await ftpReq.GetResponseAsync())
        {
            string html;
            using (StreamReader sr = new StreamReader(ftpResp.GetResponseStream(), System.Text.Encoding.UTF8))
                html = await sr.ReadToEndAsync().ConfigureAwait(false);
            directoryListing.AddRange(html.Split(new string[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries));
        }
        return directoryListing;
}

public static List<string> GetDirectoryListing(FTPLoginCredentials credentials)
{
    Task<list<string>> task = GetDirectoryListingAsync(credentials);
    task.Wait();
    return task.Result;
}