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_response.h
28 * @brief Describes the Ewk URL response API.
31 #ifndef ewk_url_response_h
32 #define ewk_url_response_h
40 /** Creates a type name for Ewk_Url_Response */
41 typedef struct Ewk_Url_Response Ewk_Url_Response;
44 * Increases the reference count of the given object.
46 * @param response the URL response object to increase the reference count
48 * @return a pointer to the object on success, @c NULL otherwise.
50 EAPI Ewk_Url_Response *ewk_url_response_ref(Ewk_Url_Response *response);
53 * Decreases the reference count of the given object, possibly freeing it.
55 * When the reference count reaches 0, the URL response is freed.
57 * @param response the URL response object to decrease the reference count
59 EAPI void ewk_url_response_unref(Ewk_Url_Response *response);
62 * Query URL for this response.
64 * @param response response object to query.
66 * @return the URL 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_response_url_get(const Ewk_Url_Response *response);
75 * Query HTTP status code for this response.
77 * HTTP status code are defined by:
78 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
80 * @param response response object to query.
82 * @return the HTTP status code.
84 EAPI int ewk_url_response_status_code_get(const Ewk_Url_Response *response);
87 * Query MIME type for this response.
89 * @param response response object to query.
91 * @return the MIME type pointer, that may be @c NULL. This pointer is
92 * guaranteed to be eina_stringshare, so whenever possible
93 * save yourself some cpu cycles and use
94 * eina_stringshare_ref() instead of eina_stringshare_add() or
97 EAPI const char *ewk_url_response_mime_type_get(const Ewk_Url_Response *response);
100 * Get the expected content length of the #Ewk_Url_Response.
102 * It can be 0 if the server provided an incorrect or missing Content-Length.
104 * @param response a #Ewk_Url_Response.
106 * @return the expected content length of @a response or 0 in case of failure.
108 EAPI unsigned long ewk_url_response_content_length_get(const Ewk_Url_Response *response);
114 #endif // ewk_url_response_h