ftp://ftp.redhat.com/pub/redhat/linux/rawhide/SRPMS/SRPMS/gnome-vfs2-2.3.8-1.src.rpm
[gnome-vfs-httpcaptive.git] / doc / html / gnome-vfs-20-gnome-vfs-standard-callbacks.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-standard-callbacks</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
2         .synopsis, .classsynopsis {
3             background: #eeeeee;
4             border: solid 1px #aaaaaa;
5             padding: 0.5em;
6         }
7         .programlisting {
8             background: #eeeeff;
9             border: solid 1px #aaaaff;
10             padding: 0.5em;
11         }
12         .variablelist {
13             padding: 4px;
14             margin-left: 3em;
15         }
16         .navigation {
17             background: #ffeeee;
18             border: solid 1px #ffaaaa;
19             margin-top: 0.5em;
20             margin-bottom: 0.5em;
21         }
22         .navigation a {
23             color: #770000;
24         }
25         .navigation a:visited {
26             color: #550000;
27         }
28         .navigation .title {
29             font-size: 200%;
30         }
31       </style><link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library"><link rel="up" href="ch08.html" title="Other Stuff"><link rel="previous" href="gnome-vfs-20-gnome-vfs-utils.html" title="gnome-vfs-utils"><link rel="next" href="gnome-vfs-20-gnome-vfs-inet-connection.html" title="gnome-vfs-inet-connection"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th><td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-inet-connection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gnome-vfs-20-gnome-vfs-standard-callbacks"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-standard-callbacks</span></h2><p>gnome-vfs-standard-callbacks &#8212; standard callbacks for use by gnome-vfs module writers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
33
34
35 #define     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION-CAPS">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</a>
36 #define     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</a>
37 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationOut">GnomeVFSModuleCallbackAuthenticationOut</a>;
38 #define     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</a>
39 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersIn">GnomeVFSModuleCallbackAdditionalHeadersIn</a>;
40 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersOut">GnomeVFSModuleCallbackAdditionalHeadersOut</a>;
41 #define     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS-CAPS">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</a>
42 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersIn">GnomeVFSModuleCallbackReceivedHeadersIn</a>;
43 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersOut">GnomeVFSModuleCallbackReceivedHeadersOut</a>;
44 #define     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE-CAPS">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</a>
45 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageIn">GnomeVFSModuleCallbackStatusMessageIn</a>;
46 typedef     <a href="gnome-vfs-20-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageOut">GnomeVFSModuleCallbackStatusMessageOut</a>;
47 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
48
49 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION-CAPS"></a>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</h3><a class="indexterm" name="id2997538"></a><pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"
50 </pre><p>
51
52 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION-CAPS"></a>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</h3><a class="indexterm" name="id2997578"></a><pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"
53 </pre><p>
54
55 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackAuthenticationOut"></a>GnomeVFSModuleCallbackAuthenticationOut</h3><a class="indexterm" name="id2997614"></a><pre class="programlisting">typedef struct {
56         char *username;         /* will be freed by g_free,
57                                  * NULL indicates no auth should be provided;
58                                  * if the request requires authn, the operation
59                                  * will fail with a GNOME_VFS_ERROR_ACCESS_DENIED
60                                  * code
61                                  */
62         char *password;         /* will be freed by g_free */
63
64         /* Reserved "padding" to avoid future breaks in ABI compatibility */
65         void *reserved1;
66         void *reserved2;
67
68 } GnomeVFSModuleCallbackAuthenticationOut;
69 </pre><p>
70
71 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS-CAPS"></a>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</h3><a class="indexterm" name="id2997656"></a><pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"
72 </pre><p>
73
74 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackAdditionalHeadersIn"></a>GnomeVFSModuleCallbackAdditionalHeadersIn</h3><a class="indexterm" name="id2997692"></a><pre class="programlisting">typedef struct {
75         GnomeVFSURI *uri;               /* URI of operation */
76
77         /* Reserved "padding" to avoid future breaks in ABI compatibility */
78         void *reserved1;
79         void *reserved2;
80 } GnomeVFSModuleCallbackAdditionalHeadersIn;
81 </pre><p>
82
83 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackAdditionalHeadersOut"></a>GnomeVFSModuleCallbackAdditionalHeadersOut</h3><a class="indexterm" name="id2997729"></a><pre class="programlisting">typedef struct {
84         GList *headers;                 /* list of headers, will be freeed */
85
86         /* Reserved "padding" to avoid future breaks in ABI compatibility */
87         void *reserved1;
88         void *reserved2;
89 } GnomeVFSModuleCallbackAdditionalHeadersOut;
90 </pre><p>
91
92 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS-CAPS"></a>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</h3><a class="indexterm" name="id2997770"></a><pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"
93 </pre><p>
94
95 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackReceivedHeadersIn"></a>GnomeVFSModuleCallbackReceivedHeadersIn</h3><a class="indexterm" name="id2997805"></a><pre class="programlisting">typedef struct {
96         GnomeVFSURI *uri;               /* URI of operation */
97         GList *headers;                 /* list of headers */
98
99         /* Reserved "padding" to avoid future breaks in ABI compatibility */
100         void *reserved1;
101         void *reserved2;
102 } GnomeVFSModuleCallbackReceivedHeadersIn;
103 </pre><p>
104
105 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackReceivedHeadersOut"></a>GnomeVFSModuleCallbackReceivedHeadersOut</h3><a class="indexterm" name="id2997842"></a><pre class="programlisting">typedef struct {
106         int dummy;
107
108         /* Reserved "padding" to avoid future breaks in ABI compatibility */
109         void *reserved1;
110         void *reserved2;
111 } GnomeVFSModuleCallbackReceivedHeadersOut;
112 </pre><p>
113
114 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE-CAPS"></a>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</h3><a class="indexterm" name="id2997878"></a><pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"
115 </pre><p>
116
117 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackStatusMessageIn"></a>GnomeVFSModuleCallbackStatusMessageIn</h3><a class="indexterm" name="id2997914"></a><pre class="programlisting">typedef struct {
118         char *uri;              /* Full URI of operation */
119         char *message;          /* A message indicating the current state or
120                                  * NULL if there is no message */
121         int percentage;         /* Percentage indicating completeness 0-100 or
122                                  * -1 if there is no progress percentage to
123                                  * report */
124
125         /* Reserved "padding" to avoid future breaks in ABI compatibility */
126         void *reserved1;
127         void *reserved2;
128 } GnomeVFSModuleCallbackStatusMessageIn;
129 </pre><p>
130
131 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSModuleCallbackStatusMessageOut"></a>GnomeVFSModuleCallbackStatusMessageOut</h3><a class="indexterm" name="id2997956"></a><pre class="programlisting">typedef struct {
132         int dummy; /* empty structs not allowed */
133
134         /* Reserved "padding" to avoid future breaks in ABI compatibility */
135         void *reserved1;
136         void *reserved2;
137 } GnomeVFSModuleCallbackStatusMessageOut;
138 </pre><p>
139
140 </p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gnome-vfs-20-gnome-vfs-utils.html"><b>&lt;&lt; gnome-vfs-utils</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-inet-connection.html"><b>gnome-vfs-inet-connection &gt;&gt;</b></a></td></tr></table></body></html>