com.mastfrog.tiny.http.server.Responder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tiny-http-server Show documentation

The newest version!

/*
 * The MIT License
 *
 * Copyright 2017 Tim Boudreau.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.mastfrog.tiny.http.server;

import io.netty.handler.codec.http.HttpRequest;

/**
 * Responds to HTTP requests.
 *
 * @author Tim Boudreau
 */
@FunctionalInterface
public interface Responder {
    /**
     * Receives an HTTP request and produces a response.
     * 
     * @param req The request
     * @param response The response headers - set headers and response code
     * @return A CharSequence/String/ByteBuf/HttpContent/ChunkedResponse
     */
    Object receive(HttpRequest req, ResponseHead response) throws Exception;
}