ewk_download_job.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef ewk_download_job_h
#define ewk_download_job_h

#include "ewk_url_request.h"
#include "ewk_url_response.h"
#include <Eina.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
typedef class EwkObject Ewk_Download_Job;
#else
typedef struct EwkObject Ewk_Download_Job;
#endif

enum Ewk_Download_Job_State {
    EWK_DOWNLOAD_JOB_STATE_UNKNOWN = -1,
    EWK_DOWNLOAD_JOB_STATE_NOT_STARTED,
    EWK_DOWNLOAD_JOB_STATE_DOWNLOADING,
    EWK_DOWNLOAD_JOB_STATE_FAILED,
    EWK_DOWNLOAD_JOB_STATE_CANCELLING,
    EWK_DOWNLOAD_JOB_STATE_CANCELLED,
    EWK_DOWNLOAD_JOB_STATE_FINISHED
};
typedef enum Ewk_Download_Job_State Ewk_Download_Job_State;

EAPI Ewk_Download_Job_State ewk_download_job_state_get(const Ewk_Download_Job *download);

EAPI Ewk_Url_Request *ewk_download_job_request_get(const Ewk_Download_Job *download);

EAPI Ewk_Url_Response *ewk_download_job_response_get(const Ewk_Download_Job *download);

EAPI const char *ewk_download_job_destination_get(const Ewk_Download_Job *download);

EAPI Eina_Bool ewk_download_job_destination_set(Ewk_Download_Job *download, const char *destination);

EAPI const char *ewk_download_job_suggested_filename_get(const Ewk_Download_Job *download);

EAPI Eina_Bool ewk_download_job_cancel(Ewk_Download_Job *download);

EAPI double ewk_download_job_estimated_progress_get(const Ewk_Download_Job *download);

EAPI double ewk_download_job_elapsed_time_get(const Ewk_Download_Job *download);

EAPI uint64_t ewk_download_job_received_data_size_get(const Ewk_Download_Job *download);

#ifdef __cplusplus
}
#endif

#endif // ewk_download_job_h