Microsoft MVP성태의 닷넷 이야기
글쓴 사람
홈페이지
첨부 파일

C# - async를 Task 타입이 아닌 사용자 정의 타입에 적용하는 방법

이전 글에서, await의 대상이 되는 메서드의 반환값을 우리가 정의한 타입으로 바꾸는 방법을 설명했습니다.

C# - await을 Task 타입이 아닌 사용자 정의 타입에 적용하는 방법
; https://www.sysnet.pe.kr/2/0/11456

이번엔 저 글의 예제에 사용된 MyTask를 async 메서드의 반환 타입으로도 사용할 수 있도록 확장해 보겠습니다.




지난번 예제에서 Task와 MyTask를 반환하는 메서드를 각각 async 예약어를 붙여 코드를 수정하면,

private static async Task TaskAwait()
{
    await new TaskFactory().StartNew(() => { Thread.Sleep(5000); });
}

// CS1983 컴파일 에러 발생
private static async MyTask TestAwait()
{
    MyTask task = new MyTask( () =>
    {
        Thread.Sleep(5000);
    });

    await task;
}

빌드 시 MyTask를 반환하는 코드에 대해 다음과 같은 컴파일 오류가 발생합니다.

CS1983 The return type of an async method must be void, Task or Task<T>

의미인즉, async 메서드는 반환 타입이 반드시 void, Task, Task<T> 중의 하나여야 한다는 것입니다. 하지만 C# 7.0부터 "일반화된 비동기 반환 형식"을 지원하면서 그 외의 타입으로도 가능하게 바뀌었습니다. 일례로 ValueTask<T> 타입이 그것입니다.

사용자 정의 타입을 async 메서드의 반환 타입으로 쓰려면,

Return Any (Task-Like) Type From An Async Method
; http://blog.i3arnon.com/2016/07/25/arbitrary-async-returns/

다음의 2가지 타입을 더 구현해야 합니다.

  • 사용자 정의 Method Builder 타입 정의
  • 사용자 정의 Awaiter 타입 정의

따라서 우리가 구현한 MyTask에 대한 사용자 정의 Method Builder를 다음과 같이 구현할 수 있습니다.

public struct AsyncMyTaskMethodBuilder
{
    AsyncTaskMethodBuilder _methodBuilder;

    public MyTask Task
    {
        get
        {
            return new MyTask(_methodBuilder.Task);
        }
    }

    public static AsyncMyTaskMethodBuilder Create()
    {
        return new AsyncMyTaskMethodBuilder { _methodBuilder = AsyncTaskMethodBuilder.Create() };
    }

    public void SetException(Exception exception)
    {
        _methodBuilder.SetException(exception);
    }

    public void SetResult()
    {
        _methodBuilder.SetResult();
    }

    public void AwaitOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine) where TAwaiter : INotifyCompletion where TStateMachine : IAsyncStateMachine
    {
        _methodBuilder.AwaitOnCompleted(ref awaiter, ref stateMachine);
    }

    public void AwaitUnsafeOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine) where TAwaiter : ICriticalNotifyCompletion where TStateMachine : IAsyncStateMachine
    {
        _methodBuilder.AwaitUnsafeOnCompleted(ref awaiter, ref stateMachine);
    }

    public void SetStateMachine(IAsyncStateMachine stateMachine)
    {
        _methodBuilder.SetStateMachine(stateMachine);
    }

    public void Start<TStateMachine>(ref TStateMachine stateMachine) where TStateMachine : IAsyncStateMachine
    {
        _methodBuilder.Start(ref stateMachine);
    }
}

그다음 Awaiter를 이런 식으로 정의해 주면 됩니다.

public struct MyTaskAwaiter : ICriticalNotifyCompletion, INotifyCompletion
{
    MyTask _task;

    public MyTaskAwaiter(MyTask t)
    {
        _task = t;
    }

