It provides APIs managing underlying anti malware engines.

Required Header

#include <csr-engine-manager.h>

Overview

It provides APIs getting engine information and enabling or disabling underlying anti malware engines.

Functions
int	csr_get_current_engine (csr_engine_id_e id, csr_engine_h *engine)
	Gets the handle of a current engine information.
int	csr_engine_get_vendor (csr_engine_h engine, char **vendor)
	Extracts a vendor name from the engine information handle.
int	csr_engine_get_name (csr_engine_h engine, char **name)
	Extracts an engine name from the engine information handle.
int	csr_engine_get_version (csr_engine_h engine, char **version)
	Extracts an engine version from the engine information handle.
int	csr_engine_get_data_version (csr_engine_h engine, char **version)
	Extracts an engine's data version from the engine information handle.
int	csr_engine_get_latest_update_time (csr_engine_h engine, time_t *time)
	Extracts the latest update time of an engine from the engine information handle.
int	csr_engine_get_activated (csr_engine_h engine, csr_activated_e *activated)
	Extracts the state of engine activation from the engine information handle.
int	csr_engine_set_state (csr_engine_h engine, csr_state_e state)
	Enable or disable an engine.
int	csr_engine_get_state (csr_engine_h engine, csr_state_e *state)
	Gets the engine state.
int	csr_engine_destroy (csr_engine_h engine)
	Releases all system resources associated with a engine information handle.
Typedefs
typedef struct __csr_engine_h *	csr_engine_h
	Engine handle.

Typedef Documentation

typedef struct __csr_engine_h* csr_engine_h

Engine handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Enumeration Type Documentation

enum csr_activated_e

Enumeration for state of engine activation.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Enumerator:

CSR_NOT_ACTIVATED	Engine is not activated
CSR_ACTIVATED	Engine is activated

enum csr_engine_id_e

Enumeration for engine identifier.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Enumerator:

CSR_ENGINE_CS	Content screening engine id
CSR_ENGINE_WP	Web protection engine id

enum csr_state_e

Enumeration for state of engine.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Enumerator:

CSR_STATE_ENABLE	Enable engine
CSR_STATE_DISABLE	Disable engine

Function Documentation

int csr_engine_destroy ( csr_engine_h engine )

Releases all system resources associated with a engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Parameters:

[in] engine The engine information handle

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle

int csr_engine_get_activated	(	csr_engine_h	engine,
		csr_activated_e *	activated
	)

Extracts the state of engine activation from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Parameters:

[in]	engine	The engine information handle
[out]	activated	A pointer of the engine activation state

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	activated is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_data_version	(	csr_engine_h	engine,
		char **	version
	)

Extracts an engine's data version from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Remarks:: version must be released using free().

Parameters:

[in]	engine	The engine information handle
[out]	version	A pointer of the data version. It can be null

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	version is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_latest_update_time	(	csr_engine_h	engine,
		time_t *	time
	)

Extracts the latest update time of an engine from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Parameters:

[in]	engine	The engine information handle
[out]	time	A pointer of lasted update time

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	time is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_name	(	csr_engine_h	engine,
		char **	name
	)

Extracts an engine name from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Remarks:: name must be released using free().

Parameters:

[in]	engine	The engine information handle
[out]	name	A pointer of the engine's name

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	name is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_state	(	csr_engine_h	engine,
		csr_state_e *	state
	)

Gets the engine state.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Parameters:

[in]	engine	The engine information handle
[out]	state	A pointer of the engine state

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	state is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_vendor	(	csr_engine_h	engine,
		char **	vendor
	)

Extracts a vendor name from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Remarks:: vendor must be released using free().

Parameters:

[in]	engine	The engine information handle
[out]	vendor	A pointer of the engine's vendor name

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	vendor is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_get_version	(	csr_engine_h	engine,
		char **	version
	)

Extracts an engine version from the engine information handle.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Remarks:: version must be released using free().

Parameters:

[in]	engine	An engine information handle
[out]	version	A pointer of the engine's version

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	version is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_engine_set_state	(	csr_engine_h	engine,
		csr_state_e	state
	)

Enable or disable an engine.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/antivirus.admin

Remarks:: If an engine is disabled, all major operations would be failed with CSR_ERROR_ENGINE_DISABLED error code.

Parameters:

[in]	engine	The engine information handle
[in]	state	The engine state

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_HANDLE	Invalid engine information handle
CSR_ERROR_INVALID_PARAMETER	state is invalid
CSR_ERROR_PERMISSION_DENIED	Permission denied
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_get_current_engine()

int csr_get_current_engine	(	csr_engine_id_e	id,
		csr_engine_h *	engine
	)

Gets the handle of a current engine information.

Warning:: This is not for use by third-party applications.

Since :: 3.0

Remarks:: engine should be released using csr_engine_destroy().

Parameters:

[in]	id	Engine identifier to get handle
[out]	engine	A pointer of the engine information handle

Returns:: CSR_ERROR_NONE on success, otherwise a negative error value

Return values:

CSR_ERROR_NONE	Successful
CSR_ERROR_INVALID_PARAMETER	engine is invalid
CSR_ERROR_ENGINE_NOT_EXIST	No engine exists
CSR_ERROR_ENGINE_NOT_ACTIVATED	Engine is not activated
CSR_ERROR_ENGINE_INTERNAL	Engine Internal error
CSR_ERROR_SYSTEM	System error

See also:: csr_engine_destroy()

Required Header

Overview

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation