source-git / libgdata

Clone
Source Code
GIT

Files

  1.   f44c28bddb28f45ab9e064328a87bd104cb56ad7
  2.   docs
  3.   reference
  4.   html
  5.   GDataUploadStream.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataUploadStream: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch02.html" title="Core API">
<link rel="prev" href="GDataDownloadStream.html" title="GDataDownloadStream">
<link rel="next" href="GDataComparable.html" title="GDataComparable">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GDataUploadStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataUploadStream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataUploadStream.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataDownloadStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataComparable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataUploadStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataUploadStream.top_of_page"></a>GDataUploadStream</span></h2>
<p>GDataUploadStream — GData upload stream object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataUploadStream.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataUploadStream.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GOutputStream</span> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()">gdata_upload_stream_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GOutputStream</span> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-new-resumable" title="gdata_upload_stream_new_resumable ()">gdata_upload_stream_new_resumable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-response" title="gdata_upload_stream_get_response ()">gdata_upload_stream_get_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GDataService.html" title="GDataService"><span class="returnvalue">GDataService</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-service" title="gdata_upload_stream_get_service ()">gdata_upload_stream_get_service</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="returnvalue">GDataAuthorizationDomain</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-authorization-domain" title="gdata_upload_stream_get_authorization_domain ()">gdata_upload_stream_get_authorization_domain</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GCancellable</span> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-cancellable" title="gdata_upload_stream_get_cancellable ()">gdata_upload_stream_get_cancellable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-method" title="gdata_upload_stream_get_method ()">gdata_upload_stream_get_method</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-upload-uri" title="gdata_upload_stream_get_upload_uri ()">gdata_upload_stream_get_upload_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GDataEntry.html" title="GDataEntry"><span class="returnvalue">GDataEntry</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-entry" title="gdata_upload_stream_get_entry ()">gdata_upload_stream_get_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-slug" title="gdata_upload_stream_get_slug ()">gdata_upload_stream_get_slug</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-content-type" title="gdata_upload_stream_get_content_type ()">gdata_upload_stream_get_content_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-content-length" title="gdata_upload_stream_get_content_length ()">gdata_upload_stream_get_content_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataUploadStream.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--authorization-domain" title="The “authorization-domain” property">authorization-domain</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GCancellable</span> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title="The “cancellable” property">cancellable</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--content-length" title="The “content-length” property">content-length</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--content-type" title="The “content-type” property">content-type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--entry" title="The “entry” property">entry</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--method" title="The “method” property">method</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--service" title="The “service” property">service</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--slug" title="The “slug” property">slug</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream--upload-uri" title="The “upload-uri” property">upload-uri</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataUploadStream.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataUploadStream.html#GDATA-LINK-RESUMABLE-CREATE-MEDIA:CAPS" title="GDATA_LINK_RESUMABLE_CREATE_MEDIA">GDATA_LINK_RESUMABLE_CREATE_MEDIA</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataUploadStream.html#GDATA-LINK-RESUMABLE-EDIT-MEDIA:CAPS" title="GDATA_LINK_RESUMABLE_EDIT_MEDIA">GDATA_LINK_RESUMABLE_EDIT_MEDIA</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataUploadStream.html#GDataUploadStream-struct" title="GDataUploadStream">GDataUploadStream</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataUploadStream.html#GDataUploadStreamClass" title="GDataUploadStreamClass">GDataUploadStreamClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataUploadStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GOutputStream
        <span class="lineart">╰──</span> GDataUploadStream
</pre>
</div>
<div class="refsect1">
<a name="GDataUploadStream.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/gdata-upload-stream.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataUploadStream.description"></a><h2>Description</h2>
<p><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> is a <span class="type">GOutputStream</span> subclass to allow uploading of files from GData services with authorization from a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> under
the given <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>. If authorization is not required to perform the upload, a <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> doesn't have to be
specified.</p>
<p>Once a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> is instantiated with <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>, the standard <span class="type">GOutputStream</span> API can be used on the stream to upload
the file. Network communication may not actually begin until the first call to <code class="function">g_output_stream_write()</code>, so having a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> around is no
guarantee that data is being uploaded.</p>
<p>Uploads of a file, or a file with associated metadata (a <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a>) should use <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>, but if you want to simply upload a single
<a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a>, use <a class="link" href="GDataService.html#gdata-service-insert-entry" title="gdata_service_insert_entry ()"><code class="function">gdata_service_insert_entry()</code></a> instead. <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> is for large streaming uploads.</p>
<p>Once an upload is complete, the server's response can be retrieved from the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> using <a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-response" title="gdata_upload_stream_get_response ()"><code class="function">gdata_upload_stream_get_response()</code></a>. In order
for network communication to be guaranteed to have stopped (and thus the response definitely available), <code class="function">g_output_stream_close()</code> must be called
on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> first. Otherwise, <a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-response" title="gdata_upload_stream_get_response ()"><code class="function">gdata_upload_stream_get_response()</code></a> may return saying that the operation is still in progress.</p>
<p>If the server returns an error instead of a success response, the error will be returned by <code class="function">g_output_stream_close()</code> as a <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a>.</p>
<p>The entire upload operation can be cancelled using the <span class="type">GCancellable</span> instance provided to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>, or returned by
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-cancellable" title="gdata_upload_stream_get_cancellable ()"><code class="function">gdata_upload_stream_get_cancellable()</code></a>. Cancelling this at any time will cause all future <span class="type">GOutputStream</span> method calls to return
<code class="literal">G_IO_ERROR_CANCELLED</code>. If any <span class="type">GOutputStream</span> methods are in the process of being called, they will be cancelled and return <code class="literal">G_IO_ERROR_CANCELLED</code> as
soon as possible.</p>
<p>Note that cancelling an individual method call (such as a call to <code class="function">g_output_stream_write()</code>) using the <span class="type">GCancellable</span> parameter of the method will not
cancel the upload as a whole — just that particular method call. In the case of <code class="function">g_output_stream_write()</code>, this will cause it to return the number of
bytes it has successfully written up to the point of cancellation (up to the requested number of bytes), or return a <code class="literal">G_IO_ERROR_CANCELLED</code> if it
had not managed to write any bytes to the network by that point. This is also the behaviour of <code class="function">g_output_stream_write()</code> when the upload operation as
a whole is cancelled.</p>
<p>In the case of <code class="function">g_output_stream_close()</code>, the call will return immediately if network activity hasn't yet started. If it has, the network activity
will be cancelled, regardless of whether the call to <code class="function">g_output_stream_close()</code> is cancelled. Cancelling a pending call to <code class="function">g_output_stream_close()</code>
(either using the method's <span class="type">GCancellable</span>, or by cancelling the upload stream as a whole) will cause it to stop waiting for the network activity to
finish, and return <code class="literal">G_IO_ERROR_CANCELLED</code> immediately. Network activity will continue to be shut down in the background.</p>
<p>Any outstanding data is guaranteed to be written to the network successfully even if a call to <code class="function">g_output_stream_close()</code> is cancelled. However, if
the upload stream as a whole is cancelled using <a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title="The “cancellable” property"><span class="type">“cancellable”</span></a>, no more data will be sent over the network, and the network
connection will be closed immediately. i.e. <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will do its best to instruct the server to cancel the upload and any associated
server-side changes of state.</p>
<p>If the server returns an error message (for example, if the user is not correctly authenticated/authorized or doesn't have suitable permissions
to upload from the given URI), it will be returned as a <a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a> by <code class="function">g_output_stream_close()</code>.</p>
<div class="example">
<a name="id-1.3.2.10.9.12"></a><p class="title"><b>Example 3. Uploading from a File</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GDataService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
<span class="usertype">GDataAuthorizationDomain</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">domain</span><span class="symbol">;</span>
<span class="usertype">GCancellable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">cancellable</span><span class="symbol">;</span>
<span class="usertype">GInputStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">input_stream</span><span class="symbol">;</span>
<span class="usertype">GOutputStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">upload_stream</span><span class="symbol">;</span>
<span class="usertype">GFile</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file</span><span class="symbol">;</span>
<span class="usertype">GFileInfo</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file_info</span><span class="symbol">;</span>
<span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>

<span class="comment">/* Get the file to upload */</span>
<span class="normal">file </span><span class="symbol">=</span><span class="normal"> </span><span class="function">get_file_to_upload</span><span class="normal"> </span><span class="symbol">();</span>
<span class="normal">file_info </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_file_query_info</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file</span><span class="symbol">,</span><span class="normal"> G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME </span><span class="string">","</span><span class="normal"> G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE </span><span class="string">","</span>
<span class="normal">                               G_FILE_ATTRIBUTE_STANDARD_SIZE</span><span class="symbol">,</span>
<span class="normal">                               G_FILE_QUERY_INFO_NONE</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>

<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info </span><span class="symbol">==</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error getting file info: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file</span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="cbracket">}</span>

<span class="normal">input_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_file_read</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file</span><span class="symbol">);</span>

<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">input_stream </span><span class="symbol">==</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error getting file input stream: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal">    </span><span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>
<span class="normal">    </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="cbracket">}</span>

<span class="comment">/* Create the upload stream */</span>
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">create_my_service</span><span class="normal"> </span><span class="symbol">();</span>
<span class="normal">domain </span><span class="symbol">=</span><span class="normal"> </span><span class="function">get_my_authorization_domain_from_service</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
<span class="normal">cancellable </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_cancellable_new</span><span class="normal"> </span><span class="symbol">();</span><span class="normal"> </span><span class="comment">/* cancel this to cancel the entire upload operation */</span>
<span class="normal">upload_stream </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataUploadStream.html#gdata-upload-stream-new-resumable">gdata_upload_stream_new_resumable</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">,</span><span class="normal"> domain</span><span class="symbol">,</span><span class="normal"> SOUP_METHOD_POST</span><span class="symbol">,</span><span class="normal"> upload_uri</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span>
<span class="normal">                                                   </span><span class="function">g_file_info_get_display_name</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">),</span><span class="normal"> </span><span class="function">g_file_info_get_content_type</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">),</span>
<span class="normal">                                                   </span><span class="function">g_file_info_get_size</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">),</span><span class="normal"> cancellable</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_info</span><span class="symbol">);</span>

<span class="comment">/* Perform the upload asynchronously */</span>
<span class="function">g_output_stream_splice_async</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">,</span><span class="normal"> input_stream</span><span class="symbol">,</span><span class="normal"> G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE </span><span class="symbol">|</span><span class="normal"> G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET</span><span class="symbol">,</span>
<span class="normal">                              <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS">G_PRIORITY_DEFAULT</a></span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GAsyncReadyCallback</span><span class="symbol">)</span><span class="normal"> upload_splice_cb</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>

<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">input_stream</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">cancellable</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">domain</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>

<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
<span class="function">upload_splice_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GOutputStream</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">upload_stream</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GAsyncResult</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">result</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal">    </span><span class="usertype">gssize</span><span class="normal"> length</span><span class="symbol">;</span>
<span class="normal">    </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>

<span class="normal">    </span><span class="function">g_output_stream_splice_finish</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">,</span><span class="normal"> result</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>

<span class="normal">    </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error </span><span class="symbol">!=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a> </span><span class="symbol">&amp;&amp;</span><span class="normal"> </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-matches">g_error_matches</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> G_IO_ERROR</span><span class="symbol">,</span><span class="normal"> G_IO_ERROR_CANCELLED</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">==</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">))</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal">        </span><span class="comment">/* Error upload the file; potentially an I/O error (GIOError), or an error response from the server</span>
<span class="comment">         * (GDataServiceError). */</span>
<span class="normal">        </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Error uploading file: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-&gt;</span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal">        </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal">    </span><span class="cbracket">}</span>

