GSSDPClient

GSSDPClient — SSDP "bus" wrapper.

Synopsis

struct              GSSDPClient;
GSSDPClient *       gssdp_client_new                    (GMainContext *main_context,
                                                         const char *iface,
                                                         GError **error);
GMainContext *      gssdp_client_get_main_context       (GSSDPClient *client);
void                gssdp_client_set_server_id          (GSSDPClient *client,
                                                         const char *server_id);
const char *        gssdp_client_get_server_id          (GSSDPClient *client);
const char *        gssdp_client_get_interface          (GSSDPClient *client);
const char *        gssdp_client_get_host_ip            (GSSDPClient *client);
void                gssdp_client_set_network            (GSSDPClient *client,
                                                         const char *network);
const char *        gssdp_client_get_network            (GSSDPClient *client);
gboolean            gssdp_client_get_active             (GSSDPClient *client);

Object Hierarchy

  GObject
   +----GSSDPClient

Implemented Interfaces

GSSDPClient implements GInitable.

Properties

  "active"                   gboolean              : Read / Write
  "host-ip"                  gchar*                : Read
  "interface"                gchar*                : Read / Write / Construct Only
  "main-context"             gpointer              : Read / Write / Construct Only
  "network"                  gchar*                : Read / Write / Construct
  "server-id"                gchar*                : Read / Write
  "socket-ttl"               guint                 : Read / Write / Construct Only

Signals

  "message-received"                               : Run Last

Description

GSSDPClient wraps the SSDP "bus" as used by both GSSDPResourceBrowser and GSSDPResourceGroup.

Details

struct GSSDPClient

struct GSSDPClient;

gssdp_client_new ()

GSSDPClient *       gssdp_client_new                    (GMainContext *main_context,
                                                         const char *iface,
                                                         GError **error);

main_context :

 Deprecated: 0.11.2: Always set to NULL. If you want to specify a context use g_main_context_push_thread_default(). [allow-none]

iface :

 The name of the network interface, or NULL for auto-detection.

error :

 Location to store error, or NULL

Returns :

 A new GSSDPClient object.

gssdp_client_get_main_context ()

GMainContext *      gssdp_client_get_main_context       (GSSDPClient *client);

gssdp_client_set_server_id ()

void                gssdp_client_set_server_id          (GSSDPClient *client,
                                                         const char *server_id);

Sets the server ID of client to server_id.

client :

 A GSSDPClient

server_id :

 The server ID

gssdp_client_get_server_id ()

const char *        gssdp_client_get_server_id          (GSSDPClient *client);

client :

 A GSSDPClient

Returns :

 The server ID.

gssdp_client_get_interface ()

const char *        gssdp_client_get_interface          (GSSDPClient *client);

Get the name of the network interface associated to client.

client :

 A GSSDPClient

Returns :

 The network interface name. This string should not be freed.

gssdp_client_get_host_ip ()

const char *        gssdp_client_get_host_ip            (GSSDPClient *client);

Get the IP address we advertise ourselves as using.

client :

 A GSSDPClient

Returns :

 The IP address. This string should not be freed.

gssdp_client_set_network ()

void                gssdp_client_set_network            (GSSDPClient *client,
                                                         const char *network);

Sets the network identification of client to network.

client :

 A GSSDPClient

network :

 The string identifying the network

gssdp_client_get_network ()

const char *        gssdp_client_get_network            (GSSDPClient *client);

Get the network this client is associated with.

client :

 A GSSDPClient

Returns :

 The network identification. This string should not be freed.

gssdp_client_get_active ()

gboolean            gssdp_client_get_active             (GSSDPClient *client);

client :

 A GSSDPClient

Returns :

 TRUE if client is active, FALSE otherwise.

Property Details

The "active" property

  "active"                   gboolean              : Read / Write

Whether this client is active or not (passive). When active (default), the client sends messages on the network, otherwise not. In most cases, you don't want to touch this property.

Default value: TRUE

The "host-ip" property

  "host-ip"                  gchar*                : Read

The IP address of the assoicated network interface.

Default value: NULL

The "interface" property

  "interface"                gchar*                : Read / Write / Construct Only

The name of the network interface this client is associated with. Set to NULL to autodetect.

Default value: NULL

The "main-context" property

  "main-context"             gpointer              : Read / Write / Construct Only

Warning

GSSDPClient:main-context has been deprecated since version 0.11.2 and should not be used in newly-written code. Use g_main_context_push_thread_default().

The GMainContext to use. Set to NULL to use the default.

The "network" property

  "network"                  gchar*                : Read / Write / Construct

The network this client is currently connected to. You could set this to anything you want to identify the network this client is associated with. If you are using GUPnPContextManager and associated interface is a WiFi interface, this property is set to the ESSID of the network. Otherwise, expect this to be the network IP address by default.

Default value: NULL

The "server-id" property

  "server-id"                gchar*                : Read / Write

The SSDP server's identifier.

Default value: NULL

The "socket-ttl" property

  "socket-ttl"               guint                 : Read / Write / Construct Only

Time-to-live value to use for all sockets created by this client. If not set (or set to 0) the value recommended by UPnP will be used. This property can only be set during object construction.

Allowed values: <= 255

Default value: 0

Signal Details

The "message-received" signal

void                user_function                      (GSSDPClient *arg0,
                                                        gchar       *arg1,
                                                        guint        arg2,
                                                        gint         arg3,
                                                        gpointer     arg4,
                                                        gpointer     user_data)      : Run Last

Internal signal.

user_data :

 user data set when the signal handler was connected.

Stability Level: Private

Generated by GTK-Doc V1.18.1