    public bool IsCompleted
    {
        get
        {
            return _task.IsCompleted;
        }
    }

    public void GetResult()
    {
    }

    public void OnCompleted(Action continuation)
    {
        if (_task.Task == null)
        {
            _task.AddContinuation(continuation);
        }
        else
        {
            _task.Task.GetAwaiter().OnCompleted(continuation);
        }
    }

    public void UnsafeOnCompleted(Action continuation)
    {
        if (_task.Task == null)
        {
            _task.AddContinuation(continuation);
        }
        else
        {
            _task.Task.GetAwaiter().UnsafeOnCompleted(continuation);
        }
    }
}

마지막으로 우리가 정의한 MyTask 타입에 새롭게 정의한 Method Builder 타입을 연결하고 기타 작업을 추가해야 합니다.

[AsyncMethodBuilder(typeof(AsyncMyTaskMethodBuilder))]
public class MyTask
{
    Thread _t;
    Task _task;

    internal Task Task
    {
        get { return _task; }
    }

    bool _isCompleted;
    List<Action> _continuation = new List<Action>();

    public void AddContinuation(Action action)
    {
        if (_t == null)
        {
            _task.ContinueWith((t) => { action(); });
        }
        else
        {
            _continuation.Add(action);
        }
    }

    public bool IsCompleted
    {
        get
        {
            if (_t == null)
            {
                return _task.IsCompleted;
            }
                
            return _isCompleted;
        }
    }

    public MyTask(Task task)
    {
        _task = task;
    }

    public MyTask(Action action)
    {
        _t = new Thread(
            (ThreadStart)( 
            () =>
            {
                action();
                _isCompleted = true;

                foreach (var item in _continuation)
                {
                    item();
                }
            }
            )
        );

        _t.Start();
    }

    public MyTaskAwaiter GetAwaiter()
    {
        MyTaskAwaiter ta = new MyTaskAwaiter(this);
        return ta;
    }
}

이렇게 변경한 후, 다시 빌드하면 컴파일 오류가 발생했던 TestAwait 메서드가 정상적으로 빌드되는 것을 확인할 수 있습니다.

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




구현을 보면 알겠지만, 사실 async/await 관련 구현은 Task 객체를 기반으로 사용자 정의 타입을 정의했을 때 부드럽게 연결이 됩니다. 즉, async 메서드에 사용자 정의 타입을 반환할 수 있다고는 하지만 결국 Task 타입을 기반으로 한 사용자 정의 타입인 경우에만 구현이 용이하게 되어 있습니다.

그나저나, "C# - await을 Task 타입이 아닌 사용자 정의 타입에 적용하는 방법" 글을 쓸 때에도 마지막에 C# 5.0부터 가능했었다는 말을 했었는데요. 하지만, C# 7.0 문서에서는 await이 아닌 async 메서드를 대상으로 "일반화된 비동기 반환 형식"이 가능하다고 했기 때문에 일단 저 글에서는 마지막 내용을 취소선으로 표시했습니다.

그런데, 이번 글에 쓴 코드 역시 C# 5.0 컴파일러에서도 잘 빌드가 됩니다. 즉, "일반화된 비동기 반환 형식"은 C# 7.0부터 제공한 기능이라기보다는 그냥 7.0부터 본격적으로 소개를 한 것입니다. 사실 이에 대해서는 ValueTask의 소개 시점을 유추해 보면 좀 이상하긴 했습니다. 왜냐하면 최초 ValueTask가,

System.Threading.Tasks.Extensions
; https://www.nuget.org/packages/System.Threading.Tasks.Extensions/

릴리스된 날짜가 2016년 5월인 반면 C# 7.0은 2017년 3월이었기 때문에 C# 7.0의 "Generalized async return types" 덕분에 구현이 가능했던 것은 아니기 때문입니다.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]





