AgsServer

AgsServer — remote control server

Functions

Properties

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsServer

Implemented Interfaces

AgsServer implements AgsConnectable.

Includes

#include <ags/server/ags_server.h>

Description

The AgsServer is a XML-RPC server.

Functions

ags_server_info_alloc ()

AgsServerInfo *
ags_server_info_alloc (gchar *server_name);

Allocate server info.

Parameters

server_name

the server name

 

Returns

the allocated AgsServerInfo

Since: 1.0.0


ags_server_start ()

void
ags_server_start (AgsServer *server);

Start the XMLRPC-C abyss server.

Parameters

server

the AgsServer

 

Since: 1.0.0


ags_server_lookup ()

AgsServer *
ags_server_lookup (AgsServerInfo *server_info);

Lookup AgsServer by server_info .

Parameters

server_info

the AgsServerInfo

 

Returns

the associated AgsServer if found, else NULL

Since: 1.0.0


ags_server_new ()

AgsServer *
ags_server_new (GObject *application_context);

Instantiate AgsServer.

Parameters

application_context

the AgsApplicationContext

 

Returns

a new AgsServer

Since: 1.0.0


AGS_IS_SERVER()

#define AGS_IS_SERVER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_SERVER))

AGS_SERVER()

#define AGS_SERVER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SERVER, AgsServer))

AGS_SERVER_CLASS()

#define AGS_SERVER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_SERVER, AgsServerClass))

AGS_SERVER_GET_CLASS()

#define AGS_SERVER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_SERVER, AgsServerClass))

ags_server_get_type ()

GType
ags_server_get_type ();

Types and Values

AGS_SERVER_DEFAULT_AUTH_MODULE

#define AGS_SERVER_DEFAULT_AUTH_MODULE "ags-xml-password-store"

enum AgsServerFlags

Enum values to control the behavior or indicate internal state of AgsServer by enable/disable as flags.

Members

AGS_SERVER_CONNECTED

the server was connected by AgsConnectable::connect()

 

AGS_SERVER_STARTED

the server was started

 

AGS_SERVER_RUNNING

the server is up and running

 

struct AgsServerInfo

struct AgsServerInfo {
  gchar *uuid;
  gchar *server_name;
};

AgsServerInfo does identify the server and provides some basic information about it.

Members

gchar *uuid;

the assigned uuid

 

gchar *server_name;

the server's name

 

AGS_TYPE_SERVER

#define AGS_TYPE_SERVER                (ags_server_get_type())

struct AgsServer

struct AgsServer;

struct AgsServerClass

struct AgsServerClass {
  GObjectClass object;
  
  void (*start)(AgsServer *server);
};

Property Details

The “application-context” property

  “application-context”      AgsApplicationContext *

The assigned AgsApplicationContext

Flags: Read / Write

Since: 1.0.0

Signal Details

The “start” signal

void
user_function (AgsServer *server,
               gpointer   user_data)

The ::start signal is emitted as the server starts.

Parameters

server

the AgsServer

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0