krähemann.com

AgsFrontController

AgsFrontController — handle all XMLRPC requests

Signals

gpointer do-request Run Last

Object Hierarchy

    GObject
    ╰── AgsController
        ╰── AgsFrontController

Includes

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

Description

The AgsFrontController is an object to handle XMLRPC requests.

Functions

ags_front_controller_do_request ()

gpointer
ags_front_controller_do_request (AgsFrontController *front_controller,
                                 SoupMessage *msg,
                                 GHashTable *query,
                                 SoupClientContext *client,
                                 GObject *security_context,
                                 gchar *path,
                                 gchar *login,
                                 gchar *security_token);

Do a XML-RPC request for the given path with query .

Parameters

front_controller

the AgsFrontController

 

msg

the SoupMessage

 

query

the GHashTable

 

client

the SoupClientContext

 

security_context

the AgsSecurityContext

 

path

the context path to access

 

login

the login

 

security_token

the security token

 

Returns

the response on success, otherwise NULL.

Since: 3.0.0


ags_front_controller_new ()

AgsFrontController *
ags_front_controller_new ();

Instantiate new AgsFrontController

Returns

the AgsFrontController

Since: 3.0.0


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 (*do_request)(AgsFrontController *front_controller,
			 SoupMessage *msg,
			 GHashTable *query,
			 SoupClientContext *client,
			 GObject *security_context,
			 gchar *path,
			 gchar *login,
			 gchar *security_token);
};

Signal Details

The “do-request” signal

gpointer
user_function (AgsFrontController *front_controller,
               GObject            *msg,
               gpointer            query,
               gpointer            client,
               GObject            *security_context,
               gchar              *context_path,
               gchar              *user,
               gchar              *security_token,
               gpointer            user_data)

Do a request on the front controller.

Parameters

front_controller

the AgsFrontController

 

msg

the SoupMessage

 

query

the GHashTable

 

client

the SoupClient

 

security_context

the AgsSecurityContext

 

context_path

the context path to access

 

user

the user's UUID

 

security_token

the security token

 

user_data

user data set when the signal handler was connected.

 

Returns

the response

Flags: Run Last

Since: 3.0.0