gupnp_simple_igd_new ()

GUPnPSimpleIgd *
gupnp_simple_igd_new (void);

This creates a new GUPnpSimpleIgd object using the special GMainContext

gupnp_simple_igd_add_port ()

void
gupnp_simple_igd_add_port (GUPnPSimpleIgd *self,
                           const gchar *protocol,
                           guint16 external_port,
                           const gchar *local_ip,
                           guint16 local_port,
                           guint32 lease_duration,
                           const gchar *description);

This adds a port to the router's forwarding table. The mapping will be automatically refreshed by this object until it is either removed with gupnp_simple_igd_remove_port(), gupnp_simple_igd_remove_port_local() or the object disapears.

If there is a problem, the “error-mapping-port” signal will be emitted. If a router is found and a port is mapped correctly, “mapped-external-port” will be emitted. These signals may be emitted multiple times if there are multiple routers present.

gupnp_simple_igd_remove_port ()

void
gupnp_simple_igd_remove_port (GUPnPSimpleIgd *self,
                              const gchar *protocol,
                              guint external_port);

This tries to remove a port entry from the routers that was previously added with gupnp_simple_igd_add_port(). There is no indicated of success or failure it is a best effort mechanism. If it fails, the bindings will disapears after the lease duration set when the port where added.

gupnp_simple_igd_delete_all_mappings ()

gboolean
gupnp_simple_igd_delete_all_mappings (GUPnPSimpleIgd *self);

Removes all mappings and prevents other from being formed Should only be called by the dispose function of subclasses

gupnp_simple_igd_remove_port_local ()

void
gupnp_simple_igd_remove_port_local (GUPnPSimpleIgd *self,
                                    const gchar *protocol,
                                    const gchar *local_ip,
                                    guint16 local_port);

This tries to remove a port entry from the routers that was previously added with gupnp_simple_igd_add_port(). There is no indicated of success or failure it is a best effort mechanism. If it fails, the bindings will disapears after the lease duration set when the port where added.

struct GUPnPSimpleIgd

struct GUPnPSimpleIgd;

All members are private, access them using methods and properties

GUPnPSimpleIgdClass

typedef struct _GUPnPSimpleIgdClass GUPnPSimpleIgdClass;

add_port : An implementation of the add_port function remove_port : An implementation of the delete_port function remove_local_port : An implementation of the remove_local_port function

The Raw UDP component transmitter class

GUPNP_SIMPLE_IGD_ERROR

#define GUPNP_SIMPLE_IGD_ERROR (gupnp_simple_igd_error_quark ())

The error domain for GUPnP Simple IGD

enum GUPnPSimpleIgdError

Errors coming out of the GUPnPSimpleIGD object.

The “main-context” property

  “main-context”             gpointer

This GMainContext will be used for all async activities.

Flags: Read

The “context-available” signal

gboolean
user_function (GUPnPSimpleIgd *self,
               GObject        *context,
               gpointer        user_data)

This is to allow the application to control which GUPnPContext this client should use. If the application connects to this signal, it controls if a context will be used by changing the return value of the signal handler.

Flags: Run Last

The “error-mapping-port” signal

void
user_function (GUPnPSimpleIgd *self,
               GError         *error,
               gchar          *proto,
               guint           external_port,
               gchar          *local_ip,
               guint           local_port,
               gchar          *description,
               gpointer        user_data)

This means that mapping a port on a specific IGD has failed (it may still succeed on other IGDs on the network).

Flags: Has Details

The “mapped-external-port” signal

void
user_function (GUPnPSimpleIgd *self,
               gchar          *proto,
               gchar          *external_ip,
               gchar          *replaces_external_ip,
               guint           external_port,
               gchar          *local_ip,
               guint           local_port,
               gchar          *description,
               gpointer        user_data)

This signal means that an IGD has been found that that adding a port mapping has succeeded.

Flags: Run Last