How to set timeout in Refit library

Question

I am using Refit library in my Xamarin App, I want to set 10 seconds timeout for the request. Is there any way to do this in refit?

Interface:

interface IDevice
{
  [Get("/app/device/{id}")]
  Task<Device> GetDevice(string id, [Header("Authorization")] string authorization);
}

Invoking the API

var device = RestService.For<IDevice>("http://localhost");              
var dev = await device.GetDevice("15e2a691-06df-4741-b26e-87e1eecc6bd7", "Bearer OAUTH_TOKEN");

Bennor McCarthy · Answer 1 · 2017-10-11T22:30:48.223

31

The accepted answer is the correct way to enforce a timeout for a single request, but if you want to have a single consistent timeout value for all requests, you can pass a preconfigured HttpClient with its Timeout property set:

var api = RestService.For<IDevice>(new HttpClient 
{
    BaseAddress = new Uri("http://localhost"),
    Timeout = TimeSpan.FromSeconds(10)
});

Here is an example project.

edited Oct 11 '17 at 22:30

answered Sep 12 '17 at 20:59

Bennor McCarthy

11,415
1
49
51

It works for me. Which part doesn't work? Setting a timeout this way has nothing to do with Refit -- it's just a standard `HttpClient` thing. – Bennor McCarthy Oct 11 '17 at 22:09
@MarkFeldman Added a link to an example project to the answer. – Bennor McCarthy Oct 11 '17 at 22:31

score 25 · Accepted Answer · answered Apr 10 '17 at 10:03

25

I finally found a way of setting the timeout for a request in Refit. I used CancelationToken. Here is the modified code after adding CancelationToken

Interface:

interface IDevice
{
  [Get("/app/device/{id}")]
  Task<Device> GetDevice(string id, [Header("Authorization")] string authorization, CancellationToken cancellationToken);
}

Invoking the API:

var device = RestService.For<IDevice>("http://localhost");    
CancellationTokenSource tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(10000); // 10000 ms
CancellationToken token = tokenSource.Token;          
var dev = await device.GetDevice("15e2a691-06df-4741-b26e-87e1eecc6bd7", "Bearer OAUTH_TOKEN", token);

It works properly for me. I don't know whether it is the proper way or not. If it is a wrong, kindly suggest the correct way.

answered Apr 10 '17 at 10:03

Siddharth Eswaramoorthy

986
1
10
24

I've seen this a couple times, but it's not in the Refit documentation. Is there any documentation for this? – Denise Skidmore Dec 27 '22 at 20:01
1

I do not know if is there any documentation present for this. I found this code by looking into the auto-suggestion and method signature – Siddharth Eswaramoorthy Dec 28 '22 at 09:42
Not documentation, but found suggestive code: https://github.com/reactiveui/refit/blob/637182e90e75d433d0aa02ad28f0c62b11a4592a/Refit/RequestBuilderImplementation.cs#L853 The code also implies a default cancellation token that is used if supplied, and if not supplied the function parameter supplied cancellation token is used. – Denise Skidmore Dec 28 '22 at 15:42
https://github.com/reactiveui/refit/blob/a9cda050af41e8b135c4d0c2fe191e32175702a8/Refit/RestMethodInfo.cs#L126 – Denise Skidmore Dec 28 '22 at 15:48

G. B. · Answer 3 · 2021-12-29T11:51:16.577

Another solution: One of the tests in Refit uses this method. Add System.Reactive.Linq in nuget. Then in the interface specification:

interface IDevice
{
    [Get("/app/device/{id}")]
    IObservable<Device> GetDevice(string id, [Header("Authorization")] string authorization);
}

And in the API:

try
{
  await device.GetDevice("your_parameters_here").Timeout(TimeSpan.FromSeconds(10));
}
catch(System.TimeoutException e)
{
  Console.WriteLine("Timeout: " + e.Message);
}

+1 solution from here:

Create an extension method for your tasks:

public static class TaskExtensions
{
    public static async Task<TResult> TimeoutAfter<TResult>(this Task<TResult> task, TimeSpan timeout)
    {

        using (var timeoutCancellationTokenSource = new CancellationTokenSource())
        {

            var completedTask = await Task.WhenAny(task, Task.Delay(timeout, timeoutCancellationTokenSource.Token));
            if (completedTask == task)
            {
                timeoutCancellationTokenSource.Cancel();
                return await task;  // Very important in order to propagate exceptions
            }
            else
            {
                throw new TimeoutException("The operation has timed out.");
            }
        }
    }
}

Interface can be left using Task<Device> return value. In the API:

try
{
  await _server.ListGasLines().TimeoutAfter(TimeSpan.FromSeconds(10));
}
catch(System.TimeoutException e)
{
  Console.WriteLine("Timeout: " + e.Message);
}

How to set timeout in Refit library

3 Answers3