<span class="normal">    </span><span class="comment">/* If the upload was successful, carry on to parse the result. Note that this will normally be handled by methods like</span>
<span class="comment">     * gdata_youtube_service_finish_video_upload(), gdata_picasaweb_service_finish_file_upload() and</span>
<span class="comment">     * gdata_documents_service_finish_upload() */</span>
<span class="normal">    </span><span class="function">parse_server_result</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GDataUploadStream.html#gdata-upload-stream-get-response">gdata_upload_stream_get_response</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_UPLOAD_STREAM</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">upload_stream</span><span class="symbol">),</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">length</span><span class="symbol">),</span><span class="normal"> length</span><span class="symbol">);</span>
<span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="GDataUploadStream.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-upload-stream-new"></a><h3>gdata_upload_stream_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GOutputStream</span> *
gdata_upload_stream_new (<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
                         <em class="parameter"><code><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *domain</code></em>,
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *upload_uri</code></em>,
                         <em class="parameter"><code><a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> *entry</code></em>,
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>, allowing a file to be uploaded from a GData service using standard <span class="type">GOutputStream</span> API.</p>
<p>The HTTP method to use should be specified in <em class="parameter"><code>method</code></em>
, and will typically be either <code class="literal">SOUP_METHOD_POST</code> (for insertions) or <code class="literal">SOUP_METHOD_PUT</code>
(for updates), according to the server and the <em class="parameter"><code>upload_uri</code></em>
.</p>
<p>If <em class="parameter"><code>entry</code></em>
 is specified, it will be attached to the upload as the entry to which the file being uploaded belongs. Otherwise, just the file
written to the stream will be uploaded, and given a default entry as determined by the server.</p>
<p><em class="parameter"><code>slug</code></em>
 and <em class="parameter"><code>content_type</code></em>
 must be specified before the upload begins, as they describe the file being streamed. <em class="parameter"><code>slug</code></em>
 is the filename given to the
file, which will typically be stored on the server and made available when downloading the file again. <em class="parameter"><code>content_type</code></em>
 must be the correct
content type for the file, and should be in the service's list of acceptable content types.</p>
<p>As well as the standard GIO errors, calls to the <span class="type">GOutputStream</span> API on a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> can also return any relevant specific error from
<a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a>, or <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> in the general case.</p>
<p>If a <span class="type">GCancellable</span> is provided in <em class="parameter"><code>cancellable</code></em>
, the upload operation may be cancelled at any time from another thread using <code class="function">g_cancellable_cancel()</code>.
In this case, any ongoing network activity will be stopped, and any pending or future calls to <span class="type">GOutputStream</span> API on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will
return <code class="literal">G_IO_ERROR_CANCELLED</code>. Note that the <span class="type">GCancellable</span> objects which can be passed to individual <span class="type">GOutputStream</span> operations will not cancel the
upload operation proper if cancelled — they will merely cancel that API call. The only way to cancel the upload operation completely is using this
<em class="parameter"><code>cancellable</code></em>
.</p>
<p>Note that network communication won't begin until the first call to <code class="function">g_output_stream_write()</code> on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>the <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> to authorize the upload, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>the HTTP method to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>upload_uri</p></td>
<td class="parameter_description"><p>the URI to upload, which must be HTTPS</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the entry to upload as metadata, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>slug</p></td>
<td class="parameter_description"><p>the file's slug (filename)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>content_type</p></td>
<td class="parameter_description"><p>the content type of the file being uploaded</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span> for the entire upload stream, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-new.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GOutputStream</span>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-new-resumable"></a><h3>gdata_upload_stream_new_resumable ()</h3>
<pre class="programlisting"><span class="returnvalue">GOutputStream</span> *
gdata_upload_stream_new_resumable (<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
                                   <em class="parameter"><code><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *domain</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *upload_uri</code></em>,
                                   <em class="parameter"><code><a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> *entry</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *slug</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *content_type</code></em>,
                                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> content_length</code></em>,
                                   <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre>
<p>Creates a new resumable <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>, allowing a file to be uploaded from a GData service using standard <span class="type">GOutputStream</span> API. The upload will
use GData's resumable upload API, so should be more reliable than a normal upload (especially if the file is large). See the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/resumable_upload.html" target="_top">GData documentation on resumable uploads</a> for more
<p>information.</p>
<p>The HTTP method to use should be specified in <em class="parameter"><code>method</code></em>
, and will typically be either <code class="literal">SOUP_METHOD_POST</code> (for insertions) or <code class="literal">SOUP_METHOD_PUT</code>
(for updates), according to the server and the <em class="parameter"><code>upload_uri</code></em>
.</p>
<p>If <em class="parameter"><code>entry</code></em>
 is specified, it will be attached to the upload as the entry to which the file being uploaded belongs. Otherwise, just the file
written to the stream will be uploaded, and given a default entry as determined by the server.</p>
<p><em class="parameter"><code>slug</code></em>
, <em class="parameter"><code>content_type</code></em>
 and <em class="parameter"><code>content_length</code></em>
 must be specified before the upload begins, as they describe the file being streamed. <em class="parameter"><code>slug</code></em>
 is the filename
given to the file, which will typically be stored on the server and made available when downloading the file again. <em class="parameter"><code>content_type</code></em>
 must be the
correct content type for the file, and should be in the service's list of acceptable content types. <em class="parameter"><code>content_length</code></em>
 must be the size of the file
being uploaded (not including the XML for any associated <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a>) in bytes. Zero is accepted if a metadata-only upload is being performed.</p>
<p>As well as the standard GIO errors, calls to the <span class="type">GOutputStream</span> API on a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> can also return any relevant specific error from
<a class="link" href="GDataService.html#GDataServiceError" title="enum GDataServiceError"><span class="type">GDataServiceError</span></a>, or <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> in the general case.</p>
<p>If a <span class="type">GCancellable</span> is provided in <em class="parameter"><code>cancellable</code></em>
, the upload operation may be cancelled at any time from another thread using <code class="function">g_cancellable_cancel()</code>.
In this case, any ongoing network activity will be stopped, and any pending or future calls to <span class="type">GOutputStream</span> API on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will
return <code class="literal">G_IO_ERROR_CANCELLED</code>. Note that the <span class="type">GCancellable</span> objects which can be passed to individual <span class="type">GOutputStream</span> operations will not cancel the
upload operation proper if cancelled — they will merely cancel that API call. The only way to cancel the upload operation completely is using this
<em class="parameter"><code>cancellable</code></em>
.</p>
<p>Note that network communication won't begin until the first call to <code class="function">g_output_stream_write()</code> on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-new-resumable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>the <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> to authorize the upload, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>the HTTP method to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>upload_uri</p></td>
<td class="parameter_description"><p>the URI to upload</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the entry to upload as metadata, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>slug</p></td>
<td class="parameter_description"><p>the file's slug (filename)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>content_type</p></td>
<td class="parameter_description"><p>the content type of the file being uploaded</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>content_length</p></td>
<td class="parameter_description"><p>the size (in bytes) of the file being uploaded</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span> for the entire upload stream, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-new-resumable.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GOutputStream</span>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-response"></a><h3>gdata_upload_stream_get_response ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_upload_stream_get_response (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>,
                                  <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> *length</code></em>);</pre>
<p>Returns the server's response to the upload operation performed by the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a>. If the operation
is still underway, or the server's response hasn't been received yet, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>length</code></em>
 is set to <code class="code">-1</code>.</p>
<p>If there was an error during the upload operation (but it is complete), <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, and <em class="parameter"><code>length</code></em>
 is set to <code class="code">0</code>.</p>
<p>While it is safe to call this function from any thread at any time during the network operation, the only way to guarantee that the response has
been set before calling this function is to have closed the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> by calling <code class="function">g_output_stream_close()</code> on it, without cancelling
the close operation. Once the stream has been closed, all network communication is guaranteed to have finished. Note that if a call to
<code class="function">g_output_stream_close()</code> is cancelled, <code class="function">g_output_stream_is_closed()</code> will immediately start to return <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, even if the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> is still
attempting to flush the network buffers asynchronously — consequently, <a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-response" title="gdata_upload_stream_get_response ()"><code class="function">gdata_upload_stream_get_response()</code></a> may still return <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and a <em class="parameter"><code>length</code></em>
 of</p>
<code class="code">-1</code>. The only reliable way to determine if the stream has been fully closed in this situation is to check the results
<p>of <a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-response" title="gdata_upload_stream_get_response ()"><code class="function">gdata_upload_stream_get_response()</code></a>, rather than <code class="function">g_output_stream_is_closed()</code>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-response.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>length</p></td>
<td class="parameter_description"><p>return location for the length of the response, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-response.returns"></a><h4>Returns</h4>
<p> the server's response to the upload, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-service"></a><h3>gdata_upload_stream_get_service ()</h3>
<pre class="programlisting"><a class="link" href="GDataService.html" title="GDataService"><span class="returnvalue">GDataService</span></a> *
gdata_upload_stream_get_service (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the service used to authorize the upload, as passed to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-service.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-service.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> used to authorize the upload. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-authorization-domain"></a><h3>gdata_upload_stream_get_authorization_domain ()</h3>
<pre class="programlisting"><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="returnvalue">GDataAuthorizationDomain</span></a> *
gdata_upload_stream_get_authorization_domain
                               (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the authorization domain used to authorize the upload, as passed to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>. It may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if authorization is not
needed for the upload.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-authorization-domain.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-authorization-domain.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> used to authorize the upload, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-cancellable"></a><h3>gdata_upload_stream_get_cancellable ()</h3>
<pre class="programlisting"><span class="returnvalue">GCancellable</span> *
gdata_upload_stream_get_cancellable (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the <span class="type">GCancellable</span> for the entire upload operation, <a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title="The “cancellable” property"><span class="type">“cancellable”</span></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-cancellable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-cancellable.returns"></a><h4>Returns</h4>
<p>the <span class="type">GCancellable</span> for the entire upload operation. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.8.0">0.8.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-method"></a><h3>gdata_upload_stream_get_method ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_upload_stream_get_method (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the HTTP request method being used to upload the file, as passed to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-method.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-method.returns"></a><h4>Returns</h4>
<p> the HTTP request method in use</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-upload-uri"></a><h3>gdata_upload_stream_get_upload_uri ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_upload_stream_get_upload_uri (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the URI the file is being uploaded to, as passed to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-upload-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-upload-uri.returns"></a><h4>Returns</h4>
<p> the URI which the file is being uploaded to</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-entry"></a><h3>gdata_upload_stream_get_entry ()</h3>
<pre class="programlisting"><a class="link" href="GDataEntry.html" title="GDataEntry"><span class="returnvalue">GDataEntry</span></a> *
gdata_upload_stream_get_entry (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the entry being used to upload metadata, if one was passed to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-entry.returns"></a><h4>Returns</h4>
<p>the entry used for metadata, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-slug"></a><h3>gdata_upload_stream_get_slug ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_upload_stream_get_slug (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the slug (filename) of the file being uploaded.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-slug.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-slug.returns"></a><h4>Returns</h4>
<p> the slug of the file being uploaded</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-content-type"></a><h3>gdata_upload_stream_get_content_type ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_upload_stream_get_content_type (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the content type of the file being uploaded.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-content-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-content-type.returns"></a><h4>Returns</h4>
<p> the content type of the file being uploaded</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-upload-stream-get-content-length"></a><h3>gdata_upload_stream_get_content_length ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
gdata_upload_stream_get_content_length
                               (<em class="parameter"><code><a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> *self</code></em>);</pre>
<p>Gets the size (in bytes) of the file being uploaded. This will be <code class="code">-1</code> for a non-resumable upload, and zero or greater
for a resumable upload.</p>
<div class="refsect3">
<a name="gdata-upload-stream-get-content-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-upload-stream-get-content-length.returns"></a><h4>Returns</h4>
<p> the size of the file being uploaded</p>
</div>
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataUploadStream.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-LINK-RESUMABLE-CREATE-MEDIA:CAPS"></a><h3>GDATA_LINK_RESUMABLE_CREATE_MEDIA</h3>
<pre class="programlisting">#define GDATA_LINK_RESUMABLE_CREATE_MEDIA "http://schemas.google.com/g/2005#resumable-create-media"
</pre>
<p>The relation type URI of the resumable upload location for resources attached to this resource.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/resumable_upload.html#ResumableUploadInitiate" target="_top">GData resumable upload protocol
specification</a>.
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-LINK-RESUMABLE-EDIT-MEDIA:CAPS"></a><h3>GDATA_LINK_RESUMABLE_EDIT_MEDIA</h3>
<pre class="programlisting">#define GDATA_LINK_RESUMABLE_EDIT_MEDIA "http://schemas.google.com/g/2005#resumable-edit-media"
</pre>
<p>The relation type URI of the resumable update location for resources attached to this resource.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/gdata/docs/resumable_upload.html#ResumableUploadInitiate" target="_top">GData resumable upload protocol
specification</a>.
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream-struct"></a><h3>GDataUploadStream</h3>
<pre class="programlisting">typedef struct _GDataUploadStream GDataUploadStream;</pre>
<p>All the fields in the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStreamClass"></a><h3>GDataUploadStreamClass</h3>
<pre class="programlisting">typedef struct {
} GDataUploadStreamClass;
</pre>
<p>All the fields in the <a class="link" href="GDataUploadStream.html#GDataUploadStreamClass" title="GDataUploadStreamClass"><span class="type">GDataUploadStreamClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataUploadStream.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataUploadStream--authorization-domain"></a><h3>The <code class="literal">“authorization-domain”</code> property</h3>
<pre class="programlisting">  “authorization-domain”     <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *</pre>
<p>The authorization domain for the upload, against which the <a class="link" href="GDataService.html#GDataService--authorizer" title="The “authorizer” property"><span class="type">“authorizer”</span></a> for the <a class="link" href="GDataDownloadStream.html#GDataDownloadStream--service" title="The “service” property"><span class="type">“service”</span></a> should be
authorized. This may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if authorization is not needed for the upload.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--cancellable"></a><h3>The <code class="literal">“cancellable”</code> property</h3>
<pre class="programlisting">  “cancellable”              <span class="type">GCancellable</span> *</pre>
<p>An optional cancellable used to cancel the entire upload operation. If a <span class="type">GCancellable</span> instance isn't provided for this property at
construction time (i.e. to <a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>), one will be created internally and can be retrieved using
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-get-cancellable" title="gdata_upload_stream_get_cancellable ()"><code class="function">gdata_upload_stream_get_cancellable()</code></a> and used to cancel the upload operation with <code class="function">g_cancellable_cancel()</code> just as if it was passed to
<a class="link" href="GDataUploadStream.html#gdata-upload-stream-new" title="gdata_upload_stream_new ()"><code class="function">gdata_upload_stream_new()</code></a>.</p>
<p>If the upload operation is cancelled using this <span class="type">GCancellable</span>, any ongoing network activity will be stopped, and any pending or future calls
to <span class="type">GOutputStream</span> API on the <a class="link" href="GDataUploadStream.html" title="GDataUploadStream"><span class="type">GDataUploadStream</span></a> will return <code class="literal">G_IO_ERROR_CANCELLED</code>. Note that the <span class="type">GCancellable</span> objects which can be passed
to individual <span class="type">GOutputStream</span> operations will not cancel the upload operation proper if cancelled — they will merely cancel that API call.
The only way to cancel the upload operation completely is using <a class="link" href="GDataUploadStream.html#GDataUploadStream--cancellable" title="The “cancellable” property"><span class="type">“cancellable”</span></a>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="ix10.html#api-index-0.8.0">0.8.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--content-length"></a><h3>The <code class="literal">“content-length”</code> property</h3>
<pre class="programlisting">  “content-length”           <a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The content length (in bytes) of the file being uploaded (i.e. as returned by <code class="function">g_file_info_get_size()</code>). Note that this does not include the
length of the XML serialisation of <a class="link" href="GDataUploadStream.html#GDataUploadStream--entry" title="The “entry” property"><span class="type">“entry”</span></a>, if set.</p>
<p>If this is <code class="code">-1</code> the upload will be non-resumable; if it is non-negative, the upload will be resumable.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--content-type"></a><h3>The <code class="literal">“content-type”</code> property</h3>
<pre class="programlisting">  “content-type”             <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The content type of the file being uploaded (i.e. as returned by <code class="function">g_file_info_get_content_type()</code>).</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--entry"></a><h3>The <code class="literal">“entry”</code> property</h3>
<pre class="programlisting">  “entry”                    <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> *</pre>
<p>The entry used for metadata to upload.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--method"></a><h3>The <code class="literal">“method”</code> property</h3>
<pre class="programlisting">  “method”                   <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The HTTP request method to use when uploading the file.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--service"></a><h3>The <code class="literal">“service”</code> property</h3>
<pre class="programlisting">  “service”                  <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *</pre>
<p>The service which is used to authorize the upload, and to which the upload relates.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--slug"></a><h3>The <code class="literal">“slug”</code> property</h3>
<pre class="programlisting">  “slug”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The slug of the file being uploaded. This is usually the display name of the file (i.e. as returned by <code class="function">g_file_info_get_display_name()</code>).</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataUploadStream--upload-uri"></a><h3>The <code class="literal">“upload-uri”</code> property</h3>
<pre class="programlisting">  “upload-uri”               <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The URI to upload the data and metadata to. This must be HTTPS.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-0.5.0">0.5.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation