eccodes.h

来自「wxWidgets写的电驴」· C头文件 代码 · 共 1,407 行 · 第 1/3 页

		 *
		 * \note When there are no categories, even the
		 * EC_TAG_PREFS_CATEGORIES tag is omitted from the response!
		 */
	EC_TAG_PREFS_CATEGORIES,

		/*!
		 * \brief A Category.
		 *
		 * Value: (\c uint32) Category index.
		 *
		 * \par Child TAGs:
		 *	::EC_TAG_CATEGORY_TITLE\n
		 *	::EC_TAG_CATEGORY_PATH\n
		 *	::EC_TAG_CATEGORY_COMMENT\n
		 *	::EC_TAG_CATEGORY_COLOR\n
		 *	::EC_TAG_CATEGORY_PRIO
		 */
	EC_TAG_CATEGORY,

	EC_TAG_CATEGORY_TITLE,		///< (\c string) Category title.
	EC_TAG_CATEGORY_PATH,		///< (\c string) Incoming files folder.
	EC_TAG_CATEGORY_COMMENT,	///< (\c string) Category comment.
	EC_TAG_CATEGORY_COLOR,		///< (\c uint32) Category color.
	EC_TAG_CATEGORY_PRIO,		///< (\c uint8) Category priority.


	//
	// Preferences - General
	//

		/*!
		* \brief Preferences - General.
		*
		* \par Child TAGs:
		*	::EC_TAG_USER_NICK\n
		*	::EC_TAG_USER_ID
		*/
	EC_TAG_PREFS_GENERAL,

	EC_TAG_USER_NICK,		///< (\c string) Nickname of the user.
	EC_TAG_USER_USERHASH,		///< (\c hash) Our userhash. Read only! (i.e. in a SET operation it will be ignored)


	//
	// Preferences - Connections
	//

		/*!
		* \brief Preferences - Connections.
		*
		* \par Child TAGs:
		*	::EC_TAG_CONN_DL_CAP\n
		*	::EC_TAG_CONN_UL_CAP\n
		*	::EC_TAG_CONN_MAX_DL\n
		*	::EC_TAG_CONN_MAX_UL\n
		*	::EC_TAG_CONN_SLOT_ALLOCATION\n
		*	::EC_TAG_CONN_TCP_PORT\n
		*	::EC_TAG_CONN_UDP_PORT\n
		*	::EC_TAG_CONN_UDP_DISABLE\n
		*	::EC_TAG_CONN_MAX_FILE_SOURCES\n
		*	::EC_TAG_CONN_MAX_CONN\n
		*	::EC_TAG_CONN_AUTOCONNECT\n
		*	::EC_TAG_CONN_RECONNECT\n
		*	::EC_TAG_NETWORK_ED2K\n
		*	::EC_TAG_NETWORK_KADEMLIA
		*/
	EC_TAG_PREFS_CONNECTIONS,

	EC_TAG_CONN_DL_CAP,		///< (\c uint32) Line download capacity.
	EC_TAG_CONN_UL_CAP,		///< (\c uint32) Line upload capacity.
	EC_TAG_CONN_MAX_DL,		///< (\c uint16) Maximum download speed.
	EC_TAG_CONN_MAX_UL,		///< (\c uint16) Maximum upload speed.
	EC_TAG_CONN_SLOT_ALLOCATION,	///< (\c uint16) Upload slot allocation.
	EC_TAG_CONN_TCP_PORT,		///< (\c uint16) TCP listening port number.
	EC_TAG_CONN_UDP_PORT,		///< (\c uint16) UDP listening port number.
	EC_TAG_CONN_UDP_DISABLE,	///< (boolean) Whether to disable UDP port or not.
	EC_TAG_CONN_MAX_FILE_SOURCES,	///< (\c uint16) Maximum sources per file allowed.
	EC_TAG_CONN_MAX_CONN,		///< (\c uint16) Maximum total connections allowed.
	EC_TAG_CONN_AUTOCONNECT,	///< (boolean) Whether to automatically connect at startup or not.
	EC_TAG_CONN_RECONNECT,		///< (boolean) Whether to reconnect to server upon connection loss or not.

	// Maybe these two could get a new category...
	EC_TAG_NETWORK_ED2K,		///< (boolean) Whether network ED2K is enabled or not.
	EC_TAG_NETWORK_KADEMLIA,	///< (boolean) Whether network Kademlia is enabled or not.


	//
	// Preferences - Message Filter
	//

		/*!
		* \brief Preferences - Message Filter.
		*
		* \par Child TAGs:
		*	::EC_TAG_MSGFILTER_ENABLED\n
		*	::EC_TAG_MSGFILTER_ALL\n
		*	::EC_TAG_MSGFILTER_FRIENDS\n
		*	::EC_TAG_MSGFILTER_SECURE\n
		*	::EC_TAG_MSGFILTER_BY_KEYWORD\n
		*	::EC_TAG_MSGFILTER_KEYWORDS
		*/
	EC_TAG_PREFS_MESSAGEFILTER,

	EC_TAG_MSGFILTER_ENABLED,	///< (boolean) Whether the Message Filter is enabled.
	EC_TAG_MSGFILTER_ALL,		///< (boolean) Whether to filter all messages.
	EC_TAG_MSGFILTER_FRIENDS,	///< (boolean) Whether to allow messages only from friends.
	EC_TAG_MSGFILTER_SECURE,	///< (boolean) Whether to filter messages from unknown clients.
	EC_TAG_MSGFILTER_BY_KEYWORD,	///< (boolean) Whether to filter messages by keywords.
	EC_TAG_MSGFILTER_KEYWORDS,	///< (\c string) Keyword list (comma separated).


	//
	// Preferences - Remote Controls
	//

		/*!
		* \brief WebServer Preferences (aka Remote Controls).
		*
		* \par Child TAGs:
		*	::EC_TAG_WEBSERVER_AUTORUN\n
		*	::EC_TAG_WEBSERVER_PORT (required)\n
		*	::EC_TAG_PASSWD_HASH (0-1) Admin Password. Omitted, when admin password is blank.\n
		*	::EC_TAG_WEBSERVER_GUEST (0-1)\n
		*	::EC_TAG_WEBSERVER_USEGZIP\n
		*	::EC_TAG_WEBSERVER_REFRESH\n
		*	::EC_TAG_WEBSERVER_TEMPLATE
		*/
	EC_TAG_PREFS_REMOTECTRL,

	EC_TAG_WEBSERVER_AUTORUN,	///< (boolean) Whether to run webserver on startup.
	EC_TAG_WEBSERVER_PORT,		///< (\c uint16) WebServer listening port
	EC_TAG_WEBSERVER_GUEST,		///< WebServer Guest account information
					/*!< (boolean) The presence of this tag means that the guest account is enabled.
						It contains an ::EC_TAG_PASSWD_HASH tag, if the guest
						password is not empty.
					*/
	EC_TAG_WEBSERVER_USEGZIP,	///< (boolean) When present, webserver uses gzip compression.
	EC_TAG_WEBSERVER_REFRESH,	///< (\c uint32) Refresh interval of web pages in seconds.
	EC_TAG_WEBSERVER_TEMPLATE,	///< (\c string) Web template name.


	//
	// Preferences - Online Signature
	//

		/*!
		* \brief Preferences - Online Signature.
		*
		* \par Child TAGs:
		*	::EC_TAG_ONLINESIG_ENABLED
		*/
	EC_TAG_PREFS_ONLINESIG,

	EC_TAG_ONLINESIG_ENABLED,	///< (boolean) Whether Online Signature is enabled.


	//
	// Preferences - Servers
	//

		/*!
		* \brief Preferences - Servers.
		*
		* \par Child TAGs:
		*	::EC_TAG_SERVERS_REMOVE_DEAD\n
		*	::EC_TAG_SERVERS_DEAD_SERVER_RETRIES\n
		*	::EC_TAG_SERVERS_AUTO_UPDATE\n
		*	::EC_TAG_SERVERS_URL_LIST\n
		*	::EC_TAG_SERVERS_ADD_FROM_SERVER\n
		*	::EC_TAG_SERVERS_ADD_FROM_CLIENT\n
		*	::EC_TAG_SERVERS_USE_SCORE_SYSTEM\n
		*	::EC_TAG_SERVERS_SMART_ID_CHECK\n
		*	::EC_TAG_SERVERS_SAFE_SERVER_CONNECT\n
		*	::EC_TAG_SERVERS_AUTOCONN_STATIC_ONLY\n
		*	::EC_TAG_SERVERS_MANUAL_HIGH_PRIO
		*/
	EC_TAG_PREFS_SERVERS,

	EC_TAG_SERVERS_REMOVE_DEAD,		///< (boolean) Remove dead servers.
	EC_TAG_SERVERS_DEAD_SERVER_RETRIES,	///< (\c uint16) Retries before removing dead servers.
	EC_TAG_SERVERS_AUTO_UPDATE,		///< (boolean) Auto-update server list on startup.
	EC_TAG_SERVERS_URL_LIST,		///< TODO: Implement this!
	EC_TAG_SERVERS_ADD_FROM_SERVER,		///< (boolean) Update server list on connecting to server.
	EC_TAG_SERVERS_ADD_FROM_CLIENT,		///< (boolean) Update server list on connecting to a client.
	EC_TAG_SERVERS_USE_SCORE_SYSTEM,	///< (boolean) Use priority system.
	EC_TAG_SERVERS_SMART_ID_CHECK,		///< (boolean) Smart LowID check.
	EC_TAG_SERVERS_SAFE_SERVER_CONNECT,	///< (boolean) Safe server connection.
	EC_TAG_SERVERS_AUTOCONN_STATIC_ONLY,	///< (boolean) Auto-connect to static servers only.
	EC_TAG_SERVERS_MANUAL_HIGH_PRIO,	///< (boolean) Set manually added servers to High Priority.


	//
	// Preferences - Files
	//

		/*!
		* \brief Preferences - Files.
		*
		* \par Child TAGs:
		*	::EC_TAG_FILES_ICH_ENABLED\n
		*	::EC_TAG_FILES_AICH_TRUST\n
		*	::EC_TAG_FILES_NEW_PAUSED\n
		*	::EC_TAG_FILES_NEW_AUTO_DL_PRIO\n
		*	::EC_TAG_FILES_PREVIEW_PRIO\n
		*	::EC_TAG_FILES_NEW_AUTO_UL_PRIO\n
		*	::EC_TAG_FILES_UL_FULL_CHUNKS\n
		*	::EC_TAG_FILES_START_NEXT_PAUSED\n
		*	::EC_TAG_FILES_RESUME_SAME_CAT\n
		*	::EC_TAG_FILES_SAVE_SOURCES\n
		*	::EC_TAG_FILES_EXTRACT_METADATA\n
		*	::EC_TAG_FILES_ALLOC_FULL_CHUNKS\n
		*	::EC_TAG_FILES_ALLOC_FULL_SIZE\n
		*	::EC_TAG_FILES_CHECK_FREE_SPACE\n
		*	::EC_TAG_FILES_MIN_FREE_SPACE
		*/
	EC_TAG_PREFS_FILES,

	EC_TAG_FILES_ICH_ENABLED,	///< (boolean) Is ICH enabled?
	EC_TAG_FILES_AICH_TRUST,	///< (boolean) Does AICH trust every hash?
	EC_TAG_FILES_NEW_PAUSED,	///< (boolean) Add new files paused.
	EC_TAG_FILES_NEW_AUTO_DL_PRIO,	///< (boolean) Auto-priority on new downloads.
	EC_TAG_FILES_PREVIEW_PRIO,	///< (boolean) Try to download first and last chunk first.
	EC_TAG_FILES_NEW_AUTO_UL_PRIO,	///< (boolean) Add new shared files with auto-priority.
	EC_TAG_FILES_UL_FULL_CHUNKS,	///< (boolean) Transfer full chunks in uploads.
	EC_TAG_FILES_START_NEXT_PAUSED,	///< (boolean) Start next paused file when a download completes.
	EC_TAG_FILES_RESUME_SAME_CAT,	///< (boolean) Start next paused file from the same category.
	EC_TAG_FILES_SAVE_SOURCES,	///< (boolean) Save 5 sources on rare files.
	EC_TAG_FILES_EXTRACT_METADATA,	///< (boolean) Extract metadata tags.
	EC_TAG_FILES_ALLOC_FULL_CHUNKS,	///< (boolean) Allocate full chunks.
	EC_TAG_FILES_ALLOC_FULL_SIZE,	///< (boolean) Aloocate full filesize.
	EC_TAG_FILES_CHECK_FREE_SPACE,	///< (boolean) Check disk free space.
	EC_TAG_FILES_MIN_FREE_SPACE,	///< (\c uint32) Minimum disk free space.


	//
	// Preferences - Source Dropping
	//

		/*!
		* \brief Preferences - Source Dropping.
		*
		* \par Child TAGs:
		*	::EC_TAG_SRCDROP_NONEEDED\n
		*	::EC_TAG_SRCDROP_DROP_FQS\n
		*	::EC_TAG_SRCDROP_DROP_HQRS\n
		*	::EC_TAG_SRCDROP_HQRS_VALUE\n
		*	::EC_TAG_SRCDROP_AUTODROP_TIMER
		*/
	EC_TAG_PREFS_SRCDROP,

	EC_TAG_SRCDROP_NONEEDED,	///< (\c uint8) How to handle no-needed-sources: 0: keep, 1: drop, 2: swap
	EC_TAG_SRCDROP_DROP_FQS,	///< (boolean) Whether to auto-drop Full Queue Sources
	EC_TAG_SRCDROP_DROP_HQRS,	///< (boolean) Whether to auto-drop High Queue Rating Sources
	EC_TAG_SRCDROP_HQRS_VALUE,	///< (\c uint16) When to count as *High* queue rating
	EC_TAG_SRCDROP_AUTODROP_TIMER,	///< (\c uint16) Timer for auto-dropping sources (in seconds)


	//
	// Preferences - Directories
	//

		/*!
		* \brief Preferences - Directories.
		*
		* \par Child TAGs:
		*/
	EC_TAG_PREFS_DIRECTORIES,
