Source/WebKit2/UIProcess/API/efl/ewk_url_request.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_request.h
  28  * @brief   Describes the Ewk URL request API.
  29  */
  30
  31 #ifndef ewk_url_request_h
  32 #define ewk_url_request_h
  33
  34 #include <Eina.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /** Creates a type name for Ewk_Url_Request */
  41 typedef struct Ewk_Url_Request Ewk_Url_Request;
  42
  43 /**
  44  * Increases the reference count of the given object.
  45  *
  46  * @param request the URL request object to increase the reference count
  47  *
  48  * @return a pointer to the object on success, @c NULL otherwise.
  49  */
  50 EAPI Ewk_Url_Request *ewk_url_request_ref(Ewk_Url_Request *request);
  51
  52 /**
  53  * Decreases the reference count of the given object, possibly freeing it.
  54  *
  55  * When the reference count reaches 0, the URL request is freed.
  56  *
  57  * @param request the URL request object to decrease the reference count
  58  */
  59 EAPI void ewk_url_request_unref(Ewk_Url_Request *request);
  60
  61 /**
  62  * Query URL for this request.
  63  *
  64  * @param request request object to query.
  65  *
  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
  70  *         strdup().
  71  */
  72 EAPI const char *ewk_url_request_url_get(const Ewk_Url_Request *request);
  73
  74 /**
  75  * Query first party for cookies for this request.
  76  *
  77  * If set, this first party URL is used to distinguish first party cookies
  78  * from third party ones. This is usually set to the URL of the main document.
  79  *
  80  * @param request request object to query.
  81  *
  82  * @return the first party pointer, that may be @c NULL. This pointer is
  83  *         guaranteed to be eina_stringshare, so whenever possible
  84  *         save yourself some cpu cycles and use
  85  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  86  *         strdup().
  87  */
  88 EAPI const char *ewk_request_cookies_first_party_get(const Ewk_Url_Request *request);
  89
  90 /**
  91  * Query HTTP method for this request.
  92  *
  93  * HTTP methods are defined by:
  94  * http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
  95  *
  96  * Examples of HTTP methods are "GET", "POST".
  97  *
  98  * @param request request object to query.
  99  *
 100  * @return the HTTP method pointer, that may be @c NULL. This pointer is
 101  *         guaranteed to be eina_stringshare, so whenever possible
 102  *         save yourself some cpu cycles and use
 103  *         eina_stringshare_ref() instead of eina_stringshare_add() or
 104  *         strdup().
 105  */
 106 EAPI const char *ewk_url_request_http_method_get(const Ewk_Url_Request *request);
 107
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112
 113 #endif // ewk_url_request_h