eccodes.h

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

	EC_OP_RESET_LOG,	///< Clears the log.
	EC_OP_RESET_DEBUGLOG,	///< Clears the debug log.
	EC_OP_CLEAR_SERVERINFO,	///< Clears server info log.

		/*!
		 * \brief Returns the last log line.
		 *
		 * Response is an ::EC_OP_LOG packet, conatining only
		 * the last log line.
		 */
	EC_OP_GET_LAST_LOG_ENTRY,


	//
	// Preferences
	//

		/*!
		 * \brief Request for Preferences.
		 *
		 * This request must hold an ::EC_TAG_SELECT_PREFS tag,
		 * to select which kinds of preferences are required.
		 *
		 * \note Tags marked as (boolean) contain no data, their
		 * presence means \c true, their absence means \c false.
		 */
	EC_OP_GET_PREFERENCES,

		/*!
		 * \brief Setting the preferences or reply to EC_OP_GET_PREFERENCES
		 *
		 * Setting preferences values to the provided ones.
		 * If a tag is omitted, the respective preference value
		 * will be left unchanged.
		 *
		 * \par Possible tags:
		 *	::EC_TAG_PREFS_CATEGORIES\n
		 *	::EC_TAG_PREFS_GENERAL\n
		 *	::EC_TAG_PREFS_CONNECTIONS\n
		 *	::EC_TAG_PREFS_MESSAGEFILTER\n
		 *	::EC_TAG_PREFS_REMOTECTRL\n
		 *	::EC_TAG_PREFS_ONLINESIG\n
		 *	::EC_TAG_PREFS_SERVERS\n
		 *	::EC_TAG_PREFS_FILES\n
		 *	::EC_TAG_PREFS_SRCDROP\n
		 *	::EC_TAG_PREFS_DIRECTORIES\n
		 *	::EC_TAG_PREFS_STATISTICS\n
		 *	::EC_TAG_PREFS_SECURITY\n
		 *	::EC_TAG_PREFS_CORETWEAKS
		 *
		 * \note Tags marked as (boolean) are set the following way:
		 * not present, they're left unchanged. If they are present,
		 * they should countain an \c uint8 value, which means \c true
		 * non-zero.
		 */
	EC_OP_SET_PREFERENCES,

		/*!
		 * \brief Command to create new category
		 *
		 *
		 * \par Child tags:
		 *	::EC_TAG_CATEGORY\n
		 */
	EC_OP_CREATE_CATEGORY,
	EC_OP_UPDATE_CATEGORY,
	EC_OP_DELETE_CATEGORY,

		/*!
		 * \brief Retrieves the statistics graphs
		 *
		 * Server replies with an ::EC_OP_STATSGRAPHS packet.
		 *
		 * \par Child Tags:
		 *	::EC_TAG_STATSGRAPH_WIDTH (required for webserver only)\n
		 *	::EC_TAG_STATSGRAPH_SCALE (required for webserver only)\n
		 *	::EC_TAG_STATSGRAPH_LAST
		 */
	EC_OP_GET_STATSGRAPHS,

		/*!
		 * \brief Statistics graphs reply
		 *
		 * \par Child Tags:
		 *	::EC_TAG_STATSGRAPH_LAST
		 *	::EC_TAG_STATSGRAPH_DATA
		 */	
	EC_OP_STATSGRAPHS,

		/*!
		 * \brief Retrieves the statistics tree
		 *
		 * Server replies with an ::EC_OP_STATSTREE packet.
		 *
		 * Might contain an ::EC_TAG_STATTREE_CAPPING tag, to set how tree capping should be done.
		 */
	EC_OP_GET_STATSTREE,

		/*!
		 * \brief Statistics tree reply
		 *
		 * \par Child Tags:
		 *	::EC_TAG_STATTREE_NODE\n
		 *	::EC_TAG_USER_NICK and ::EC_TAG_SERVER_VERSION only if
		 *	detail level is ::EC_DETAIL_WEB (ie. for webserver only)
		 */
	EC_OP_STATSTREE,

		/*!
		 * \brief Connects to Kad
		 */
	EC_OP_KAD_START,
	
		/*!
		 * \brief Stops Kad
		 */
	EC_OP_KAD_STOP,

		/*!
		 * \brief Connect to the network.
		 *
		 * Connects to those networks that are enabled in preferences (ed2k, kad).
		 */
	EC_OP_CONNECT,

		/*!
		 * \brief Disconnect from networks.
		 *
		 * Disconnects from all connected networks.
		 */
	EC_OP_DISCONNECT
	
};


