Ags.Server¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`add_controller` (controller)
	`listen` ()
	`remove_controller` (controller)
	`set_flags` (flags)
	`start` ()
	`stop` ()
	`test_flags` (flags)
	`unset_flags` (flags)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_listen` ()
	`do_start` ()
	`do_stop` ()

Properties¶

Name	Type	Flags	Short Description
`controller`	`int`	r/w	The controller it is assigned with
`domain`	`str`	r/w	The domain to use
`front-controller`	`Ags.FrontController`	r/w	The front controller it is assigned with
`ip4`	`str`	r/w	The IPv4 address of the server
`ip6`	`str`	r/w	The IPv6 address of the server
`path`	`str`	r/w	The path to use
`realm`	`str`	r/w	The realm to use
`server-port`	`int`	r/w	The server port to use

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`listen`	The `::listen` signal is emited during listen of server.
`start`	The `::start` signal is emitted as the server starts.
`stop`	The `::stop` signal is emitted as the server stops.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
auth_domain	`Soup.AuthDomain`	r
auth_module	`str`	r
controller	[`object`]	r
domain	`str`	r
flags	`int`	r
front_controller	`GObject.Object`	r
gobject	`GObject.Object`	r
ip4	`str`	r
ip4_address	`Gio.SocketAddress`	r
ip4_fd	`int`	r
ip4_socket	`Gio.Socket`	r
ip6	`str`	r
ip6_address	`Gio.SocketAddress`	r
ip6_fd	`int`	r
ip6_socket	`Gio.Socket`	r
obj_mutex	`GLib.RecMutex`	r
path	`str`	r
realm	`str`	r
server_info	`Ags.ServerInfo`	r
server_port	`int`	r
soup_server	`Soup.Server`	r
uuid	`Ags.UUID`	r

Class Details¶

class Ags.Server(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.ServerClass

classmethod new()¶

Returns:: a new Ags.Server
Return type:: Ags.Server

Instantiate Ags.Server.

New in version 3.0.0.

add_controller(controller)¶

Parameters:: controller (GObject.Object) – the Ags.Controller

Add controller to self.

New in version 3.0.0.

listen()¶

Returns:: True as a new connection was initiated, otherwise False
Return type:: bool

Listen as server.

New in version 3.0.0.

remove_controller(controller)¶

Parameters:: controller (GObject.Object) – the Ags.Controller

Remove controller from self.

New in version 3.0.0.

set_flags(flags)¶

Parameters:: flags (Ags.ServerFlags) – see Ags.ServerFlags-enum

Enable a feature of self.

New in version 3.0.0.

start()¶: Start the XMLRPC-C abyss server.

New in version 3.0.0.

stop()¶: Stop the XMLRPC-C abyss server.

New in version 3.0.0.

test_flags(flags)¶

Parameters:: flags (Ags.ServerFlags) – the flags
Returns:: True if flags are set, else False
Return type:: bool

Test flags to be set on self.

New in version 3.0.0.

unset_flags(flags)¶

Parameters:: flags (Ags.ServerFlags) – see Ags.ServerFlags-enum

Disable a feature of self.

New in version 3.0.0.

do_listen() virtual¶

Returns:: True as a new connection was initiated, otherwise False
Return type:: bool

Listen as server.

New in version 3.0.0.

do_start() virtual¶: Start the XMLRPC-C abyss server.

New in version 3.0.0.

do_stop() virtual¶: Stop the XMLRPC-C abyss server.

New in version 3.0.0.

Signal Details¶

Ags.Server.signals.listen(server)¶

Signal Name:: listen
Flags:: RUN_LAST
Parameters:: server (Ags.Server) – The object which received the signal
Returns:: True as a new connection was initiated, otherwise False
Return type:: bool

The ::listen signal is emited during listen of server.

New in version 3.0.0.

Ags.Server.signals.start(server)¶

Signal Name:: start
Flags:: RUN_LAST
Parameters:: server (Ags.Server) – The object which received the signal

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

New in version 3.0.0.

Ags.Server.signals.stop(server)¶

Signal Name:: stop
Flags:: RUN_LAST
Parameters:: server (Ags.Server) – The object which received the signal

The ::stop signal is emitted as the server stops.

New in version 3.0.0.

Property Details¶

Ags.Server.props.controller¶

Name:: controller
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned Ags.Controller providing default settings.

New in version 3.0.0.

Ags.Server.props.domain¶

Name:: domain
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The domain to use.

New in version 3.0.0.

Ags.Server.props.front_controller¶

Name:: front-controller
Type:: Ags.FrontController
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned Ags.FrontController.

New in version 3.0.0.

Ags.Server.props.ip4¶

Name:: ip4
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The IPv4 address as string of the server.

New in version 3.0.0.

Ags.Server.props.ip6¶

Name:: ip6
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The IPv6 address as string of the server.

New in version 3.0.0.

Ags.Server.props.path¶

Name:: path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The path to use.

New in version 4.0.0.

Ags.Server.props.realm¶

Name:: realm
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The realm to use.

New in version 3.0.0.

Ags.Server.props.server_port¶

Name:: server-port
Type:: int
Default Value:: 8080
Flags:: READABLE, WRITABLE

The server port to use.

New in version 3.0.0.