OnKeepAliveServlet.java

package server.restful.servlets.hls;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.converter.FractionSecondsToMsConverter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.requestparam.VideoRequestParamServletParameters;

import java.util.UUID;

import static java.lang.Integer.MIN_VALUE;
import static server.restful.JSIDPlay2Server.CONTEXT_ROOT_STATIC;
import static server.restful.common.ServletUtil.error;
import static server.restful.common.rtmp.PlayerCleanupTimerTask.update;

@WebServlet(name = "OnKeepAliveServlet", displayName = "OnKeepAliveServlet", urlPatterns = CONTEXT_ROOT_STATIC
        + "/on_keep_alive", description = "Keep alive video stream")
public class OnKeepAliveServlet extends JSIDPlay2Servlet {

    @SuppressWarnings("unused")
    @Parameters(resourceBundle = "server.restful.servlets.hls.OnKeepAliveServletParameters")
    public static class OnKeepAliveServletParameters extends VideoRequestParamServletParameters {

        private Long currentTime;

        public Long getCurrentTime() {
            return currentTime;
        }

        @Parameter(names = {
                "--currentTime"}, converter = FractionSecondsToMsConverter.class, descriptionKey = "CURRENT_TIME", order = MIN_VALUE
                + 2)
        public void setCurrentTime(Long currentTime) {
            this.currentTime = currentTime;
        }

        private Long bufferedEnd;

        public Long getBufferedEnd() {
            return bufferedEnd;
        }

        @Parameter(names = {
                "--bufferedEnd"}, converter = FractionSecondsToMsConverter.class, descriptionKey = "BUFFERED_END", order = MIN_VALUE
                + 3)
        public void setBufferedEnd(Long bufferedEnd) {
            this.bufferedEnd = bufferedEnd;
        }
    }

    /**
     * Keep alive video stream.
     * <p>
     * Compensates for HLS's missing directives (on_play and on_play_done), notifies that the stream is still being
     * consumed.
     * <p>
     * E.g. {@code http://haendel.ddns.net:8080/static/on_keep_alive }
     * <p>
     * Example parameters:
     *
     * <pre>
     * name=&lt;UUID&gt;
     * </pre>
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {
        try {
            final OnKeepAliveServletParameters servletParameters = new OnKeepAliveServletParameters();

            ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);

            if (servletParameters.getHelp() || parser.hasException()) {
                parser.usage();
                return;
            }
            UUID uuid = servletParameters.getUuid();
            Long currentTime = servletParameters.getCurrentTime();
            Long bufferedEnd = servletParameters.getBufferedEnd();

            update(uuid, playerWithStatus -> playerWithStatus.onKeepAlive(currentTime, bufferedEnd));

        } catch (Throwable t) {
            response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
            error(getServletContext(), t);
            setOutput(response, t);
        }
    }

}