base_classes.h File Reference

Package of shared base classes, functions and definitions. More...

#include <string>
#include <map>

Go to the source code of this file.

Classes
class	dca::FunctionResult
	Standard function result. More...
class	dca::ExDca
	Exception class used in the DCA. More...
struct	dca::InitData
	This structure is used to initialize the DcaInstance. More...
struct	dca::ProxySettings
	If you are using one or more proxy servers set up this structure and use it for e.g. the creation of a DbConnection. More...
class	dca::DcaInstance
	Encapsulates the init and deinit of the DCA API. More...
class	dca::ScheduleEventSubscriberIntf
	An interface for schedule event notifications. Derive a class from this interface and implement onEvent() to receive notifications. More...
struct	dca::LicenseData
	Is used to create a License object. A license first must be created with DcaInstance::createLicense to initialize a classification module or a toolbox package. More...
class	dca::License
	Use a License to initialize a classification package or a toolbox package. More...
struct	dca::DbConnectionLocalData
	Stores the connection data for a local database. More...
struct	dca::DbConnectionCustomData
	Class to store the Database connection data for a custom database. More...
struct	dca::DbConnectionRemoteServerData
	Stores the remote server data for the connection to a remote database. More...
struct	dca::DbConnectionData
	Stores the connection data for a database. More...
struct	dca::DatabaseInformation
	Contains information about underlying database. More...
class	dca::DbConnection
	Database connection class for a local or remote database. More...
class	dca::UpdateModule
	The update module is used to download and install DCA content and engine updates. More...
class	dca::UpdateResults
	Encapsulates the results of an update process. More...
class	dca::UpdateResult
	Encapsulates one of the results of an update process. More...
class	dca::UpdateResultDetail
	Encapsulates the details of a result of an update process. More...

Enumerations
enum	dca::LogLevel {   dca::LOG_Initial = -1, dca::LOG_Critical = 0, dca::LOG_Error = 1, dca::LOG_Warning = 2,   dca::LOG_Notice = 3, dca::LOG_Info = 4, dca::LOG_Extensive = 5, dca::LOG_Debug = 6 }
	This enum is used in all setLogLevel() functions to change the verbosity level of the classes. More...
enum	dca::ScheduleActionType {   dca::SAT_StartDbDownload = 0, dca::SAT_ProgressDbDownload, dca::SAT_StopDbDownload, dca::SAT_ErrorDbDownload,   dca::SAT_StartDbMerge, dca::SAT_StopDbMerge, dca::SAT_ErrorDbMerge, dca::SAT_UserCancel }
	This defines the action type of a schedule event. More...
enum	dca::ScheduleModuleId {   dca::SMI_UrlDb = 0, dca::SMI_MailDb, dca::SMI_CustomDb, dca::SMI_WacDb,   dca::SMI_IprDb, dca::SMI_MalwareDb }
	This defines the module id of a schedule event. More...

Variables
const int	dca::ERR_NOT_INITIALIZED
	If you e.g. forget to initialize an instance before using a member function this error will be returned.
const int	dca::ERR_CREATION
	An error occured when attempting too create a class or instance in the DCA API.
const int	dca::ERR_PARAMS
	One or more parameter values is invalid, or a combination of parameter values is invalid.
const int	dca::ERR_CONNECTION
	This error may occur whenever a DCA function or class attempts to connect to a local or remote resource. Usually you should retry the operation several times before finally quitting, as the resource may only be temporarily unavailable.
const int	dca::ERR_CONNECTION_PROXY
	This error may occur whenever a DCA function or class attempts to connect to a remote resource via a proxy. Please check your proxy settings, and try again.
const int	dca::ERR_CONNECTION_TIMEOUT
	This error may occur whenever a DCA function or class attempts to connect to a remote resource. Usually you should retry the operation several times before finally quitting, as the resource may only be temporarily unavailable.
const int	dca::ERR_MEMORY_SHORTAGE
	This error is returned whenever it was not possible to allocate a required amount of memory. To solve this issue, try to de-allocate some other resouces if possible.
const int	dca::ERR_SIG_ABORT_DETECTED
	This code is returned when you use the dca::DcaInstance::signal() call and a task is terminated as a reaction on this.
const int	dca::ERR_NOT_LICENSED
	This code is returned if the specified license data is invalid, or the license has expired.
const int	dca::ERR_UNEXPECTED
	This error is returned if an unexpcted error occurs. This should never happen, but if it does occur, you should restart your application.
const int	dca::ERR_WRAPPER_UNEXPECTED
	The DCA consists of a wrapper layer that makes function calls on the dynamically loaded shared objects of the DCA modules. If an error occurs on this wrapper layer ERR_WRAPPER_UNEXPECTED will be returned.
const DbType	dca::DBT_Url
	Used for DbConnection classes for URL classification.
const DbType	dca::DBT_Mail
	Used for DbConnection classes for ZLA classification.
const DbType	dca::DBT_Custom
	Used for DbConnection classes of custom databases.
const int	dca::ERR_INVALID_DATABASE
	Error code: An attempt to connect to a local or custom database was not successful.
const int	dca::ERR_INVALID_FOLDER
	Error code: One (or more) of the specified folders were invalid (types or inaccessable)
const int	dca::ERR_INVALID_XML_FILES
	Error code: The specified XML files are missing or corrupt.
const int	dca::ERR_DB_UPDATE_ABORTED
	Error code: A (scheduled) database update was aborted unexpectly.
const int	dca::ERR_DB_DOWNLOAD_ABORTED
	Error code: A download of a database update was aborted unexpectly.
const int	dca::ERR_DATABASE_ALREADY_EXISTING
	Error code: The specified database already exists.
const int	dca::ERR_URL_INVALID
	Error code: The URL is invalid.
const int	dca::ERR_URL_UNSUPPORTED_PROTOCOL
	Error code: The protocol of the URL is unsupported.
const int	dca::ERR_CUSTOMDB_INVALID_CATEGORIES
	Error code: The given categories are invalid.
const int	dca::DCA_SUCCESS
	A return code to indicate a successful function call.
const unsigned int	dca::DCA_SIG_ABORT
	Currently the only supported signal parameter for the DcaInstance::signal() function.
const int	dca::DCA_UPDATE_DOWNLOAD_SCHEDULED
	Internal DCA status code to indicate that a potentially time consuming download has been scheduled. The download will be performed during the next schedule.

Detailed Description

Package of shared base classes, functions and definitions.

Definition in file base_classes.h.