doc/xml/gnome-vfs-standard-callbacks.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-standard-callbacks">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-standard-callbacks</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gnome-vfs-standard-callbacks</refname><refpurpose>standard callbacks for use by gnome-vfs module writers</refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 #define     <link linkend="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION-CAPS">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</link>
  19 #define     <link linkend="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</link>
  20 typedef     <link linkend="GnomeVFSModuleCallbackAuthenticationOut">GnomeVFSModuleCallbackAuthenticationOut</link>;
  21 #define     <link linkend="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</link>
  22 typedef     <link linkend="GnomeVFSModuleCallbackAdditionalHeadersIn">GnomeVFSModuleCallbackAdditionalHeadersIn</link>;
  23 typedef     <link linkend="GnomeVFSModuleCallbackAdditionalHeadersOut">GnomeVFSModuleCallbackAdditionalHeadersOut</link>;
  24 #define     <link linkend="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</link>
  25 typedef     <link linkend="GnomeVFSModuleCallbackReceivedHeadersIn">GnomeVFSModuleCallbackReceivedHeadersIn</link>;
  26 typedef     <link linkend="GnomeVFSModuleCallbackReceivedHeadersOut">GnomeVFSModuleCallbackReceivedHeadersOut</link>;
  27 #define     <link linkend="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE-CAPS">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</link>
  28 typedef     <link linkend="GnomeVFSModuleCallbackStatusMessageIn">GnomeVFSModuleCallbackStatusMessageIn</link>;
  29 typedef     <link linkend="GnomeVFSModuleCallbackStatusMessageOut">GnomeVFSModuleCallbackStatusMessageOut</link>;
  30 </synopsis>
  31 </refsynopsisdiv>
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41 <refsect1>
  42 <title>Description</title>
  43 <para>
  44
  45 </para>
  46 </refsect1>
  47
  48 <refsect1>
  49 <title>Details</title>
  50 <refsect2>
  51 <title><anchor id="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION-CAPS"/>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</title>
  52 <indexterm><primary>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"
  53 </programlisting>
  54 <para>
  55
  56 </para></refsect2>
  57 <refsect2>
  58 <title><anchor id="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION-CAPS"/>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</title>
  59 <indexterm><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"
  60 </programlisting>
  61 <para>
  62
  63 </para></refsect2>
  64 <refsect2>
  65 <title><anchor id="GnomeVFSModuleCallbackAuthenticationOut"/>GnomeVFSModuleCallbackAuthenticationOut</title>
  66 <indexterm><primary>GnomeVFSModuleCallbackAuthenticationOut</primary></indexterm><programlisting>typedef struct {
  67         char *username;         /* will be freed by g_free,
  68                                  * NULL indicates no auth should be provided;
  69                                  * if the request requires authn, the operation
  70                                  * will fail with a GNOME_VFS_ERROR_ACCESS_DENIED
  71                                  * code
  72                                  */
  73         char *password;         /* will be freed by g_free */
  74
  75         /* Reserved "padding" to avoid future breaks in ABI compatibility */
  76         void *reserved1;
  77         void *reserved2;
  78
  79 } GnomeVFSModuleCallbackAuthenticationOut;
  80 </programlisting>
  81 <para>
  82
  83 </para></refsect2>
  84 <refsect2>
  85 <title><anchor id="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS-CAPS"/>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</title>
  86 <indexterm><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"
  87 </programlisting>
  88 <para>
  89
  90 </para></refsect2>
  91 <refsect2>
  92 <title><anchor id="GnomeVFSModuleCallbackAdditionalHeadersIn"/>GnomeVFSModuleCallbackAdditionalHeadersIn</title>
  93 <indexterm><primary>GnomeVFSModuleCallbackAdditionalHeadersIn</primary></indexterm><programlisting>typedef struct {
  94         GnomeVFSURI *uri;               /* URI of operation */
  95
  96         /* Reserved "padding" to avoid future breaks in ABI compatibility */
  97         void *reserved1;
  98         void *reserved2;
  99 } GnomeVFSModuleCallbackAdditionalHeadersIn;
 100 </programlisting>
 101 <para>
 102
 103 </para></refsect2>
 104 <refsect2>
 105 <title><anchor id="GnomeVFSModuleCallbackAdditionalHeadersOut"/>GnomeVFSModuleCallbackAdditionalHeadersOut</title>
 106 <indexterm><primary>GnomeVFSModuleCallbackAdditionalHeadersOut</primary></indexterm><programlisting>typedef struct {
 107         GList *headers;                 /* list of headers, will be freeed */
 108
 109         /* Reserved "padding" to avoid future breaks in ABI compatibility */
 110         void *reserved1;
 111         void *reserved2;
 112 } GnomeVFSModuleCallbackAdditionalHeadersOut;
 113 </programlisting>
 114 <para>
 115
 116 </para></refsect2>
 117 <refsect2>
 118 <title><anchor id="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS-CAPS"/>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</title>
 119 <indexterm><primary>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"
 120 </programlisting>
 121 <para>
 122
 123 </para></refsect2>
 124 <refsect2>
 125 <title><anchor id="GnomeVFSModuleCallbackReceivedHeadersIn"/>GnomeVFSModuleCallbackReceivedHeadersIn</title>
 126 <indexterm><primary>GnomeVFSModuleCallbackReceivedHeadersIn</primary></indexterm><programlisting>typedef struct {
 127         GnomeVFSURI *uri;               /* URI of operation */
 128         GList *headers;                 /* list of headers */
 129
 130         /* Reserved "padding" to avoid future breaks in ABI compatibility */
 131         void *reserved1;
 132         void *reserved2;
 133 } GnomeVFSModuleCallbackReceivedHeadersIn;
 134 </programlisting>
 135 <para>
 136
 137 </para></refsect2>
 138 <refsect2>
 139 <title><anchor id="GnomeVFSModuleCallbackReceivedHeadersOut"/>GnomeVFSModuleCallbackReceivedHeadersOut</title>
 140 <indexterm><primary>GnomeVFSModuleCallbackReceivedHeadersOut</primary></indexterm><programlisting>typedef struct {
 141         int dummy;
 142
 143         /* Reserved "padding" to avoid future breaks in ABI compatibility */
 144         void *reserved1;
 145         void *reserved2;
 146 } GnomeVFSModuleCallbackReceivedHeadersOut;
 147 </programlisting>
 148 <para>
 149
 150 </para></refsect2>
 151 <refsect2>
 152 <title><anchor id="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE-CAPS"/>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</title>
 153 <indexterm><primary>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</primary></indexterm><programlisting>#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"
 154 </programlisting>
 155 <para>
 156
 157 </para></refsect2>
 158 <refsect2>
 159 <title><anchor id="GnomeVFSModuleCallbackStatusMessageIn"/>GnomeVFSModuleCallbackStatusMessageIn</title>
 160 <indexterm><primary>GnomeVFSModuleCallbackStatusMessageIn</primary></indexterm><programlisting>typedef struct {
 161         char *uri;              /* Full URI of operation */
 162         char *message;          /* A message indicating the current state or
 163                                  * NULL if there is no message */
 164         int percentage;         /* Percentage indicating completeness 0-100 or
 165                                  * -1 if there is no progress percentage to
 166                                  * report */
 167
 168         /* Reserved "padding" to avoid future breaks in ABI compatibility */
 169         void *reserved1;
 170         void *reserved2;
 171 } GnomeVFSModuleCallbackStatusMessageIn;
 172 </programlisting>
 173 <para>
 174
 175 </para></refsect2>
 176 <refsect2>
 177 <title><anchor id="GnomeVFSModuleCallbackStatusMessageOut"/>GnomeVFSModuleCallbackStatusMessageOut</title>
 178 <indexterm><primary>GnomeVFSModuleCallbackStatusMessageOut</primary></indexterm><programlisting>typedef struct {
 179         int dummy; /* empty structs not allowed */
 180
 181         /* Reserved "padding" to avoid future breaks in ABI compatibility */
 182         void *reserved1;
 183         void *reserved2;
 184 } GnomeVFSModuleCallbackStatusMessageOut;
 185 </programlisting>
 186 <para>
 187
 188 </para></refsect2>
 189
 190 </refsect1>
 191
 192
 193
 194
 195 </refentry>