![]() |
![]() |
![]() |
libsoup Reference Manual | ![]() |
---|---|---|---|---|
SoupServer; SoupServer* soup_server_new (const char *optname1, ...); gboolean soup_server_is_https (SoupServer *server); guint soup_server_get_port (SoupServer *server); SoupSocket* soup_server_get_listener (SoupServer *server); void soup_server_run (SoupServer *server); void soup_server_run_async (SoupServer *server); void soup_server_quit (SoupServer *server); GMainContext* soup_server_get_async_context (SoupServer *server); void (*SoupServerCallback) (SoupServer *server, SoupMessage *msg, const char *path, GHashTable *query, SoupClientContext *client, gpointer user_data); void soup_server_add_handler (SoupServer *server, const char *path, SoupServerCallback callback, gpointer user_data, GDestroyNotify destroy); void soup_server_remove_handler (SoupServer *server, const char *path); typedef SoupClientContext; SoupSocket* soup_client_context_get_socket (SoupClientContext *client); SoupAddress* soup_client_context_get_address (SoupClientContext *client); const char* soup_client_context_get_host (SoupClientContext *client); SoupAuthDomain* soup_client_context_get_auth_domain (SoupClientContext *client); const char* soup_client_context_get_auth_user (SoupClientContext *client); void soup_server_add_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain); void soup_server_remove_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain); void soup_server_pause_message (SoupServer *server, SoupMessage *msg); void soup_server_unpause_message (SoupServer *server, SoupMessage *msg); #define SOUP_SERVER_PORT #define SOUP_SERVER_INTERFACE #define SOUP_SERVER_SSL_CERT_FILE #define SOUP_SERVER_SSL_KEY_FILE #define SOUP_SERVER_ASYNC_CONTEXT #define SOUP_SERVER_RAW_PATHS #define SOUP_SERVER_SERVER_HEADER
SoupServer implements a simple HTTP server.
To begin, create a server using soup_server_new()
. Add at least one
handler by calling soup_server_add_handler()
; the handler will be
called to process any requests underneath the path passed to
soup_server_add_handler()
. (If you want all requests to go to the
same handler, just pass "/" (or NULL
) for the path.) Any request
that does not match any handler will automatically be returned to
the client with a 404 (Not Found) status.
To add authentication to some or all paths, create an appropriate SoupAuthDomain (qv), and add it to the server via soup_server_add_auth_domain.
Additional processing options are available via SoupServer's signals; Connect to "request-started" to be notified every time a new request is being processed. (This gives you a chance to connect to the SoupMessage "got-" signals in case you want to do processing before the body has been fully read.)
Once the server is set up, start it processing connections by
calling soup_server_run_async()
or soup_server_run()
. SoupServer
runs via the glib main loop; if you need to have a server that runs
in another thread (or merely isn't bound to the default main loop),
create a GMainContext for it to use, and set that via the
SOUP_SERVER_ASYNC_CONTEXT property.
SoupServer* soup_server_new (const char *optname1, ...);
Creates a new SoupServer.
optname1 : |
name of first property to set |
... : |
value of optname1 , followed by additional property/value pairs
|
Returns : | a new SoupServer |
gboolean soup_server_is_https (SoupServer *server);
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.
server : |
a SoupServer |
Returns : | TRUE if server is serving https.
|
guint soup_server_get_port (SoupServer *server);
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
).
server : |
a SoupServer |
Returns : | the port server is listening on.
|
SoupSocket* soup_server_get_listener (SoupServer *server);
Gets server
's listening socket. You should treat this as
read-only; writing to it or modifiying it may cause server
to
malfunction.
server : |
a SoupServer |
Returns : | the listening socket. |
void soup_server_run (SoupServer *server);
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.
server : |
a SoupServer |
void soup_server_run_async (SoupServer *server);
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.
server : |
a SoupServer |
void soup_server_quit (SoupServer *server);
Stops processing for server
. Call this to clean up after
soup_server_run_async()
, or to terminate a call to soup_server_run()
.
server
is still in a working state after this call; you can start
and stop a server as many times as you want.
server : |
a SoupServer |
GMainContext* soup_server_get_async_context (SoupServer *server);
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.
server : |
a SoupServer |
Returns : | server 's GMainContext, which may be NULL
|
void (*SoupServerCallback) (SoupServer *server, SoupMessage *msg, const char *path, GHashTable *query, SoupClientContext *client, gpointer user_data);
A callback used to handle requests to a SoupServer. The callback
will be invoked after receiving the request body; msg
's method
,
request_headers
, and request_body
fields will be filled in.
path
and query
contain the likewise-named components of the
Request-URI, subject to certain assumptions. By default,
SoupServer decodes all percent-encoding in the URI path, such that
"/foo%2Fbar" is treated the same as "/foo/bar". If your
server is serving resources in some non-POSIX-filesystem namespace,
you may want to distinguish those as two distinct paths. In that
case, you can set the SOUP_SERVER_RAW_PATHS
property when creating
the SoupServer, and it will leave those characters undecoded. (You
may want to call soup_uri_normalize()
to decode any percent-encoded
characters that you aren't handling specially.)
query
contains the query component of the Request-URI parsed
according to the rules for HTML form handling. Although this is the
only commonly-used query string format in HTTP, there is nothing
that actually requires that HTTP URIs use that format; if your
server needs to use some other format, you can just ignore query
,
and call soup_message_get_uri()
and parse the URI's query field
yourself.
After determining what to do with the request, the callback must at
a minimum call soup_message_set_status()
(or
soup_message_set_status_full()
) on msg
to set the response status
code. Additionally, it may set response headers and/or fill in the
response body.
If the callback cannot fully fill in the response before returning
(eg, if it needs to wait for information from a database, or
another network server), it should call soup_server_pause_message()
to tell SoupServer to not send the response right away. When the
response is ready, call soup_server_unpause_message()
to cause it
to be sent.
To send the response body a bit at a time using "chunked" encoding,
first call soup_message_headers_set_encoding()
to set
SOUP_ENCODING_CHUNKED
on the response_headers
. Then call
soup_message_body_append()
(or soup_message_body_append_buffer()
)
to append each chunk as it becomes ready, and
soup_server_unpause_message()
to make sure it's running. (The
server will automatically pause the message if it is using chunked
encoding but no more chunks are available.) When you are done, call
soup_message_body_complete()
to indicate that no more chunks are
coming.
server : |
the SoupServer |
msg : |
the message being processed |
path : |
the path component of msg 's Request-URI
|
query : |
the parsed query component of msg 's Request-URI
|
client : |
additional contextual information about the client |
user_data : |
the data passed to soup_server_add_handler
|
void soup_server_add_handler (SoupServer *server, const char *path, SoupServerCallback callback, gpointer user_data, GDestroyNotify destroy);
Adds a handler to server
for requests under path
. See the
documentation for SoupServerCallback for information about
how callbacks should behave.
server : |
a SoupServer |
path : |
the toplevel path for the handler |
callback : |
callback to invoke for requests under path
|
user_data : |
data for callback
|
destroy : |
destroy notifier to free user_data
|
void soup_server_remove_handler (SoupServer *server, const char *path);
Removes the handler registered at path
.
server : |
a SoupServer |
path : |
the toplevel path for the handler |
typedef struct SoupClientContext SoupClientContext;
A SoupClientContext provides additional information about the
client making a particular request. In particular, you can use
soup_client_context_get_auth_domain()
and
soup_client_context_get_auth_user()
to determine if HTTP
authentication was used successfully.
soup_client_context_get_address()
and/or
soup_client_context_get_host()
can be used to get information for
logging or debugging purposes. soup_client_context_get_socket()
may
also be of use in some situations (eg, tracking when multiple
requests are made on the same connection).
SoupSocket* soup_client_context_get_socket (SoupClientContext *client);
Retrieves the SoupSocket that client
is associated with.
If you are using this method to observe when multiple requests are made on the same persistent HTTP connection (eg, as the ntlm-test test program does), you will need to pay attention to socket destruction as well (either by using weak references, or by connecting to the "disconnected" signal), so that you do not get fooled when the allocator reuses the memory address of a previously-destroyed socket to represent a new socket.
client : |
a SoupClientContext |
Returns : | the SoupSocket that client is associated with.
|
SoupAddress* soup_client_context_get_address (SoupClientContext *client);
Retrieves the SoupAddress associated with the remote end of a connection.
client : |
a SoupClientContext |
Returns : | the SoupAddress associated with the remote end of a connection. |
const char* soup_client_context_get_host (SoupClientContext *client);
Retrieves the IP address associated with the remote end of a
connection. (If you want the actual hostname, you'll have to call
soup_client_context_get_address()
and then call the appropriate
SoupAddress method to resolve it.)
client : |
a SoupClientContext |
Returns : | the IP address associated with the remote end of a connection. |
SoupAuthDomain* soup_client_context_get_auth_domain (SoupClientContext *client);
Checks whether the request associated with client
has been
authenticated, and if so returns the SoupAuthDomain that
authenticated it.
client : |
a SoupClientContext |
Returns : | a SoupAuthDomain, or NULL if the request was not
authenticated.
|
const char* soup_client_context_get_auth_user (SoupClientContext *client);
Checks whether the request associated with client
has been
authenticated, and if so returns the username that the client
authenticated as.
client : |
a SoupClientContext |
Returns : | the authenticated-as user, or NULL if the request
was not authenticated.
|
void soup_server_add_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain);
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.
server : |
a SoupServer |
auth_domain : |
a SoupAuthDomain |
void soup_server_remove_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain);
Removes auth_domain
from server
.
server : |
a SoupServer |
auth_domain : |
a SoupAuthDomain |
void soup_server_pause_message (SoupServer *server, SoupMessage *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.
server : |
a SoupServer |
msg : |
a SoupMessage associated with server .
|
void soup_server_unpause_message (SoupServer *server, SoupMessage *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.
server : |
a SoupServer |
msg : |
a SoupMessage associated with server .
|
#define SOUP_SERVER_PORT "port"
Alias for the "port" property. (The port the server listens on.)
#define SOUP_SERVER_INTERFACE "interface"
Alias for the "interface" property. (The address of the network interface the server listens on.)
#define SOUP_SERVER_SSL_CERT_FILE "ssl-cert-file"
Alias for the "ssl-cert-file" property. (The file containing the SSL certificate for the server.)
#define SOUP_SERVER_SSL_KEY_FILE "ssl-key-file"
Alias for the "ssl-key-file" property. (The file containing the SSL certificate key for the server.)
#define SOUP_SERVER_ASYNC_CONTEXT "async-context"
Alias for the "async-context" property. (The server's GMainContext.)
#define SOUP_SERVER_RAW_PATHS "raw-paths"
Alias for the "raw-paths" property. (If TRUE
,
percent-encoding in the Request-URI path will not be
automatically decoded.)