[최초 등록일: ]
[최종 수정일: 4/11/2018 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12218정성태5/27/202033.NET Framework: 904. C# - DirectX 게임 클라이언트 실행 중 키보드 입력을 감지하는 방법
12217정성태5/24/202021오류 유형: 615. Transaction count after EXECUTE indicates a mismatching number of BEGIN and COMMIT statements. Previous count = 0, current count = 1.
12216정성태5/15/202089.NET Framework: 904. USB/IP PROJECT를 이용해 C#으로 USB Keyboard 가상 장치 만들기
12215정성태5/12/2020109개발 환경 구성: 490. C# - (Wireshark의) USBPcap을 이용한 USB 패킷 모니터링파일 다운로드1
12214정성태5/5/202098개발 환경 구성: 489. 정식 인증서가 있는 경우 Device Driver 서명하는 방법 (2) - UEFI/SecureBoot
12213정성태5/3/2020185개발 환경 구성: 488. (코드로 가상 USB 장치를 만들 수 있는) USB/IP PROJECT 소개
12212정성태5/1/202092개발 환경 구성: 487. UEFI / Secure Boot 상태인지 확인하는 방법
12211정성태4/27/2020198개발 환경 구성: 486. WSL에서 Makefile로 공개된 리눅스 환경의 C/C++ 소스 코드 빌드
12210정성태4/20/2020298.NET Framework: 903. .NET Framework의 Strong-named 어셈블리 바인딩 (1) - app.config을 이용한 바인딩 리디렉션 [1]파일 다운로드1
12209정성태4/13/2020164오류 유형: 614. 리눅스 환경에서 C/C++ 프로그램이 Segmentation fault 에러가 발생한 경우 (2)
12208정성태4/12/2020192Linux: 29. 리눅스 환경에서 C/C++ 프로그램이 Segmentation fault 에러가 발생한 경우
12207정성태4/2/2020185스크립트: 19. Windows PowerShell의 NonInteractive 모드
12206정성태4/2/2020266오류 유형: 613. 파일 잠금이 바로 안 풀린다면? - The process cannot access the file '...' because it is being used by another process.
12205정성태4/2/2020166스크립트: 18. Powershell에서는 cmd.exe의 명령어를 지원하진 않습니다.
12204정성태4/1/2020160스크립트: 17. Powershell 명령어에 ';' (semi-colon) 문자가 포함된 경우
12203정성태3/18/2020355오류 유형: 612. warning: 'C:\ProgramData/Git/config' has a dubious owner: '...'.
12202정성태3/18/2020361개발 환경 구성: 486. .NET Framework 프로젝트를 위한 GitLab CI/CD Runner 구성
12201정성태3/18/2020188오류 유형: 611. git-credential-manager.exe: Using credentials for username "Personal Access Token".
12200정성태3/18/2020451VS.NET IDE: 145. NuGet + Github 라이브러리 디버깅 관련 옵션 3가지 - "Enable Just My Code" / "Enable Source Link support" / "Suppress JIT optimization on module load (Managed only)"
12199정성태3/17/2020179오류 유형: 610. C# - CodeDomProvider 사용 시 Unhandled Exception: System.IO.DirectoryNotFoundException: Could not find a part of the path '...\f2_6uod0.tmp'.
12198정성태3/17/2020193오류 유형: 609. SQL 서버 접속 시 "Cannot open user default database. Login failed."
12197정성태3/17/2020303VS.NET IDE: 144. .NET Core 콘솔 응용 프로그램을 배포(publish) 시 docker image 자동 생성 - 두 번째 이야기
12196정성태3/17/2020279오류 유형: 608. The ServicedComponent being invoked is not correctly configured (Use regsvcs to re-register).
12195정성태3/17/2020374.NET Framework: 902. C# - 프로세스의 모든 핸들을 열람 - 세 번째 이야기
12194정성태3/16/2020221오류 유형: 607. PostgreSQL - Npgsql.NpgsqlException: sorry, too many clients already
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...