aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/TimeSyncController.cs
blob: d7304cf4264842d46ea3409770528df30e11e3e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
using System;
using MediaBrowser.Model.SyncPlay;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Jellyfin.Api.Controllers;

/// <summary>
/// The time sync controller.
/// </summary>
[Route("")]
public class TimeSyncController : BaseJellyfinApiController
{
    /// <summary>
    /// Gets the current UTC time.
    /// </summary>
    /// <response code="200">Time returned.</response>
    /// <returns>An <see cref="UtcTimeResponse"/> to sync the client and server time.</returns>
    [HttpGet("GetUtcTime")]
    [ProducesResponseType(statusCode: StatusCodes.Status200OK)]
    public ActionResult<UtcTimeResponse> GetUtcTime()
    {
        // Important to keep the following line at the beginning
        var requestReceptionTime = DateTime.UtcNow;

        // Important to keep the following line at the end
        var responseTransmissionTime = DateTime.UtcNow;

        // Implementing NTP on such a high level results in this useless
        // information being sent. On the other hand it enables future additions.
        return new UtcTimeResponse(requestReceptionTime, responseTransmissionTime);
    }
}