sol-http-server.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <sol-common-buildopts.h>
#include <sol-certificate.h>
#include <sol-http.h>
#include <sol-network.h>
#include <time.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_http_server;
typedef struct sol_http_server sol_http_server;

typedef struct sol_http_server_config {
#ifndef SOL_NO_API_VERSION
#define SOL_HTTP_SERVER_CONFIG_API_VERSION (1)  
    uint16_t api_version;
#endif

    uint16_t port;
    struct {
        const struct sol_cert *cert;
        const struct sol_cert *key;
    } security;
} sol_http_server_config;

struct sol_http_request;
typedef struct sol_http_request sol_http_request;

struct sol_http_progressive_response;
typedef struct sol_http_progressive_response sol_http_progressive_response;

struct sol_http_server *sol_http_server_new(const struct sol_http_server_config *config);

void sol_http_server_del(struct sol_http_server *server);

int sol_http_server_register_handler(struct sol_http_server *server, const char *path,
    int (*request_cb)(void *data, struct sol_http_request *request),
    const void *data);

int sol_http_server_unregister_handler(struct sol_http_server *server, const char *path);

int sol_http_server_add_dir(struct sol_http_server *server, const char *basename, const char *rootdir);

int sol_http_server_remove_dir(struct sol_http_server *server, const char *basename, const char *rootdir);

#ifdef SOL_FEATURE_FILESYSTEM

int sol_http_server_set_error_page(struct sol_http_server *server,
    const enum sol_http_status_code error, const char *page);

int sol_http_server_remove_error_page(struct sol_http_server *server,
    const enum sol_http_status_code error);

#endif /*SOL_FEATURE_FILESYSTEM*/

int sol_http_server_set_last_modified(struct sol_http_server *server, const char *path, time_t modified);

int sol_http_server_send_response(struct sol_http_request *request, struct sol_http_response *response);

static inline int
sol_http_response_set_sse_headers(struct sol_http_response *response)
{
    const struct { const char *k; const char *v; } *itr, headers[] = {
        { "Content-Type", "text/event-stream" },
        { "Connection", "keep-alive" },
        { "Cache-Control", "no-cache" },
        { NULL, NULL }
    };

    if (!response)
        return -EINVAL;

    for (itr = headers; itr->k != NULL; itr++) {
        if (sol_http_params_add(&response->param,
            SOL_HTTP_REQUEST_PARAM_HEADER(itr->k, itr->v)) < 0) {
            return -ENOMEM;
        }
    }

    return 0;
}

typedef struct sol_http_server_progressive_config {
#ifndef SOL_NO_API_VERSION
#define SOL_HTTP_SERVER_PROGRESSIVE_CONFIG_API_VERSION (1)

    uint16_t api_version;
#endif

    void (*on_feed_done)(void *data, struct sol_http_progressive_response *progressive, struct sol_blob *blob, int status);
    void (*on_close)(void *data, const struct sol_http_progressive_response *progressive);
    const void *user_data; /*<< User data to @c on_feed and @c on_close*/
    size_t feed_size;
} sol_http_server_progressive_config;

struct sol_http_progressive_response *sol_http_server_send_progressive_response(struct sol_http_request *request,
    const struct sol_http_response *response, const struct sol_http_server_progressive_config *config);

int sol_http_progressive_response_feed(struct sol_http_progressive_response *progressive,
    struct sol_blob *blob);

int sol_http_progressive_response_sse_feed(struct sol_http_progressive_response *progressive,
    struct sol_blob *blob);

void sol_http_progressive_response_del(struct sol_http_progressive_response *progressive, bool graceful_del);

const char *sol_http_request_get_url(const struct sol_http_request *request);

const struct sol_http_params *sol_http_request_get_params(const struct sol_http_request *request);

enum sol_http_method sol_http_request_get_method(const struct sol_http_request *request);

int sol_http_request_get_interface_address(const struct sol_http_request *request,
    struct sol_network_link_addr *address);

int sol_http_request_get_client_address(const struct sol_http_request *request,
    struct sol_network_link_addr *address);

int sol_http_server_set_buffer_size(struct sol_http_server *server, size_t buf_size);

int sol_http_server_get_buffer_size(struct sol_http_server *server, size_t *buf_size);

#ifdef __cplusplus
}
#endif