2 * Copyright (C) 2012 Intel Corporation. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
27 * @file ewk_url_scheme_request.h
28 * @brief Describes the Ewk URL scheme request API.
31 #ifndef ewk_url_scheme_request_h
32 #define ewk_url_scheme_request_h
40 /** Creates a type name for Ewk_Url_Scheme_Request */
41 typedef struct Ewk_Url_Scheme_Request Ewk_Url_Scheme_Request;
44 * Increases the reference count of the given object.
46 * @param request the URL scheme request object to increase the reference count
48 * @return a pointer to the object on success, @c NULL otherwise.
50 EAPI Ewk_Url_Scheme_Request *ewk_url_scheme_request_ref(Ewk_Url_Scheme_Request *request);
53 * Decreases the reference count of the given object, possibly freeing it.
55 * When the reference count it's reached 0, the URL scheme request is freed.
57 * @param request the URL request object to decrease the reference count
59 EAPI void ewk_url_scheme_request_unref(Ewk_Url_Scheme_Request *request);
62 * Query the URL scheme for this request.
64 * @param request request object to query.
66 * @return the URL scheme pointer, that may be @c NULL. This pointer is
67 * guaranteed to be eina_stringshare, so whenever possible
68 * save yourself some cpu cycles and use
69 * eina_stringshare_ref() instead of eina_stringshare_add() or
72 EAPI const char *ewk_url_scheme_request_scheme_get(const Ewk_Url_Scheme_Request *request);
75 * Query the URL for this request.
77 * @param request request object to query.
79 * @return the URL pointer, that may be @c NULL. This pointer is
80 * guaranteed to be eina_stringshare, so whenever possible
81 * save yourself some cpu cycles and use
82 * eina_stringshare_ref() instead of eina_stringshare_add() or
85 EAPI const char *ewk_url_scheme_request_url_get(const Ewk_Url_Scheme_Request *request);
88 * Query the path part of the URL for this request.
90 * @param request request object to query.
92 * @return the path pointer, that may be @c NULL. This pointer is
93 * guaranteed to be eina_stringshare, so whenever possible
94 * save yourself some cpu cycles and use
95 * eina_stringshare_ref() instead of eina_stringshare_add() or
98 EAPI const char *ewk_url_scheme_request_path_get(const Ewk_Url_Scheme_Request *request);
101 * Finish a Ewk_Url_Scheme_Request by setting the content of the request and its mime type.
103 * @param request a Ewk_Url_Scheme_Request.
104 * @param content_data the data content of the request (may be %c NULL if the content is empty).
105 * @param content_length the length of the @a content_data.
106 * @param mime_type the content type of the stream or %c NULL if not known
108 EAPI Eina_Bool ewk_url_scheme_request_finish(Ewk_Url_Scheme_Request *request, const void *content_data, uint64_t content_length, const char *mime_type);
114 #endif // ewk_url_scheme_request_h