nugu_http.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. 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.
 */
 
#ifndef __NUGU_HTTP_H__
#define __NUGU_HTTP_H__
 
#include <stddef.h>
#include <nugu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _nugu_http_host NuguHttpHost;
 
typedef struct _nugu_http_header NuguHttpHeader;
 
typedef struct _nugu_http_request NuguHttpRequest;
 
typedef struct _nugu_http_response NuguHttpResponse;
 
enum NuguHttpRequestType {
        NUGU_HTTP_REQUEST_GET, /* GET Request */
        NUGU_HTTP_REQUEST_POST, /* POST Request */
        NUGU_HTTP_REQUEST_PUT, /* PUT Request */
        NUGU_HTTP_REQUEST_DELETE, /* DELETE Request */
};
 
struct _nugu_http_response {
        const void *body; /* Response body */
        size_t body_len; /* Response body length */
        const void *header; /* Response header */
        size_t header_len; /* Response header length */
        long code; /* Response code (200, 404, ... -1) */
};
 
typedef int (*NuguHttpCallback)(NuguHttpRequest *req,
                                const NuguHttpResponse *resp, void *user_data);
 
typedef int (*NuguHttpProgressCallback)(NuguHttpRequest *req,
                                        const NuguHttpResponse *resp,
                                        long long downloaded, long long total,
                                        void *user_data);
 
NUGU_API void nugu_http_init(void);
 
NUGU_API NuguHttpHost *nugu_http_host_new(const char *url);
 
NUGU_API void nugu_http_host_set_timeout(NuguHttpHost *host, long msecs);
 
NUGU_API void nugu_http_host_set_connection_timeout(NuguHttpHost *host,
                                                    long msecs);
 
NUGU_API const char *nugu_http_host_peek_url(NuguHttpHost *host);
 
NUGU_API void nugu_http_host_free(NuguHttpHost *host);
 
NUGU_API NuguHttpHeader *nugu_http_header_new(void);
 
NUGU_API int nugu_http_header_add(NuguHttpHeader *header, const char *key,
                                  const char *value);
 
NUGU_API int nugu_http_header_remove(NuguHttpHeader *header, const char *key);
 
NUGU_API const char *nugu_http_header_find(NuguHttpHeader *header,
                                           const char *key);
 
NUGU_API NuguHttpHeader *nugu_http_header_dup(const NuguHttpHeader *src_header);
 
NUGU_API int nugu_http_header_import(NuguHttpHeader *header,
                                     const NuguHttpHeader *from);
 
NUGU_API void nugu_http_header_free(NuguHttpHeader *header);
 
NUGU_API NuguHttpRequest *
nugu_http_request(enum NuguHttpRequestType type, NuguHttpHost *host,
                  const char *path, NuguHttpHeader *header, const void *body,
                  size_t body_len, NuguHttpCallback callback, void *user_data);
 
NUGU_API NuguHttpRequest *
nugu_http_request_sync(enum NuguHttpRequestType type, NuguHttpHost *host,
                       const char *path, NuguHttpHeader *header,
                       const void *body, size_t body_len);
 
NUGU_API NuguHttpRequest *nugu_http_get(NuguHttpHost *host, const char *path,
                                        NuguHttpHeader *header,
                                        NuguHttpCallback callback,
                                        void *user_data);
 
NUGU_API NuguHttpRequest *nugu_http_get_sync(NuguHttpHost *host,
                                             const char *path,
                                             NuguHttpHeader *header);
 
NUGU_API NuguHttpRequest *nugu_http_post(NuguHttpHost *host, const char *path,
                                         NuguHttpHeader *header,
                                         const void *body, size_t body_len,
                                         NuguHttpCallback callback,
                                         void *user_data);
 
NUGU_API NuguHttpRequest *
nugu_http_post_sync(NuguHttpHost *host, const char *path,
                    NuguHttpHeader *header, const void *body, size_t body_len);
 
NUGU_API NuguHttpRequest *nugu_http_put(NuguHttpHost *host, const char *path,
                                        NuguHttpHeader *header,
                                        const void *body, size_t body_len,
                                        NuguHttpCallback callback,
                                        void *user_data);
 
NUGU_API NuguHttpRequest *nugu_http_put_sync(NuguHttpHost *host,
                                             const char *path,
                                             NuguHttpHeader *header,
                                             const void *body, size_t body_len);
 
NUGU_API NuguHttpRequest *nugu_http_delete(NuguHttpHost *host, const char *path,
                                           NuguHttpHeader *header,
                                           NuguHttpCallback callback,
                                           void *user_data);
 
NUGU_API NuguHttpRequest *nugu_http_delete_sync(NuguHttpHost *host,
                                                const char *path,
                                                NuguHttpHeader *header);
 
NUGU_API NuguHttpRequest *
nugu_http_download(NuguHttpHost *host, const char *path, const char *dest_path,
                   NuguHttpHeader *header, NuguHttpCallback callback,
                   NuguHttpProgressCallback progress_callback, void *user_data);
 
NUGU_API void nugu_http_request_free(NuguHttpRequest *req);
 
NUGU_API NuguHttpResponse *nugu_http_response_dup(const NuguHttpResponse *orig);
 
NUGU_API void nugu_http_response_free(NuguHttpResponse *resp);
 
NUGU_API const NuguHttpResponse *
nugu_http_request_response_get(NuguHttpRequest *req);
 
#ifdef __cplusplus
}
#endif
 
#endif