Source/WebKit2/UIProcess/API/efl/ewk_url_request.h

/*
 * Copyright (C) 2012 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file    ewk_url_request.h
 * @brief   Describes the Ewk URL request API.
 */

#ifndef ewk_url_request_h
#define ewk_url_request_h

#include <Eina.h>

#ifdef __cplusplus
extern "C" {
#endif

/** Creates a type name for _Ewk_Url_Request */
typedef struct _Ewk_Url_Request Ewk_Url_Request;

/**
 * Increases the reference count of the given object.
 *
 * @param request the URL request object to increase the reference count
 *
 * @return a pointer to the object on success, @c NULL otherwise.
 */
EAPI Ewk_Url_Request *ewk_url_request_ref(Ewk_Url_Request *request);

/**
 * Decreases the reference count of the given object, possibly freeing it.
 *
 * When the reference count reaches 0, the URL request is freed.
 *
 * @param request the URL request object to decrease the reference count
 */
EAPI void ewk_url_request_unref(Ewk_Url_Request *request);

/**
 * Query URL for this request.
 *
 * @param request request object to query.
 *
 * @return the URL pointer, that may be @c NULL. This pointer is
 *         guaranteed to be eina_stringshare, so whenever possible
 *         save yourself some cpu cycles and use
 *         eina_stringshare_ref() instead of eina_stringshare_add() or
 *         strdup().
 */
EAPI const char *ewk_url_request_url_get(const Ewk_Url_Request *request);

/**
 * Query first party for cookies for this request.
 *
 * If set, this first party URL is used to distinguish first party cookies
 * from third party ones. This is usually set to the URL of the main document.
 *
 * @param request request object to query.
 *
 * @return the first party pointer, that may be @c NULL. This pointer is
 *         guaranteed to be eina_stringshare, so whenever possible
 *         save yourself some cpu cycles and use
 *         eina_stringshare_ref() instead of eina_stringshare_add() or
 *         strdup().
 */
EAPI const char *ewk_request_cookies_first_party_get(const Ewk_Url_Request *request);

/**
 * Query HTTP method for this request.
 *
 * HTTP methods are defined by:
 * http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
 *
 * Examples of HTTP methods are "GET", "POST".
 *
 * @param request request object to query.
 *
 * @return the HTTP method pointer, that may be @c NULL. This pointer is
 *         guaranteed to be eina_stringshare, so whenever possible
 *         save yourself some cpu cycles and use
 *         eina_stringshare_ref() instead of eina_stringshare_add() or
 *         strdup().
 */
EAPI const char *ewk_url_request_http_method_get(const Ewk_Url_Request *request);


#ifdef __cplusplus
}
#endif

#endif // ewk_url_request_h