/******************************************************************************/

/**
 * <b>EC TAG names</b>
 *
 * TAGs hold the data, on/with the requested operation is to be performed.
 */

enum {
		/*!
		 * \brief General TAG with string type content.
		 *
		 * An EC_TAG_STRING holds a UTF-8 encoded string, with terminating zero byte.
		 *
		 * \par Child TAGs:
		 *	(none)
		 *
		 * \note <tt>TAGLEN := strlen(</tt>string<tt>) + 1;</tt>
		 */
	EC_TAG_STRING		= 0x0001,

		/*!
		 * \brief MD4 password hash.
		 *
		 * A \c hash type tag, dedicated to hold password hashes.
		 *
		 * \par Child TAGs:
		 *	(none)
		 */
	EC_TAG_PASSWD_HASH,

		/*!
		 * \brief Client name.
		 *
		 * An ::EC_TAG_STRING, dedicated to hold the client name.
		 *
		 * \par Child TAGs:
		 *	(none)
		 */
	EC_TAG_CLIENT_NAME,

		/*!
		 * \brief Client version string.
		 *
		 * An ::EC_TAG_STRING, dedicated to hold the client version.
		 *
		 * \par Child TAGs:
		 *	(none)
		 */
	EC_TAG_CLIENT_VERSION,

		/*!
		 * \brief Client mod-name.
		 *
		 * An ::EC_TAG_STRING, dedicated to hold the client mod-name.
		 *
		 * \par Child TAGs:
		 *	(none)
		 */
	EC_TAG_CLIENT_MOD,

		/*!
		 * \brief EC protocol version.
		 *
		 * An uint16 value, MSB = major, LSB = minor.
		 * Defaults to \c 0x0200 for v2.0.
		 *
		 * \par Child TAGs:
		 *	(none)
		 */
	EC_TAG_PROTOCOL_VERSION,

		/*!
		 * \brief EC binary version ID
		 *
		 * This ID is different for each change in sensitive
		 * source files, that may cause binary incompatibility.
		 *
		 * This tag is not sent nor accepted on release versions,
		 * thus we can ensure that releases which are binary compatible
		 * can still communicate with each other.
		 *
		 * Data type: \c hash
		 */
	EC_TAG_VERSION_ID,

		/*!
		 * \brief Selects response detail level.
		 *
		 * Selects response detail level in all packets that contain
		 * a server, part/knownfile or updownclient tag. Value type is
		 * \c uint8, and possible values are the EC_DETAIL_* enum values.
		 *
		 * May be included in any request packet, its default value is
		 * highest detail - to save some bandwidth on GUI transfers.
		 */
	EC_TAG_DETAIL_LEVEL,


	//
	// Tags for status (or stats) info
	//

		/*!
		 * \brief Connection state.
		 *
		 * Its value (\c uint8) is a bitfield, set up as following:\n
		 * bits 0-1: ED2K connection state:\n
		 *	00 = not connected,\n
		 *	01 = connecting\n
		 *	11 = connected\n
		 * bits 2-3: Kademlia connection state:\n
		 *	00 = not connected\n
		 *	01 = connected (firewalled)\n
		 *	11 = connected (ok)
		 *
		 * When connected to ED2K, it contains an ::EC_TAG_SERVER child, describing the
		 * server we're connected to, and an ::EC_TAG_ED2K_ID, containing the ed2k userID.
		 */
	EC_TAG_CONNSTATE,
	EC_TAG_ED2K_ID,			///< (\c uint32) ED2K user ID.

