AgsFrontController

AgsFrontController — handle all XMLRPC requests

Functions

gpointer ags_front_controller_authenticate ()
gpointer ags_front_controller_do_request ()
AgsFrontController * ags_front_controller_new ()
#define AGS_FRONT_CONTROLLER()
#define AGS_FRONT_CONTROLLER_CLASS()
#define AGS_FRONT_CONTROLLER_GET_CLASS()
#define AGS_IS_FRONT_CONTROLLER()
GType ags_front_controller_get_type ()

Signals

gpointer authenticate Run Last
gpointer do-request Run Last

Types and Values

#define AGS_TYPE_FRONT_CONTROLLER
struct AgsFrontController
struct AgsFrontControllerClass

Object Hierarchy

    GObject
    ╰── AgsFrontController

Implemented Interfaces

AgsFrontController implements AgsConnectable.

Includes

#include <ags/server/controller/ags_front_controller.h>

Description

The AgsFrontController is an object to handle XMLRPC requests.

Functions

ags_front_controller_authenticate ()

gpointer
ags_front_controller_authenticate (AgsFrontController *front_controller,
                                   gchar *authentication_module,
                                   gchar *login,
                                   gchar *password,
                                   gchar *certs);

Authenticate to the server.

Parameters

front_controller

the AgsFrontController

  

authentication_module

the authentication module to use

  

login

the login

  

password

the password

  

certs

the certs data

  

Returns

on success the GParameter containing user's uuid and security token, otherwise NULL.

Since: 2.0.0

ags_front_controller_do_request ()

gpointer
ags_front_controller_do_request (AgsFrontController *front_controller,
                                 GObject *security_context,
                                 gchar *context_path,
                                 gchar *login,
                                 gchar *security_token,
                                 guint n_params,
                                 gchar **parameter_name,
                                 GValue *value);

Do a XML-RPC request for the given context_path with params .

Parameters

front_controller

the AgsFrontController

  

security_context

the AgsSecurityContext

  

context_path

the context path to access

  

login

the login

  

security_token

the security token

  

n_params

the parameter name and value count

  

parameter_name

the parameter names

  

value

the GValue array related to parameter names

  

Returns

the response, on success the GParameter containing requested parameters, otherwise NULL.

Since: 2.0.0

ags_front_controller_new ()

AgsFrontController *
ags_front_controller_new ();

AGS_FRONT_CONTROLLER()

#define AGS_FRONT_CONTROLLER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_FRONT_CONTROLLER, AgsFrontController))

AGS_FRONT_CONTROLLER_CLASS()

#define AGS_FRONT_CONTROLLER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_FRONT_CONTROLLER, AgsFrontControllerClass))

AGS_FRONT_CONTROLLER_GET_CLASS()

#define AGS_FRONT_CONTROLLER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_FRONT_CONTROLLER, AgsFrontControllerClass))

AGS_IS_FRONT_CONTROLLER()

#define AGS_IS_FRONT_CONTROLLER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_FRONT_CONTROLLER))

ags_front_controller_get_type ()

GType
ags_front_controller_get_type ();

Types and Values

AGS_TYPE_FRONT_CONTROLLER

#define AGS_TYPE_FRONT_CONTROLLER                (ags_front_controller_get_type())

struct AgsFrontController

struct AgsFrontController;

struct AgsFrontControllerClass

struct AgsFrontControllerClass {
  AgsControllerClass controller;

  gpointer (*authenticate)(AgsFrontController *front_controller,
			   gchar *authentication_module,
			   gchar *login,
			   gchar *password,
			   gchar *certs);

  gpointer (*do_request)(AgsFrontController *front_controller,
			 GObject *security_context,
			 gchar *context_path,
			 gchar *login,
			 gchar *security_token,
			 guint n_params, gchar **parameter_name, GValue *value);
};

Signal Details

The “authenticate” signal

gpointer
user_function (AgsFrontController *front_controller,
               gchar              *authentication_module,
               gchar              *login,
               gchar              *password,
               gchar              *certs,
               gpointer            user_data)

Authenticate to the front controller.

Parameters

front_controller

the AgsFrontController

  

authentication_module

the authentication module

  

login

the login

  

password

the password

  

certs

certificate

  

user_data

user data set when the signal handler was connected.

  

Returns

on success a new AgsSecurityContext, otherwise NULL

Flags: Run Last

Since: 2.0.0

The “do-request” signal

gpointer
user_function (AgsFrontController *front_controller,
               GObject            *security_context,
               gchar              *context_path,
               gchar              *user,
               gchar              *security_token,
               guint               n_params,
               gpointer            parameter_name,
               gpointer            value,
               gpointer            user_data)

Do a request on the front controller.

Parameters

front_controller

the AgsFrontController

  

security_context

the AgsSecurityContext

  

context_path

the context path to access

  

user

the user's UUID

  

security_token

the security token

  

n_params

the parameter name and value count

  

parameter_name

the parameter names

  

value

the GValue array related to parameter names

  

user_data

user data set when the signal handler was connected.

  

Returns

the response

Flags: Run Last

Since: 2.0.0

Generated by GTK-Doc V1.28