[aravis/realtime] realtime: API documentation



commit 6ffea29c2c08fcbad6c502bc587fbf43dc361df1
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Tue Dec 2 11:37:00 2014 +0100

    realtime: API documentation

 src/arvrealtime.c |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)
---
diff --git a/src/arvrealtime.c b/src/arvrealtime.c
index 8218e35..94e24e7 100644
--- a/src/arvrealtime.c
+++ b/src/arvrealtime.c
@@ -221,6 +221,18 @@ static pid_t _gettid(void) {
         return (pid_t) syscall(SYS_gettid);
 }
 
+/**
+ * arv_make_thread_realtime:
+ * @priority: realtime priority
+ *
+ * Returns: %TRUE on success.
+ *
+ * Try to make current thread realtime. It first try to use sched_setscheduler,
+ * and if it fails, use rtkit.
+ *
+ * Since: 0.4.0
+ */
+
 gboolean
 arv_make_thread_realtime (int priority)
 {
@@ -266,6 +278,17 @@ arv_make_thread_realtime (int priority)
        return TRUE;
 }
 
+/**
+ * arv_make_thread_high_priority:
+ * @nice_level: new nice level
+ *
+ * Returns: %TRUE on success.
+ *
+ * Try to set current thread nice level to high priority, using rtkit.
+ *
+ * Since: 0.4.0
+ */
+
 gboolean
 arv_make_thread_high_priority (int nice_level)
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]