Browse Source

Add a note about GAMEMODE_AUTO and blocking calls

Marc Di Luzio 5 years ago
parent
commit
ddecc89f10
1 changed files with 6 additions and 0 deletions
  1. 6 0
      lib/gamemode_client.h

+ 6 - 0
lib/gamemode_client.h

@@ -42,6 +42,9 @@ POSSIBILITY OF SUCH DAMAGE.
  *   0 if the request was sent successfully
  *   -1 if the request failed
  *
+ * GAMEMODE_AUTO can be defined to make the above two functions apply during static init and
+ * destruction, as appropriate. In this configuration, errors will be printed to stderr
+ *
  * int gamemode_query_status() - Query the current status of gamemode
  *   0 if gamemode is inactive
  *   1 if gamemode is active
@@ -64,6 +67,9 @@ POSSIBILITY OF SUCH DAMAGE.
  *
  * const char* gamemode_error_string() - Get an error string
  *   returns a string describing any of the above errors
+ *
+ * Note: All the above requests can be blocking - dbus requests can and will block while the daemon
+ * handles the request. It is not recommended to make these calls in performance critical code
  */
 
 #include <stdbool.h>