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

비밀번호

댓글 쓴 사람
 




... 16  17  18  19  20  21  22  23  24  25  26  27  [28]  29  30  ...
NoWriterDateCnt.TitleFile(s)
11531정성태6/5/20185591오류 유형: 468. JSON.parse가 허용하지 않는 문자 [9]
11530정성태6/10/20183712.NET Framework: 755. C# 7.2 - 스택에만 생성할 수 있는 값 타입 지원 - "ref struct" [2]파일 다운로드1
11529정성태5/23/20182914.NET Framework: 754. 닷넷의 관리 포인터(Managed Pointer)와 System.TypedReference [5]파일 다운로드1
11528정성태6/10/20182859.NET Framework: 753. C# 7.2 - 3항 연산자에 ref 지원(conditional ref operator) [1]
11527정성태5/17/20182643오류 유형: 467. RDP 로그인 에러 - This could be due to CredSSP encryption oracle remediation.
11526정성태6/10/20182412.NET Framework: 752. C# 7.2 - 메서드의 반환값 및 로컬 변수에 ref readonly 기능 추가파일 다운로드1
11525정성태6/10/20182588.NET Framework: 751. C# 7.2 - 메서드의 매개 변수에 in 변경자 추가파일 다운로드1
11524정성태6/10/20183547.NET Framework: 750. C# 7.2 - readonly 구조체 [3]파일 다운로드1
11523정성태5/15/20182961.NET Framework: 749. C# - 값 형식의 readonly 인스턴스에 대한 메서드 호출 시 defensive copy 발생 [1]파일 다운로드1
11522정성태5/15/20181884개발 환경 구성: 378. Azure - VM 진단 설정 화면의 "This subscription is not registered with the Microsoft.Insights resource provider."
11521정성태5/15/20181892개발 환경 구성: 377. Azure - 원하는 성능 데이터로 모니터링 대시보드 구성
11520정성태5/12/20182471.NET Framework: 748. C# 7.1 - 참조 어셈블리(Ref Assemblies)
11519정성태3/13/20192670개발 환경 구성: 376. ASP.NET Web Application 프로젝트의 FileSystem 배포(Publish) 시 Before/After Task 설정 방법 [1]
11518정성태5/11/20182345.NET Framework: 747. C# 7.0에서도 부분적으로 가능해진 "타입 추론을 통한 튜플의 변수명 자동 지정"
11517정성태5/10/20182627.NET Framework: 746. Azure runbook 예제 - 6시간 동안 수행 중인 VM을 중지 [1]파일 다운로드1
11516정성태5/9/20182007.NET Framework: 745. Azure runbook을 PowerShell 또는 C# 코드로 실행하는 방법파일 다운로드1
11515정성태6/8/20182359.NET Framework: 744. C# 6 - Expression bodied function
11514정성태5/3/20183800오류 유형: 466. Bitvise - Error in component session/transport/kexHandler [2]
11513정성태5/10/20184599.NET Framework: 743. C# 언어의 공변성과 반공변성 [5]파일 다운로드1
11512정성태5/3/20182116개발 환경 구성: 375. Azure runbook 실행 시 "Errors", "All Logs"에 오류 메시지가 출력되는 경우
11511정성태5/2/20182353개발 환경 구성: 374. Azure - Runbook 기능 소개
11510정성태4/30/20184000.NET Framework: 742. windbg로 확인하는 Finalizer를 가진 객체의 GC 과정파일 다운로드1
11509정성태4/28/20183505.NET Framework: 741. windbg로 확인하는 객체의 GC 여부
11508정성태4/23/20182724개발 환경 구성: 373. MSBuild를 이용해 프로젝트 배포 후 결과물을 zip 파일로 압축하는 방법파일 다운로드1
11507정성태9/29/20182922개발 환경 구성: 372. MSBuild - 빌드 전/후, 배포 전/후 실행하고 싶은 Task 정의
11506정성태6/27/20185686.NET Framework: 740. C#에서 enum을 boxing 없이 int로 변환하기 - 두 번째 이야기 [7]파일 다운로드1
... 16  17  18  19  20  21  22  23  24  25  26  27  [28]  29  30  ...