module: Support for loading of modules

A module is a shared library existing in, or a subdirectory of, the module directory. The directory is by default ${libdir}/pinos-$(MAJORMINOR)/modules, but can be specified with --with-module-dir=PATH when running configure. It is also possible to override the module directory runtime with the environment variable PINOS_MODULE_DIR, which is a list of directories separated with ":".
2025-11-11 13:30:07 -05:00 · 2016-08-29 12:34:24 +02:00 · 2016-08-29 12:34:24 +02:00 · ba45aad1a2
commit ba45aad1a2
parent 2c0f592ff4
6 changed files with 418 additions and 6 deletions
--- a/pinos/server/module.h
+++ b/pinos/server/module.h
@ -0,0 +1,100 @@
+/* Pinos
+ * Copyright (C) 2016 Axis Communications <dev-gstreamer@axis.com>
+ * @author Linus Svensson <linus.svensson@axis.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __PINOS_MODULE_H__
+#define __PINOS_MODULE_H__
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#include <pinos/server/daemon.h>
+
+#define PINOS_TYPE_MODULE                  (pinos_module_get_type ())
+#define PINOS_IS_MODULE(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PINOS_TYPE_MODULE))
+#define PINOS_IS_MODULE_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), PINOS_TYPE_MODULE))
+#define PINOS_MODULE_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), PINOS_TYPE_MODULE, PinosModuleClass))
+#define PINOS_MODULE(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), PINOS_TYPE_MODULE, PinosModule))
+#define PINOS_MODULE_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), PINOS_TYPE_MODULE, PinosModuleClass))
+#define PINOS_MODULE_CAST(obj)             ((PinosModule*)(obj))
+#define PINOS_MODULE_CLASS_CAST(klass)     ((PinosModuleClass*)(klass))
+
+typedef struct _PinosModule PinosModule;
+typedef struct _PinosModuleClass PinosModuleClass;
+typedef struct _PinosModulePrivate PinosModulePrivate;
+
+struct _PinosModule {
+  GObject object;
+
+  gchar *name;
+  PinosDaemon *daemon;
+
+  PinosModulePrivate *priv;
+};
+
+struct _PinosModuleClass {
+  GObjectClass parent_class;
+};
+
+GQuark pinos_module_error_quark (void);
+/**
+ * PINOS_MODULE_ERROR:
+ *
+ * Pinos module error.
+ */
+#define PINOS_MODULE_ERROR pinos_module_error_quark ()
+
+/**
+ * PinosModuleError:
+ * @PINOS_MODULE_ERROR_GENERIC: Generic module error.
+ * @PINOS_MODULE_ERROR_NOT_FOUND: Module could not be found.
+ * @PINOS_MODULE_ERROR_LOADING: Module could not be loaded.
+ * @PINOS_MODULE_ERROR_INIT: The module failed to initialize.
+ *
+ * Error codes for Pinos modules.
+ */
+typedef enum
+{
+  PINOS_MODULE_ERROR_GENERIC,
+  PINOS_MODULE_ERROR_NOT_FOUND,
+  PINOS_MODULE_ERROR_LOADING,
+  PINOS_MODULE_ERROR_INIT,
+} PinosModuleError;
+
+/**
+ * PinosModuleInitFunc:
+ * @module: A #PinosModule
+ *
+ * A module should provide an init function with this signature. This function
+ * will be called when a module is loaded.
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
+ */
+typedef gboolean (*PinosModuleInitFunc) (PinosModule *module);
+
+GType             pinos_module_get_type          (void);
+
+PinosModule *     pinos_module_load              (PinosDaemon *daemon,
+                                                  const gchar *name,
+                                                  GError **err);
+
+G_END_DECLS
+
+#endif /* __PINOS_MODULE_H__ */