gupnp-context.xml

另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协议

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GUPnPContext">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPContext.top_of_page">GUPnPContext</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPContext</refname>
<refpurpose>Context object wrapping shared networking bits.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="GUPnPContext.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GUPnPContext-struct">GUPnPContext</link>;
<link linkend="GUPnPContext">GUPnPContext</link>*       <link linkend="gupnp-context-new">gupnp_context_new</link>                   (<link linkend="GMainContext">GMainContext</link> *main_context,
                                                         const <link linkend="char">char</link> *host_ip,
                                                         <link linkend="guint">guint</link> port,
                                                         <link linkend="GError">GError</link> **error);
const <link linkend="char">char</link>*         <link linkend="gupnp-context-get-host-ip">gupnp_context_get_host_ip</link>           (<link linkend="GUPnPContext">GUPnPContext</link> *context);
<link linkend="guint">guint</link>               <link linkend="gupnp-context-get-port">gupnp_context_get_port</link>              (<link linkend="GUPnPContext">GUPnPContext</link> *context);
<link linkend="SoupServer">SoupServer</link>*         <link linkend="gupnp-context-get-server">gupnp_context_get_server</link>            (<link linkend="GUPnPContext">GUPnPContext</link> *context);
<link linkend="void">void</link>                <link linkend="gupnp-context-set-subscription-timeout">gupnp_context_set_subscription_timeout</link>
                                                        (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         <link linkend="guint">guint</link> timeout);
<link linkend="guint">guint</link>               <link linkend="gupnp-context-get-subscription-timeout">gupnp_context_get_subscription_timeout</link>
                                                        (<link linkend="GUPnPContext">GUPnPContext</link> *context);
<link linkend="void">void</link>                <link linkend="gupnp-context-host-path">gupnp_context_host_path</link>             (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *local_path,
                                                         const <link linkend="char">char</link> *server_path);
<link linkend="void">void</link>                <link linkend="gupnp-context-unhost-path">gupnp_context_unhost_path</link>           (<link linkend="GUPnPContext">GUPnPContext</link> *context,
                                                         const <link linkend="char">char</link> *server_path);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GUPnPContext.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GSSDPClient">GSSDPClient</link>
         +----GUPnPContext
</synopsis>

</refsect1>





<refsect1 id="GUPnPContext.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPContext--host-ip">host-ip</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
  &quot;<link linkend="GUPnPContext--port">port</link>&quot;                     <link linkend="guint">guint</link>                 : Read / Write / Construct Only
  &quot;<link linkend="GUPnPContext--server">server</link>&quot;                   <link linkend="SoupServer">SoupServer</link>*           : Read
  &quot;<link linkend="GUPnPContext--subscription-timeout">subscription-timeout</link>&quot;     <link linkend="guint">guint</link>                 : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="GUPnPContext.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GUPnPContext"><type>GUPnPContext</type></link> wraps the networking bits that are used by the various
GUPnP classes. It automatically starts a web server on demand.
</para>
<para>
For debugging, it is possible to see the messages being sent and received by
exporting <link linkend="GUPNP-DEBUG:CAPS"><type>GUPNP_DEBUG</type></link>.</para>
<para>

</para>
</refsect1>

<refsect1 id="GUPnPContext.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GUPnPContext-struct" role="struct">
<title>GUPnPContext</title>
<indexterm zone="GUPnPContext-struct"><primary>GUPnPContext</primary></indexterm><programlisting>typedef struct _GUPnPContext GUPnPContext;</programlisting>
<para>
This struct contains private data only, and should be accessed using the
functions below.</para>
<para>

</para></refsect2>
<refsect2 id="gupnp-context-new" role="function">
<title>gupnp_context_new ()</title>
<indexterm zone="gupnp-context-new"><primary>gupnp_context_new</primary></indexterm><programlisting><link linkend="GUPnPContext">GUPnPContext</link>*       gupnp_context_new                   (<link linkend="GMainContext">GMainContext</link> *main_context,
                                                         const <link linkend="char">char</link> *host_ip,
                                                         <link linkend="guint">guint</link> port,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Create a new <link linkend="GUPnPContext"><type>GUPnPContext</type></link> with the specified <parameter>main_context</parameter>, <parameter>host_ip</parameter> and <parameter>port</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>main_context</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GMainContext"><type>GMainContext</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default one
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>host_ip</parameter>&nbsp;:</term>
<listitem><simpara> The local host's IP address, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the IP address
of the first non-loopback network interface.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>port</parameter>&nbsp;:</term>
<listitem><simpara> Port to run on, or 0 if you don't care what port is used.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> A location to store a <link linkend="GError"><type>GError</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="GUPnPContext"><type>GUPnPContext</type></link> object, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on an error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-context-get-host-ip" role="function">
<title>gupnp_context_get_host_ip ()</title>
<indexterm zone="gupnp-context-get-host-ip"><primary>gupnp_context_get_host_ip</primary></indexterm><programlisting>const <link linkend="char">char</link>*         gupnp_context_get_host_ip           (<link linkend="GUPnPContext">GUPnPContext</link> *context);</programlisting>
<para>
Get the IP address we advertise ourselves as using.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GUPnPContext"><type>GUPnPContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The IP address. This string should not be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gupnp-context-get-port" role="function">
<title>gupnp_context_get_port ()</title>
<indexterm zone="gupnp-context-get-port"><primary>gupnp_context_get_port</primary></indexterm><programlisting><link linkend="guint">guint</link>               gupnp_context_get_port              (<link linkend="GUPnPContext">GUPnPContext</link> *context);</programlisting>
<para>
Get the port that the SOAP server is running on.</para>
<para>

</para><variablelist role="params">