	EC_TAG_STATS_UL_SPEED,		///< (\c uint32) Current upload speed in bytes/sec.
	EC_TAG_STATS_DL_SPEED,		///< (\c uint32) Current download speed in bytes/sec.
	EC_TAG_STATS_UL_SPEED_LIMIT,	///< (\c uint32) Upload speed limit in bytes/sec.
	EC_TAG_STATS_DL_SPEED_LIMIT,	///< (\c uint32) Download speed limit in bytes/sec.
	EC_TAG_STATS_UP_OVERHEAD,	///< (\c uint32) Current upload overhead in bytes/sec.
	EC_TAG_STATS_DOWN_OVERHEAD,	///< (\c uint32) Current download overhead in bytes/sec.
	EC_TAG_STATS_TOTAL_SRC_COUNT,	///< (\c uint32) Total number of sources found.
	EC_TAG_STATS_BANNED_COUNT,	///< (\c uint32) Number of banned clients.
	EC_TAG_STATS_UL_QUEUE_LEN,	///< (\c uint32) Number of waiting clients in the upload queue.
	

	//
	// Partfile
	//
	
	/*!
	 * \brief Info about CPartFile
	 * 
	 * Value: MD4 hash (16 bytes)
	 * 
	 * \par Chld TAGs:
	 *  ::EC_TAG_PARTFILE_*
	 */
	EC_TAG_PARTFILE,

	EC_TAG_PARTFILE_NAME,
	EC_TAG_PARTFILE_PARTMETID,	///< (\c uint16) Partfile number. (nnn.part.met)
	EC_TAG_PARTFILE_SIZE_FULL,
	EC_TAG_PARTFILE_SIZE_XFER,    // downloaded
	EC_TAG_PARTFILE_SIZE_XFER_UP, // uploaded
	EC_TAG_PARTFILE_SIZE_DONE,
	EC_TAG_PARTFILE_SPEED,
	EC_TAG_PARTFILE_STATUS,
	EC_TAG_PARTFILE_PRIO,
	EC_TAG_PARTFILE_SOURCE_COUNT,
	EC_TAG_PARTFILE_SOURCE_COUNT_A4AF,
	EC_TAG_PARTFILE_SOURCE_COUNT_NOT_CURRENT,
	EC_TAG_PARTFILE_SOURCE_COUNT_XFER,
	EC_TAG_PARTFILE_ED2K_LINK,
	EC_TAG_PARTFILE_CAT,
	EC_TAG_PARTFILE_LAST_RECV,
	EC_TAG_PARTFILE_LAST_SEEN_COMP,

	/*!
	 * This tag contain info about status of gaps in PartFile and availability of each part.
	 * 
	 * Value: RLE encoded differential info about availability of each part
	 */	
	EC_TAG_PARTFILE_PART_STATUS,
	
	/*!
	 * Info about gaps in CPartFile: data inside contains 2 things
	 * 1. RLE encoded list of differences between previously transmitted gap list and current one
	 */
	EC_TAG_PARTFILE_GAP_STATUS,

	/*!
	 * Info about requested parts: data inside consist of 
	 * pairs of dwords [ start_offset, end_offset]. This data
	 * is not encoded, since it's expected to change quite often
	 */
	 EC_TAG_PARTFILE_REQ_STATUS,

	//
	// KnownFile
	//

	/*!
	 * \brief Info about CKnownFile (shared file)
	 * 
	 * Value (string): (the full one)
	 * 
	 * \par Chld TAGs:
	 *  ::EC_TAG_KNOWNFILE_*
	 */
	EC_TAG_KNOWNFILE,
	EC_TAG_KNOWNFILE_XFERRED,
	EC_TAG_KNOWNFILE_XFERRED_ALL,
	EC_TAG_KNOWNFILE_REQ_COUNT,
	EC_TAG_KNOWNFILE_REQ_COUNT_ALL,
	EC_TAG_KNOWNFILE_ACCEPT_COUNT,
	EC_TAG_KNOWNFILE_ACCEPT_COUNT_ALL,


	//
	// Server
	//

		/*!
		 * \brief Info about server
		 *
		 * Value: (EC_IPv4_t) IP:port of the server
		 *
		 * When any of the childs are missing, their default value should be used
		 *
		 * \par Child TAGs:
		 *	::EC_TAG_SERVER_NAME\n
		 *	::EC_TAG_SERVER_DESC\n
		 *	::EC_TAG_SERVER_PING\n
		 *	::EC_TAG_SERVER_USERS\n
		 *	::EC_TAG_SERVER_USERS_MAX\n
		 *	::EC_TAG_SERVER_FILES\n
		 *	::EC_TAG_SERVER_PRIO\n
		 *	::EC_TAG_SERVER_FAILED\n
		 *	::EC_TAG_SERVER_STATIC\n
		 *	::EC_TAG_SERVER_VERSION
		 */
	EC_TAG_SERVER,