/* <---> */


	//
	// Preferences - Statistics
	//

		/*!
		* \brief Preferences - Statistics.
		*
		* \par Child TAGs:
		*/
	EC_TAG_PREFS_STATISTICS,
/* <---> */


	//
	// Preferences - Security
	//

		/*!
		* \brief Preferences - Security.
		*
		* \par Child TAGs:
		*	::EC_TAG_PREFS_SECURITY\n
		*	::EC_TAG_SECURITY_CAN_SEE_SHARES\n
		*	::EC_TAG_SECURITY_FILE_PERMISSIONS\n
		*	::EC_TAG_SECURITY_DIR_PERMISSIONS\n
		*	::EC_TAG_IPFILTER_ENABLED\n
		*	::EC_TAG_IPFILTER_AUTO_UPDATE\n
		*	::EC_TAG_IPFILTER_UPDATE_URL\n
		*	::EC_TAG_IPFILTER_LEVEL\n
		*	::EC_TAG_IPFILTER_FILTER_LAN\n
		*	::EC_TAG_SECURITY_USE_SECIDENT
		*/
	EC_TAG_PREFS_SECURITY,

	EC_TAG_SECURITY_CAN_SEE_SHARES,		///< (\c uint8) Who can see shared files?
						/*!< <ul>
							<li>0 - Everybody</li>
							<li>1 - Friends only</li>
							<li>2 - Nobody</li>
							</ul>
						*/
	EC_TAG_SECURITY_FILE_PERMISSIONS,	///< (\c uint32) Permissions on newly created files.
	EC_TAG_SECURITY_DIR_PERMISSIONS,	///< (\c uint32) Permissions on newly created directories.
	EC_TAG_IPFILTER_ENABLED,		///< (boolean) IPFilter enabled.
	EC_TAG_IPFILTER_AUTO_UPDATE,		///< (boolean) Auto-update IPFilter from URL at startup.
	EC_TAG_IPFILTER_UPDATE_URL,		///< (\c string) IPFilter auto-update URL.
	EC_TAG_IPFILTER_LEVEL,			///< (\c uint8) IPFilter filtering level.
	EC_TAG_IPFILTER_FILTER_LAN,		///< (boolean) Always filter LAN IPs.
	EC_TAG_SECURITY_USE_SECIDENT,		///< (boolean) Use Secure Identification.


	//
	// Preferences - Core Tweaks
	//

		/*!
		* \brief Preferences - Core Tweaks.
		*
		* \par Child TAGs:
		*	::EC_TAG_CORETW_MAX_CONN_PER_FIVE\n
		*	::EC_TAG_CORETW_VERBOSE\n
		*	::EC_TAG_CORETW_FILEBUFFER\n
		*	::EC_TAG_CORETW_UL_QUEUE\n
		*	::EC_TAG_CORETW_SRV_KEEPALIVE_TIMEOUT
		*/
	EC_TAG_PREFS_CORETWEAKS,

	EC_TAG_CORETW_MAX_CONN_PER_FIVE,	///< (\c uint16) Max connections per 5 seconds.
	EC_TAG_CORETW_VERBOSE,			///< (boolean) Verbose debug messages.
	EC_TAG_CORETW_FILEBUFFER,		///< (\c uint32) File buffer size.
	EC_TAG_CORETW_UL_QUEUE,			///< (\c uint32) Upload queue size.
	EC_TAG_CORETW_SRV_KEEPALIVE_TIMEOUT,	///< (\c uint32) Server connection keepalive timeout.


	//
	// Logging
	//

		/*!
		 * \brief Whether to add logline to statusline or not.
		 *
		 * The presence of this tag means (true), to add logline also
		 * to statusline.
		 */
	EC_TAG_LOG_TO_STATUS,

	//
	// Statistics
	//

	EC_TAG_STATSGRAPH_WIDTH,	///< (\c uint16) Maximum number of sample points (for webserver only)
	EC_TAG_STATSGRAPH_SCALE,	///< (\c uint16) Time between sample point (in seconds) (for webserver only)
	EC_TAG_STATSGRAPH_LAST,		///< (\c double) Timestamp of last acquired/sent history item. Default: 0.0
	EC_TAG_STATSGRAPH_DATA,		///< sequence of uint32 triplets for the webserver (dl,ul,conn); ...

		/*!
		 * \brief Describes how stattree capping should be done.
		 *
		 * Holds an \c uint8 value, and defaults to 0 (unlimited).
		 *
		 * Its value is passed to CStatTreItemBase::CreateECTag(), so tree items
		 * which support capping know how many children should they provide at most.
		 * (It is currently used only on client versions.)
		 */
	EC_TAG_STATTREE_CAPPING,

		/*!
		 * \brief A node (tree item/subtree root) for statistics.
		 *
		 * Value: (\c string) Stats label.
		 *
		 * \par Possible children:
		 *	::EC_TAG_STAT_NODE_VALUE\n
		 *	::EC_TAG_STATTREE_NODE
		 */
	EC_TAG_STATTREE_NODE,
	EC_TAG_STAT_NODE_VALUE,		///< A value for this node.
					/*!< May conatin an ::EC_TAG_STAT_VALUE_TYPE tag, describing its contents, otherwise it is interpreted as an \c uint64 integer.
					 *
					 *   May also contain a ::EC_TAG_STAT_NODE_VALUE child, and that will be displayed in brackets after this value.
					 *   This only works for value types that require a \c %s format string.
					 */
	EC_TAG_STAT_VALUE_TYPE		///< \c uint8 value describing the value of its parent (::EC_TAG_STAT_NODE_VALUE). See also the ::EC_STATTREE_NODE_VALUE_TYPE enum.
};


