← Back to branch summary

~ubuntu-branches/ubuntu/raring/qtwebkit-source/raring-proposed

« back to all changes in this revision

Viewing changes to Source/WebKit2/UIProcess/API/efl/ewk_url_response.h

  • Committer: Package Import Robot
  • Author(s): Jonathan Riddell
  • Date: 2013-02-18 14:24:18 UTC
  • Revision ID: package-import@ubuntu.com-20130218142418-eon0jmjg3nj438uy
Tags: upstream-2.3
Import upstream version 2.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
Source/WebKit2/UIProcess/API/efl/ewk_url_response.h
 
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_response.h
 
28
 * @brief   Describes the Ewk URL response API.
 
29
 */
 
30
 
 
31
#ifndef ewk_url_response_h
 
32
#define ewk_url_response_h
 
33
 
 
34
#include <Eina.h>
 
35
 
 
36
#ifdef __cplusplus
 
37
extern "C" {
 
38
#endif
 
39
 
 
40
/**
 
41
 * Declare Ewk_Url_Response as Ewk_Object.
 
42
 *
 
43
 * @see Ewk_Object
 
44
 */
 
45
typedef struct EwkObject Ewk_Url_Response;
 
46
 
 
47
/**
 
48
 * Query URL for this response.
 
49
 *
 
50
 * @param response response object to query.
 
51
 *
 
52
 * @return the URL 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
 */
 
58
EAPI const char *ewk_url_response_url_get(const Ewk_Url_Response *response);
 
59
 
 
60
/**
 
61
 * Query HTTP status code for this response.
 
62
 *
 
63
 * HTTP status code are defined by:
 
64
 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
 
65
 *
 
66
 * @param response response object to query.
 
67
 *
 
68
 * @return the HTTP status code.
 
69
 */
 
70
EAPI int ewk_url_response_status_code_get(const Ewk_Url_Response *response);
 
71
 
 
72
/**
 
73
 * Query MIME type for this response.
 
74
 *
 
75
 * @param response response object to query.
 
76
 *
 
77
 * @return the MIME type pointer, that may be @c NULL. This pointer is
 
78
 *         guaranteed to be eina_stringshare, so whenever possible
 
79
 *         save yourself some cpu cycles and use
 
80
 *         eina_stringshare_ref() instead of eina_stringshare_add() or
 
81
 *         strdup().
 
82
 */
 
83
EAPI const char *ewk_url_response_mime_type_get(const Ewk_Url_Response *response);
 
84
 
 
85
/**
 
86
 * Get the expected content length of the #Ewk_Url_Response.
 
87
 *
 
88
 * It can be 0 if the server provided an incorrect or missing Content-Length.
 
89
 *
 
90
 * @param response a #Ewk_Url_Response.
 
91
 *
 
92
 * @return the expected content length of @a response or 0 in case of failure.
 
93
 */
 
94
EAPI unsigned long ewk_url_response_content_length_get(const Ewk_Url_Response *response);
 
95
 
 
96
#ifdef __cplusplus
 
97
}
 
98
#endif
 
99
 
 
100
#endif // ewk_url_response_h