Back to Seed Clases

Soup

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Soup.Server

Class Soup.Server

Import line:	Soup = imports.gi.Soup;
GIR File:	Soup-2.4.gir
C documentation:	SoupServer
Class :	Server
Extends:	GObject.Object

Properties
Properties		Defined By
	async_context : void*	Soup.Server
	interface : Soup.Address	Soup.Server
	parent : GObject.Object read only	Soup.Server
	port : guint32	Soup.Server
	raw_paths : gboolean	Soup.Server
	server_header : String	Soup.Server
	ssl_cert_file : String	Soup.Server
	ssl_key_file : String	Soup.Server

Methods / Constructors
Method / Constructor		Defined By
	new Soup.Server (Object *properties) Create a new Soup.Server Create a new Soup.Server Parameters: Object properties*
	add_auth_domain (AuthDomain *auth_domain) : none Adds an authentication domain to server. Adds an authentication domain to server. Each auth domain will have the chance to require authentication for each request that comes in; normally auth domains will require authentication for requests on certain paths that they have been set up to watch, or that meet other criteria set by the caller. If an auth domain determines that a request requires authentication (and the request doesn't contain authentication), server* will automatically reject the request with an appropriate status (401 Unauthorized or 407 Proxy Authentication Required). If the request used the "100-continue" Expectation, server will reject it before the request body is sent. Parameters: Soup.AuthDomain auth_domain Required (not null) a SoupAuthDomain Returns: none	Soup.Server
	add_handler (String *path, Function callback, void *user_data, Function destroy) : none Adds a handler to server* for requests under path. Adds a handler to server for requests under path. See the documentation for SoupServerCallback for information about how callbacks should behave. If path is NULL or "/", then this will be the default handler for all requests that don't have a more specific handler. Note though that if you want to handle requests to the special "" URI, you must explicitly register a handler for ""; the default handler will not be used for that case. Parameters: String path the toplevel path for the handler Function (Server *server, Message msg, String path, Object query, ClientContext client, void *user_data) : none Required (not null) callback to invoke for requests under path* void* user_data Required (not null) data for callback Function (void* *data) : none Required (not null) destroy notifier to free user_data* Returns: none	Soup.Server
	disconnect () : none Stops processing for server and closes its socket. Stops processing for server and closes its socket. This implies the effects of soup_server_quit(), but additionally closes the listening socket. Note that messages currently in progress will continue to be handled, if the main loop associated with the server is resumed or kept running. After calling this function, server is no longer functional, so it has nearly the same effect as destroying server entirely. The function is thus useful mainly for language bindings without explicit control over object lifetime. Returns: none	Soup.Server
	get_async_context () : GLib.MainContext Gets server's async_context. Gets server's async_context. This does not add a ref to the context, so you will need to ref it yourself if you want it to outlive its server. Returns: GLib.MainContext server's GMainContext, which may be NULL	Soup.Server
	get_listener () : Soup.Socket Gets server's listening socket. Gets server's listening socket. You should treat this as read-only; writing to it or modifiying it may cause server to malfunction. Returns: Soup.Socket the listening socket.	Soup.Server
	get_port () : guint32 Gets the TCP port that server is listening on. Gets the TCP port that server is listening on. This is most useful when you did not request a specific port (or explicitly requested SOUP_ADDRESS_ANY_PORT). Returns: guint32 the port server is listening on.	Soup.Server
	is_https () : gboolean Checks whether server is running plain http or https. Checks whether server is running plain http or https. In order for a server to run https, you must set the SOUP_SERVER_SSL_CERT_FILE and SOUP_SERVER_SSL_KEY_FILE properties to provide it with an SSL certificate to use. Returns: gboolean TRUE if server is serving https.	Soup.Server
	pause_message (Message *msg) : none Pauses I/O on msg. Pauses I/O on msg. This can be used when you need to return from the server handler without having the full response ready yet. Use soup_server_unpause_message() to resume I/O. Parameters: Soup.Message msg* Required (not null) a SoupMessage associated with server. Returns: none	Soup.Server
	quit () : none Stops processing for server. Stops processing for server. Call this to clean up after soup_server_run_async(), or to terminate a call to soup_server_run(). and stop a server as many times as you want. Returns: none	Soup.Server
	remove_auth_domain (AuthDomain *auth_domain) : none Removes auth_domain* from server. Removes auth_domain from server. Parameters: Soup.AuthDomain auth_domain Required (not null) a SoupAuthDomain Returns: none	Soup.Server
	remove_handler (String *path) : none Removes the handler registered at path. Removes the handler registered at path. Parameters: String path* Required (not null) the toplevel path for the handler Returns: none	Soup.Server
	run () : none Starts server, causing it to listen for and process incoming connections. Starts server, causing it to listen for and process incoming connections. Unlike soup_server_run_async(), this creates a GMainLoop and runs it, and it will not return until someone calls soup_server_quit() to stop the server. Returns: none	Soup.Server
	run_async () : none Starts server, causing it to listen for and process incoming connections. Starts server, causing it to listen for and process incoming connections. The server actually runs in server's GMainContext. It will not actually perform any processing unless the appropriate main loop is running. In the simple case where you did not set the server's SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run whenever the glib main loop is running. Returns: none	Soup.Server
	unpause_message (Message *msg) : none Resumes I/O on msg. Resumes I/O on msg. Use this to resume after calling soup_server_pause_message(), or after adding a new chunk to a chunked response. I/O won't actually resume until you return to the main loop. Parameters: Soup.Message msg* Required (not null) a SoupMessage associated with server. Returns: none	Soup.Server

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	request_aborted (Server *self, Message object, ClientContext p0) : none Parameters: Soup.Server self* Soup.Message object Soup.ClientContext p0 Returns: {none}	Soup.Server
	request_finished (Server *self, Message object, ClientContext p0) : none Parameters: Soup.Server self* Soup.Message object Soup.ClientContext p0 Returns: {none}	Soup.Server
	request_read (Server *self, Message object, ClientContext p0) : none Parameters: Soup.Server self* Soup.Message object Soup.ClientContext p0 Returns: {none}	Soup.Server
	request_started (Server *self, Message object, ClientContext p0) : none Parameters: Soup.Server self* Soup.Message object Soup.ClientContext p0 Returns: {none}	Soup.Server

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:16:54 GMT+0800 (HKT)