ewk_error.h File Reference

Describes the Web Error API. More...

#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkError	Ewk_Error

Enumerations
enum	Ewk_Error_Type {   EWK_ERROR_TYPE_NONE, EWK_ERROR_TYPE_INTERNAL, EWK_ERROR_TYPE_NETWORK, EWK_ERROR_TYPE_POLICY,   EWK_ERROR_TYPE_PLUGIN, EWK_ERROR_TYPE_DOWNLOAD, EWK_ERROR_TYPE_PRINT }
	Creates a type name for Ewk_Error_Type.

Functions
EAPI Ewk_Error_Type	ewk_error_type_get (const Ewk_Error *error)
EAPI const char *	ewk_error_url_get (const Ewk_Error *error)
EAPI int	ewk_error_code_get (const Ewk_Error *error)
EAPI const char *	ewk_error_description_get (const Ewk_Error *error)
EAPI Eina_Bool	ewk_error_cancellation_get (const Ewk_Error *error)

Detailed Description

Describes the Web Error API.

Typedef Documentation

typedef struct EwkError Ewk_Error

Creates a type name for Ewk_Error.

Function Documentation

EAPI Eina_Bool ewk_error_cancellation_get

(

const Ewk_Error *

error

)

Query if error should be treated as a cancellation.

Parameters

error

error object to query.

Returns

EINA_TRUE if this error should be treated as a cancellation, EINA_FALSE otherwise

EAPI int ewk_error_code_get

(

const Ewk_Error *

error

)

Query HTTP error code.

Parameters

error

error object to query.

Returns

the HTTP error code.

EAPI const char* ewk_error_description_get

(

const Ewk_Error *

error

)

Query description for this error.

Parameters

error

error object to query.

Returns

the description pointer, that may be 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 Ewk_Error_Type ewk_error_type_get

(

const Ewk_Error *

error

)

Query type for this error.

Parameters

error

error object to query.

Returns

the error type, that may be 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_error_url_get

(

const Ewk_Error *

error

)

Query failing URL for this error.

URL that failed loading.

Parameters

error

error object to query.

Returns

the URL pointer, that may be 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().