GUPnPContext

GUPnPContext — Context object wrapping shared networking bits.

Synopsis




                    GUPnPContext;
GUPnPContext*       gupnp_context_new                   (GMainContext *main_context,
                                                         const char *host_ip,
                                                         guint port,
                                                         GError **error);
const char*         gupnp_context_get_host_ip           (GUPnPContext *context);
guint               gupnp_context_get_port              (GUPnPContext *context);
void                gupnp_context_set_subscription_timeout
                                                        (GUPnPContext *context,
                                                         guint timeout);
guint               gupnp_context_get_subscription_timeout
                                                        (GUPnPContext *context);
void                gupnp_context_host_path             (GUPnPContext *context,
                                                         const char *local_path,
                                                         const char *server_path);
void                gupnp_context_unhost_path           (GUPnPContext *context,
                                                         const char *server_path);


Description

GUPnPContext wraps the networking bits that are used by the various GUPnP classes. It automatically starts a web server on demand.

Details

GUPnPContext

typedef struct {
        GSSDPClient parent;

        GUPnPContextPrivate *priv;
} GUPnPContext;


gupnp_context_new ()

GUPnPContext*       gupnp_context_new                   (GMainContext *main_context,
                                                         const char *host_ip,
                                                         guint port,
                                                         GError **error);

main_context : A GMainContext, or NULL to use the default one
host_ip : The local host's IP address, or NULL to use the IP address of the first non-loopback network interface.
port : Port to run on, or 0 if you don't care what port is used.
error : A location to store a GError, or NULL
Returns : A new GUPnPContext object.

gupnp_context_get_host_ip ()

const char*         gupnp_context_get_host_ip           (GUPnPContext *context);

context : A GUPnPContext
Returns : The IP address we advertise ourselves as using. Do not free.

gupnp_context_get_port ()

guint               gupnp_context_get_port              (GUPnPContext *context);

context : A GUPnPContext
Returns : The port the SOAP server is running on.

gupnp_context_set_subscription_timeout ()

void                gupnp_context_set_subscription_timeout
                                                        (GUPnPContext *context,
                                                         guint timeout);

Sets the event subscription timeout to timeout. Use 0 if you don't want subscriptions to time out. Note that any client side subscriptions will automatically be renewed.

context : A GUPnPContext
timeout : Event subscription timeout in seconds

gupnp_context_get_subscription_timeout ()

guint               gupnp_context_get_subscription_timeout
                                                        (GUPnPContext *context);

context : A GUPnPContext
Returns : The event subscription timeout in seconds, or 0, meaning no timeout.

gupnp_context_host_path ()

void                gupnp_context_host_path             (GUPnPContext *context,
                                                         const char *local_path,
                                                         const char *server_path);

Start hosting local_path at server_path. Files with the path local_path.LOCALE (if they exist) will be served up when LOCALE is specified in the request's Accept-Language header.

context : A GUPnPContext
local_path : Path to the local file or folder to be hosted
server_path : Web server path where local_path should be hosted

gupnp_context_unhost_path ()

void                gupnp_context_unhost_path           (GUPnPContext *context,
                                                         const char *server_path);

Stop hosting the file or folder at server_path.

context : A GUPnPContext
server_path : Web server path where the file or folder is hosted