Document tracking id parameter for cpu keepalive method calls
The support for the tracking id parameter was added to mce 1.23.7, but the documentation was not updated accordingly. [mce-headers] Document tracking id parameter for cpu keepalive method calls
This commit is contained in:
		@@ -346,6 +346,19 @@
 | 
			
		||||
 *
 | 
			
		||||
 * @since v1.12.8
 | 
			
		||||
 *
 | 
			
		||||
 * @since v1.23.7
 | 
			
		||||
 *
 | 
			
		||||
 * An unique within process tracking id can be passed to all
 | 
			
		||||
 * cpu keepalive related D-Bus method calls. This allows mce
 | 
			
		||||
 * to keep track of multiple, possibly overlapping keepalive
 | 
			
		||||
 * periods from one process.
 | 
			
		||||
 *
 | 
			
		||||
 * Old code that does not pass the tracking id still works
 | 
			
		||||
 * as long as the client process does not have multiple
 | 
			
		||||
 * overlapping periods at once.
 | 
			
		||||
 *
 | 
			
		||||
 * @param context Tracking id as DBUS_TYPE_STRING
 | 
			
		||||
 *
 | 
			
		||||
 * @return period in seconds as DBUS_TYPE_INT32
 | 
			
		||||
 */
 | 
			
		||||
#define MCE_CPU_KEEPALIVE_PERIOD_REQ	"req_cpu_keepalive_period"
 | 
			
		||||
@@ -362,6 +375,8 @@
 | 
			
		||||
 *
 | 
			
		||||
 * @since v1.12.8
 | 
			
		||||
 *
 | 
			
		||||
 * @param context Tracking id as DBUS_TYPE_STRING
 | 
			
		||||
 *
 | 
			
		||||
 * @return success as DBUS_TYPE_BOOLEAN
 | 
			
		||||
 */
 | 
			
		||||
#define MCE_CPU_KEEPALIVE_START_REQ	"req_cpu_keepalive_start"
 | 
			
		||||
@@ -377,6 +392,8 @@
 | 
			
		||||
 *
 | 
			
		||||
 * @since v1.12.8
 | 
			
		||||
 *
 | 
			
		||||
 * @param context Tracking id as DBUS_TYPE_STRING
 | 
			
		||||
 *
 | 
			
		||||
 * @return success as DBUS_TYPE_BOOLEAN
 | 
			
		||||
 */
 | 
			
		||||
#define MCE_CPU_KEEPALIVE_STOP_REQ	"req_cpu_keepalive_stop"
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user