/*!
 * EC detail level values
 *
 * All higher levels contain all the lower level information aswell.
 */
enum EC_DETAIL_LEVEL {
	EC_DETAIL_CMD,		///< aMuleCmd uses this level to obtain only basic information
	EC_DETAIL_WEB,		///< aMuleWeb uses this level to obtain specific information/specific format
	
	/*
	 * Send either full info or fields that usually changes (speed, source count, etc).
	 * This algorithm doesn't use match memory, but consumes more bandwidth.
	 */
	EC_DETAIL_FULL,
	EC_DETAIL_UPDATE,
	
	/*
	 * Send only tags that has been changed since last request. This algorithm
	 * uses twice memory as previous, but saves bandwidth. Good for remote gui
	 */
	EC_DETAIL_INC_UPDATE
};


/*!
 * Search type
 */
 
enum EC_SEARCH_TYPE {
	EC_SEARCH_LOCAL,
	EC_SEARCH_GLOBAL,
	EC_SEARCH_KAD,
	EC_SEARCH_WEB
};

/**
 * EC value types for stattree nodes.
 */
enum EC_STATTREE_NODE_VALUE_TYPE {
	EC_VALUE_INTEGER,	///< value is an \c uint64 integer. The ::EC_TAG_STAT_VALUE_TYPE node may be omitted in this case. Format code is \c %u or similar.
	EC_VALUE_ISTRING,	///< value is an \c uint64 integer. The only difference from ::EC_VALUE_INTEGER is that this reqires a \c %s format code.
	EC_VALUE_BYTES,		///< value is an \c uint64 representing bytes, format is \c %s.
	EC_VALUE_ISHORT,	///< value is an \c uint64 integer, format is \c %s. Value will be displayed in a human-readable short form.
	EC_VALUE_TIME,		///< value is an \c uint32 representing time in seconds, format is \c %s.
	EC_VALUE_SPEED,		///< value is an \c uint32 representing speed in bytes/second, format is \c %s.
	EC_VALUE_STRING,	///< \c string type value, with \c %s format
	EC_VALUE_DOUBLE		///< floating-point (\c double) type value. Format code is \c %g or similar.
};


/*
 * EC Preferences selection bit values.
 */

#define EC_PREFS_CATEGORIES	0x00000001
#define EC_PREFS_GENERAL	0x00000002
#define EC_PREFS_CONNECTIONS	0x00000004
#define EC_PREFS_MESSAGEFILTER	0x00000008
#define EC_PREFS_REMOTECONTROLS	0x00000010
#define EC_PREFS_ONLINESIG	0x00000020
#define EC_PREFS_SERVERS	0x00000040
#define EC_PREFS_FILES		0x00000080
#define EC_PREFS_SRCDROP	0x00000100
#define EC_PREFS_DIRECTORIES	0x00000200
#define EC_PREFS_STATISTICS	0x00000400
#define EC_PREFS_SECURITY	0x00000800
// there's no need to do GUI Tweaks on EC :)
#define EC_PREFS_CORETWEAKS	0x00001000
// Is there any need to change Debug prefs via EC?

#endif	/* ECCODES_H */