+/* SPDX-License-Identifier: Apache-2.0 */
/**
* @file ml-agent-interface.h
* @date 5 April 2023
#include <glib.h>
/**
- * @brief An interface exported for setting the description of a pipeline
- * @param[in] name A name indicating the pipeline whose description would be set
- * @param[in] pipeline_desc A stringified description of the pipeline
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for setting the description of a pipeline.
+ * @param[in] name A name indicating the pipeline whose description would be set.
+ * @param[in] pipeline_desc A stringified description of the pipeline.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_pipeline_set_description (const gchar *name, const gchar *pipeline_desc, GError **err);
/**
- * @brief An interface exported for getting the pipeline's description corresponding to the given @name
- * @param[in] name A given name of the pipeline to get the description
- * @param[out] pipeline_desc A stringified description of the pipeline
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for getting the pipeline's description corresponding to the given @a name.
+ * @remarks If the function succeeds, @a pipeline_desc should be released using g_free().
+ * @param[in] name A given name of the pipeline to get the description.
+ * @param[out] pipeline_desc A stringified description of the pipeline.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_pipeline_get_description (const gchar *name, gchar **pipeline_desc, GError **err);
/**
- * @brief An interface exported for deletion of the pipeline's description corresponding to the given @name
- * @param[in] name A given name of the pipeline to remove the description
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for deletion of the pipeline's description corresponding to the given @a name.
+ * @param[in] name A given name of the pipeline to remove the description.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_pipeline_delete (const gchar *name, GError **err);
/**
- * @brief An interface exported for launching the pipeline's description corresponding to the given @name
- * @param[in] name A given name of the pipeline to launch
- * @param[out] id Return an integer identifier for the launched pipeline
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for launching the pipeline's description corresponding to the given @a name.
+ * @param[in] name A given name of the pipeline to launch.
+ * @param[out] id A pointer of integer identifier for the launched pipeline.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_pipeline_launch (const gchar *name, gint64 *id, GError **err);
/**
- * @brief An interface exported for changing the pipeline's state of the given @id to start
- * @param[in] id An identifier of the launched pipeline whose state would be changed to start
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for changing the pipeline's state of the given @a id to start.
+ * @param[in] id An identifier of the launched pipeline whose state would be changed to start.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_pipeline_start (gint64 id, GError **err);
+gint ml_agent_pipeline_start (const gint64 id, GError **err);
/**
- * @brief An interface exported for changing the pipeline's state of the given @id to stop
- * @param[in] id An identifier of the launched pipeline whose state would be changed to stop
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for changing the pipeline's state of the given @a id to stop.
+ * @param[in] id An identifier of the launched pipeline whose state would be changed to stop.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_pipeline_stop (gint64 id, GError **err);
+gint ml_agent_pipeline_stop (const gint64 id, GError **err);
/**
- * @brief An interface exported for destroying a launched pipeline corresponding to the given @id
- * @param[in] id An identifier of the launched pipeline that would be destroyed
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for destroying a launched pipeline corresponding to the given @a id.
+ * @param[in] id An identifier of the launched pipeline that would be destroyed.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_pipeline_destroy (gint64 id, GError **err);
+gint ml_agent_pipeline_destroy (const gint64 id, GError **err);
/**
- * @brief An interface exported for getting the pipeline's state of the given @id
- * @param[in] id An identifier of the launched pipeline that would be destroyed
- * @param[out] state Return location for the pipeline's state
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for getting the pipeline's state of the given @a id.
+ * @param[in] id An identifier of the launched pipeline that would be destroyed.
+ * @param[out] state A pointer for the pipeline's state.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_pipeline_get_state (gint64 id, gint *state, GError **err);
+gint ml_agent_pipeline_get_state (const gint64 id, gint *state, GError **err);
/**
- * @brief An interface exported for registering a model
- * @param[in] name A name indicating the model that would be registered
- * @param[in] path A path that specifies the location of the model file
- * @param[in] activate An initial activation state
- * @param[in] description A stringified description of the given model
- * @param[in] app_info Application-specific information from Tizen's RPK
- * @param[out] version Return location for the version of the given model registered
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for registering a model.
+ * @param[in] name A name indicating the model that would be registered.
+ * @param[in] path A path that specifies the location of the model file.
+ * @param[in] activate An initial activation state.
+ * @param[in] description A stringified description of the given model.
+ * @param[in] app_info Application-specific information from Tizen's RPK.
+ * @param[out] version A pointer for the version of the given model registered.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_model_register(const gchar *name, const gchar *path, const gboolean activate, const gchar *description, const gchar *app_info, guint *version, GError **err);
/**
- * @brief An interface exported for updating the description of the given model, @name
- * @param[in] name A name indicating the model whose description would be updated
- * @param[in] version A version for identifying the model whose description would be updated
- * @param[in] description A new description to update the existing one
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for updating the description of the model with @a name and @a version.
+ * @param[in] name A name indicating the model whose description would be updated.
+ * @param[in] version A version for identifying the model whose description would be updated.
+ * @param[in] description A new description to update the existing one.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_model_update_description (const gchar *name, const guint version, const gchar *description, GError **err);
/**
- * @brief An interface exported for activating the model of @name and @version
- * @param[in] name A name indicating a registered model
- * @param[in] version A version of the given model, @name
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for activating the model with @a name and @a version.
+ * @param[in] name A name indicating a registered model.
+ * @param[in] version A version of the given model, @a name.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_model_activate(const gchar *name, const guint version, GError **err);
/**
- * @brief An interface exported for getting the description of the given model of @name and @version
- * @param[in] name A name indicating the model whose description would be get
- * @param[in] version A version of the given model, @name
- * @param[out] description Return location for the description of the given model of @name and @version
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for getting the information of the model with @a name and @a version.
+ * @remarks If the function succeeds, @a model_info should be released using g_free().
+ * @param[in] name A name indicating the model whose description would be get.
+ * @param[in] version A version of the given model.
+ * @param[out] model_info A pointer for the information of the given model of @a name and @a version.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_model_get(const gchar *name, const guint version, gchar **description, GError **err);
+gint ml_agent_model_get(const gchar *name, const guint version, gchar **model_info, GError **err);
/**
- * @brief An interface exported for getting the description of the activated model of the given @name
- * @param[in] name A name indicating the model whose description would be get
- * @param[out] description Return location for the description of an activated model of the given @name
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for getting the information of the activated model with @a name.
+ * @remarks If the function succeeds, @a model_info should be released using g_free().
+ * @param[in] name A name indicating the model whose description would be get.
+ * @param[out] model_info A pointer for the information of an activated model of the given @a name.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_model_get_activated(const gchar *name, gchar **description, GError **err);
+gint ml_agent_model_get_activated(const gchar *name, gchar **model_info, GError **err);
/**
- * @brief An interface exported for getting the description of all the models corresponding to the given @name
- * @param[in] name A name indicating the models whose description would be get
- * @param[out] description Return location for the description of all the models corresponding to the given @name
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for getting the information of all the models corresponding to the given @a name.
+ * @remarks If the function succeeds, @a model_info should be released using g_free().
+ * @param[in] name A name indicating the models whose description would be get.
+ * @param[out] model_info A pointer for the information of all the models corresponding to the given @a name.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
-gint ml_agent_model_get_all(const gchar *name, gchar **description, GError **err);
+gint ml_agent_model_get_all(const gchar *name, gchar **model_info, GError **err);
/**
- * @brief An interface exported for removing the model of @name and @version
- * @param[in] name A name indicating the model that would be removed
- * @param[in] version A version for identifying a specific model whose name is @name
- * @param[in] description A new description to update the existing one
- * @param[out] err Return location for error of NULL
- * @return 0 on success, a negative error value if @err is set
+ * @brief An interface exported for removing the model of @a name and @a version.
+ * @details If version is 0, this function removes all registered model of @a name.
+ * @param[in] name A name indicating the model that would be removed.
+ * @param[in] version A version for identifying a specific model.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_model_delete(const gchar *name, const guint version, GError **err);
/**
- * @brief An interface exported for adding the resource
- * @param[in] name A name indicating the resource
- * @param[in] path A path that specifies the location of the resource
- * @param[in] description A stringified description of the resource
- * @param[in] app_info Application-specific information from Tizen's RPK
- * @param[out] err Return location for error
- * @return 0 on success, a negative error value if failed
+ * @brief An interface exported for adding the resource.
+ * @param[in] name A name indicating the resource.
+ * @param[in] path A path that specifies the location of the resource.
+ * @param[in] description A stringified description of the resource.
+ * @param[in] app_info Application-specific information from Tizen's RPK.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_resource_add (const gchar *name, const gchar *path, const gchar *description, const gchar *app_info, GError **err);
/**
- * @brief An interface exported for removing the resource with @name
- * @param[in] name A name indicating the resource
- * @param[out] err Return location for error
- * @return 0 on success, a negative error value if failed
+ * @brief An interface exported for removing the resource with @a name.
+ * @param[in] name A name indicating the resource.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_resource_delete (const gchar *name, GError **err);
/**
- * @brief An interface exported for getting the description of the resource with @name
- * @param[in] name A name indicating the resource
- * @param[out] res_info Return location for the information of the resource
- * @param[out] err Return location for error
- * @return 0 on success, a negative error value if failed
+ * @brief An interface exported for getting the description of the resource with @a name.
+ * @remarks If the function succeeds, @a res_info should be released using g_free().
+ * @param[in] name A name indicating the resource.
+ * @param[out] res_info A pointer for the information of the resource.
+ * @param[out] err A pointer for error, or NULL.
+ * @return 0 on success, a negative error value if failed.
*/
gint ml_agent_resource_get (const gchar *name, gchar **res_info, GError **err);
#include "pipeline-dbus.h"
#include "resource-dbus.h"
+#define STR_IS_VALID(s) ((s) && (s)[0] != '\0')
+
typedef enum
{
ML_AGENT_SERVICE_PIPELINE = 0,
for (i = 0; i < num_bus_types; ++i) {
g_clear_error (&_err);
- mlsp =
- machinelearning_service_pipeline_proxy_new_for_bus_sync (bus_types
- [i], G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME, DBUS_PIPELINE_PATH,
- NULL, &_err);
+
+ mlsp = machinelearning_service_pipeline_proxy_new_for_bus_sync
+ (bus_types[i], G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME,
+ DBUS_PIPELINE_PATH, NULL, &_err);
if (mlsp) {
break;
}
for (i = 0; i < num_bus_types; ++i) {
g_clear_error (&_err);
- mlsm =
- machinelearning_service_model_proxy_new_for_bus_sync (bus_types[i],
- G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME, DBUS_MODEL_PATH, NULL,
- &_err);
+ mlsm = machinelearning_service_model_proxy_new_for_bus_sync
+ (bus_types[i], G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME,
+ DBUS_MODEL_PATH, NULL, &_err);
if (mlsm)
break;
}
for (i = 0; i < num_bus_types; ++i) {
g_clear_error (&_err);
- mlsr =
- machinelearning_service_resource_proxy_new_for_bus_sync (bus_types[i],
- G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME, DBUS_RESOURCE_PATH, NULL,
- &_err);
+ mlsr = machinelearning_service_resource_proxy_new_for_bus_sync
+ (bus_types[i], G_DBUS_PROXY_FLAGS_NONE, DBUS_ML_BUS_NAME,
+ DBUS_RESOURCE_PATH, NULL, &_err);
if (mlsr)
break;
}
}
/**
- * @brief An interface exported for setting the description of a pipeline
+ * @brief An interface exported for setting the description of a pipeline.
*/
gint
ml_agent_pipeline_set_description (const gchar * name,
MachinelearningServicePipeline *mlsp;
gboolean result;
- if (!name || !pipeline_desc) {
+ if (!STR_IS_VALID (name) || !STR_IS_VALID (pipeline_desc)) {
g_return_val_if_reached (-EINVAL);
}
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_set_pipeline_sync
- (MACHINELEARNING_SERVICE_PIPELINE (mlsp), name, pipeline_desc, NULL, NULL,
- err);
+ result = machinelearning_service_pipeline_call_set_pipeline_sync (mlsp,
+ name, pipeline_desc, NULL, NULL, err);
g_object_unref (mlsp);
- g_return_val_if_fail (result, -EIO);
+ g_return_val_if_fail (result, -EIO);
return 0;
}
/**
- * @brief An interface exported for getting the pipeline's description corresponding to the given @name
+ * @brief An interface exported for getting the pipeline's description corresponding to the given @a name.
*/
gint
ml_agent_pipeline_get_description (const gchar * name,
gboolean result;
gint ret;
- if (!name || !pipeline_desc) {
+ if (!STR_IS_VALID (name) || !pipeline_desc) {
g_return_val_if_reached (-EINVAL);
}
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_get_pipeline_sync
- (MACHINELEARNING_SERVICE_PIPELINE (mlsp), name, &ret, pipeline_desc, NULL,
- err);
+ result = machinelearning_service_pipeline_call_get_pipeline_sync (mlsp,
+ name, &ret, pipeline_desc, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for deletion of the pipeline's description corresponding to the given @name
+ * @brief An interface exported for deletion of the pipeline's description corresponding to the given @a name.
*/
gint
ml_agent_pipeline_delete (const gchar * name, GError ** err)
gboolean result;
gint ret;
- if (!name) {
+ if (!STR_IS_VALID (name)) {
g_return_val_if_reached (-EINVAL);
}
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_delete_pipeline_sync
- (MACHINELEARNING_SERVICE_PIPELINE (mlsp), name, &ret, NULL, err);
+ result = machinelearning_service_pipeline_call_delete_pipeline_sync (mlsp,
+ name, &ret, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for launching the pipeline's description corresponding to the given @name
+ * @brief An interface exported for launching the pipeline's description corresponding to the given @a name.
*/
gint
ml_agent_pipeline_launch (const gchar * name, gint64 * id, GError ** err)
gboolean result;
gint ret;
- if (!name) {
+ if (!STR_IS_VALID (name) || !id) {
g_return_val_if_reached (-EINVAL);
}
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_launch_pipeline_sync (mlsp, name,
- &ret, id, NULL, err);
+ result = machinelearning_service_pipeline_call_launch_pipeline_sync (mlsp,
+ name, &ret, id, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for changing the pipeline's state of the given @id to start
+ * @brief An interface exported for changing the pipeline's state of the given @a id to start.
*/
gint
-ml_agent_pipeline_start (gint64 id, GError ** err)
+ml_agent_pipeline_start (const gint64 id, GError ** err)
{
MachinelearningServicePipeline *mlsp;
gboolean result;
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_start_pipeline_sync (mlsp, id, &ret,
- NULL, err);
+ result = machinelearning_service_pipeline_call_start_pipeline_sync (mlsp,
+ id, &ret, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for changing the pipeline's state of the given @id to stop
+ * @brief An interface exported for changing the pipeline's state of the given @a id to stop.
*/
gint
-ml_agent_pipeline_stop (gint64 id, GError ** err)
+ml_agent_pipeline_stop (const gint64 id, GError ** err)
{
MachinelearningServicePipeline *mlsp;
gboolean result;
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_stop_pipeline_sync (mlsp, id, &ret,
- NULL, err);
+ result = machinelearning_service_pipeline_call_stop_pipeline_sync (mlsp,
+ id, &ret, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for destroying a launched pipeline corresponding to the given @id
+ * @brief An interface exported for destroying a launched pipeline corresponding to the given @a id.
*/
gint
-ml_agent_pipeline_destroy (gint64 id, GError ** err)
+ml_agent_pipeline_destroy (const gint64 id, GError ** err)
{
MachinelearningServicePipeline *mlsp;
-
gboolean result;
gint ret;
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_destroy_pipeline_sync (mlsp, id,
- &ret, NULL, err);
+ result = machinelearning_service_pipeline_call_destroy_pipeline_sync (mlsp,
+ id, &ret, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for getting the pipeline's state of the given @id
+ * @brief An interface exported for getting the pipeline's state of the given @a id.
*/
gint
-ml_agent_pipeline_get_state (gint64 id, gint * state, GError ** err)
+ml_agent_pipeline_get_state (const gint64 id, gint * state, GError ** err)
{
MachinelearningServicePipeline *mlsp;
-
gboolean result;
gint ret;
+ if (!state) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsp = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_PIPELINE, err);
if (!mlsp) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_pipeline_call_get_state_sync (mlsp, id, &ret,
- state, NULL, err);
+ result = machinelearning_service_pipeline_call_get_state_sync (mlsp,
+ id, &ret, state, NULL, err);
g_object_unref (mlsp);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for registering a model
+ * @brief An interface exported for registering a model.
*/
gint
ml_agent_model_register (const gchar * name, const gchar * path,
guint * version, GError ** err)
{
MachinelearningServiceModel *mlsm;
-
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !STR_IS_VALID (path) || !version) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for updating the description of the given model, @name
+ * @brief An interface exported for updating the description of the model with @a name and @a version.
*/
gint
ml_agent_model_update_description (const gchar * name,
const guint version, const gchar * description, GError ** err)
{
MachinelearningServiceModel *mlsm;
-
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !STR_IS_VALID (description) || version == 0U) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_update_description_sync (mlsm, name,
- version, description, &ret, NULL, err);
+ result = machinelearning_service_model_call_update_description_sync (mlsm,
+ name, version, description, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for activating the model of @name and @version
+ * @brief An interface exported for activating the model with @a name and @a version.
*/
gint
ml_agent_model_activate (const gchar * name, const guint version, GError ** err)
{
MachinelearningServiceModel *mlsm;
-
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || version == 0U) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_activate_sync (mlsm, name, version,
- &ret, NULL, err);
+ result = machinelearning_service_model_call_activate_sync (mlsm,
+ name, version, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for getting the description of the given model of @name and @version
+ * @brief An interface exported for getting the information of the model with @a name and @a version.
*/
gint
ml_agent_model_get (const gchar * name, const guint version,
- gchar ** description, GError ** err)
+ gchar ** model_info, GError ** err)
{
MachinelearningServiceModel *mlsm;
-
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !model_info || version == 0U) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_get_sync (mlsm, name, version,
- description, &ret, NULL, err);
+ result = machinelearning_service_model_call_get_sync (mlsm,
+ name, version, model_info, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for getting the description of the activated model of the given @name
+ * @brief An interface exported for getting the information of the activated model with @a name.
*/
gint
ml_agent_model_get_activated (const gchar * name,
- gchar ** description, GError ** err)
+ gchar ** model_info, GError ** err)
{
MachinelearningServiceModel *mlsm;
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !model_info) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_get_activated_sync (mlsm, name,
- description, &ret, NULL, err);
+ result = machinelearning_service_model_call_get_activated_sync (mlsm,
+ name, model_info, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for getting the description of all the models corresponding to the given @name
+ * @brief An interface exported for getting the information of all the models corresponding to the given @a name.
*/
gint
-ml_agent_model_get_all (const gchar * name, gchar ** description, GError ** err)
+ml_agent_model_get_all (const gchar * name, gchar ** model_info, GError ** err)
{
MachinelearningServiceModel *mlsm;
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !model_info) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_get_all_sync (mlsm, name, description,
- &ret, NULL, err);
+ result = machinelearning_service_model_call_get_all_sync (mlsm,
+ name, model_info, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for removing the model of @name and @version
+ * @brief An interface exported for removing the model of @a name and @a version.
*/
gint
ml_agent_model_delete (const gchar * name, const guint version, GError ** err)
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name)) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsm = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_MODEL, err);
if (!mlsm) {
g_return_val_if_reached (-EIO);
}
- result =
- machinelearning_service_model_call_delete_sync (mlsm, name, version, &ret,
- NULL, err);
+ result = machinelearning_service_model_call_delete_sync (mlsm,
+ name, version, &ret, NULL, err);
g_object_unref (mlsm);
g_return_val_if_fail (ret == 0 && result, ret);
-
return 0;
}
/**
- * @brief An interface exported for adding the resource
+ * @brief An interface exported for adding the resource.
*/
gint
ml_agent_resource_add (const gchar * name, const gchar * path,
const gchar * description, const gchar * app_info, GError ** err)
{
MachinelearningServiceResource *mlsr;
-
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !STR_IS_VALID (path)) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsr = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_RESOURCE, err);
if (!mlsr) {
g_return_val_if_reached (-EIO);
}
/**
- * @brief An interface exported for removing the resource with @name
+ * @brief An interface exported for removing the resource with @a name.
*/
gint
ml_agent_resource_delete (const gchar * name, GError ** err)
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name)) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsr = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_RESOURCE, err);
if (!mlsr) {
g_return_val_if_reached (-EIO);
}
- result = machinelearning_service_resource_call_delete_sync (mlsr, name, &ret,
- NULL, err);
+ result = machinelearning_service_resource_call_delete_sync (mlsr,
+ name, &ret, NULL, err);
g_object_unref (mlsr);
g_return_val_if_fail (ret == 0 && result, ret);
}
/**
- * @brief An interface exported for getting the description of the resource with @name
+ * @brief An interface exported for getting the description of the resource with @a name.
*/
gint
ml_agent_resource_get (const gchar * name, gchar ** res_info, GError ** err)
gboolean result;
gint ret;
+ if (!STR_IS_VALID (name) || !res_info) {
+ g_return_val_if_reached (-EINVAL);
+ }
+
mlsr = _get_proxy_new_for_bus_sync (ML_AGENT_SERVICE_RESOURCE, err);
if (!mlsr) {
g_return_val_if_reached (-EIO);
}
- result = machinelearning_service_resource_call_get_sync (mlsr, name,
- res_info, &ret, NULL, err);
+ result = machinelearning_service_resource_call_get_sync (mlsr,
+ name, res_info, &ret, NULL, err);
g_object_unref (mlsr);
g_return_val_if_fail (ret == 0 && result, ret);
projects / platform / core / ml / mlops-agent.git / commitdiff