1/*
2 * Copyright (C) 2012 Intel Corporation. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26/**
27 * @file    ewk_url_scheme_request.h
28 * @brief   Describes the Ewk URL scheme request API.
29 */
30
31#ifndef ewk_url_scheme_request_h
32#define ewk_url_scheme_request_h
33
34#include <Eina.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/**
41 * Declare Ewk_Url_Scheme_Request as Ewk_Object.
42 *
43 * @see Ewk_Object
44 */
45typedef struct EwkObject Ewk_Url_Scheme_Request;
46
47/**
48 * Query the URL scheme for this request.
49 *
50 * @param request request object to query.
51 *
52 * @return the URL scheme pointer, that may be @c NULL. This pointer is
53 *         guaranteed to be eina_stringshare, so whenever possible
54 *         save yourself some cpu cycles and use
55 *         eina_stringshare_ref() instead of eina_stringshare_add() or
56 *         strdup().
57 */
58EAPI const char *ewk_url_scheme_request_scheme_get(const Ewk_Url_Scheme_Request *request);
59
60/**
61 * Query the URL for this request.
62 *
63 * @param request request object to query.
64 *
65 * @return the URL pointer, that may be @c NULL. This pointer is
66 *         guaranteed to be eina_stringshare, so whenever possible
67 *         save yourself some cpu cycles and use
68 *         eina_stringshare_ref() instead of eina_stringshare_add() or
69 *         strdup().
70 */
71EAPI const char *ewk_url_scheme_request_url_get(const Ewk_Url_Scheme_Request *request);
72
73/**
74 * Query the path part of the URL for this request.
75 *
76 * @param request request object to query.
77 *
78 * @return the path pointer, that may be @c NULL. This pointer is
79 *         guaranteed to be eina_stringshare, so whenever possible
80 *         save yourself some cpu cycles and use
81 *         eina_stringshare_ref() instead of eina_stringshare_add() or
82 *         strdup().
83 */
84EAPI const char *ewk_url_scheme_request_path_get(const Ewk_Url_Scheme_Request *request);
85
86/**
87 * Finish a Ewk_Url_Scheme_Request by setting the content of the request and its mime type.
88 *
89 * @param request a Ewk_Url_Scheme_Request.
90 * @param content_data the data content of the request (may be %c NULL if the content is empty).
91 * @param content_length the length of the @a content_data.
92 * @param mime_type the content type of the stream or %c NULL if not known
93 */
94EAPI Eina_Bool ewk_url_scheme_request_finish(Ewk_Url_Scheme_Request *request, const void *content_data, uint64_t content_length, const char *mime_type);
95
96#ifdef __cplusplus
97}
98#endif
99
100#endif // ewk_url_scheme_request_h
101