	EC_TAG_SERVER_NAME,		///< (\c string) Server name. Default: none.
	EC_TAG_SERVER_DESC,		///< (\c string) Server description. Default: none.
	EC_TAG_SERVER_ADDRESS,
	EC_TAG_SERVER_PING,		///< (\c uint32) Server ping time. Default: N/A.
	EC_TAG_SERVER_USERS,		///< (\c uint32) User count. Default: N/A.
	EC_TAG_SERVER_USERS_MAX,	///< (\c uint32) Max. user count. Default: N/A.
	EC_TAG_SERVER_FILES,		///< (\c uint32) File count. Default: N/A.
	EC_TAG_SERVER_PRIO,		///< (\c uint8) Server priority. Default: SRV_PR_NORMAL (normal)
					/*!< <ul>
						<li>SRV_PR_LOW - Low Priority</li>
						<li>SRV_PR_NORMAL - Normal</li>
						<li>SRV_PR_HIGH - High Priority</li>
						</ul>

						Look into KnownFile.h for the SRV_PR_* values.
					*/
	EC_TAG_SERVER_FAILED,		///< (\c uint8) Fail count. Default: 0
	EC_TAG_SERVER_STATIC,		///< (\c uint8) Nonzero, when server is static. Default: 0 (not static)
	EC_TAG_SERVER_VERSION,		///< (\c string) Server version. Default: unknown.


	//
	// Up-Down Client
	//

	/*!
	 * \brief Info about up-down client
	 * 
	 * Value (uint32): id of connected user
	 * 
	 * \par Child TAGs: all below
	 */
	EC_TAG_UPDOWN_CLIENT,
	EC_TAG_CLIENT_SOFTWARE,
	EC_TAG_CLIENT_SCORE,
	EC_TAG_CLIENT_HASH,
	EC_TAG_CLIENT_FRIEND,
	EC_TAG_CLIENT_WAIT_TIME,
	EC_TAG_CLIENT_XFER_TIME,
	EC_TAG_CLIENT_QUEUE_TIME,
	EC_TAG_CLIENT_LAST_TIME,
	EC_TAG_CLIENT_UPLOAD_SESSION,
	EC_TAG_CLIENT_UPLOAD_TOTAL,
	EC_TAG_CLIENT_DOWNLOAD_TOTAL,
	EC_TAG_CLIENT_STATE,
	EC_TAG_CLIENT_UP_SPEED,
	EC_TAG_CLIENT_DOWN_SPEED,
	EC_TAG_CLIENT_FROM,
	

	//
	// Search
	//
		/*!
		 * \brief Info about file found in search
		 */
	EC_TAG_SEARCHFILE,
		 
		/*!
		 * \brief Type of search requested
		 * 
		 * Value: (\c uint32) EC_SEARCH_TYPE
		 */
	EC_TAG_SEARCH_TYPE,
	
		/*!
		 * \brief Search parameters
		 */
	EC_TAG_SEARCH_NAME,
	EC_TAG_SEARCH_MIN_SIZE,
	EC_TAG_SEARCH_MAX_SIZE,
	EC_TAG_SEARCH_FILE_TYPE,
	EC_TAG_SEARCH_EXTENSION,
	EC_TAG_SEARCH_AVAILABILITY,


	/*!
	 * \brief Status of search in core
	 */
	 EC_TAG_SEARCH_STATUS,


	//
	// Preferences
	//

		/*!
		 * \brief Selects which preference tables are to be returned.
		 *
		 * Value is (\c uint32) bitmask, OR-ing the EC_PREFS_* values.
		 */
	EC_TAG_SELECT_PREFS,


	//
	// Preferences - Categories
	//

		/*!
		 * \brief Categories
		 *
		 * Holds one or more ::EC_TAG_CATEGORY tags, depending on
		 * the current category count.