~ubuntu-branches/debian/sid/glib2.0/sid

void (<a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">*GAsyncReadyCallback</a>) (<code><a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *source_object</code>,

void (<a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">*GAsyncReadyCallback</a>) (<code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *source_object</code>,

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gpointer">gpointer</a> <a class="link" href="GAsyncResult.html#g-async-result-get-user-data" title="g_async_result_get_user_data ()">g_async_result_get_user_data</a> (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);

<a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> * <a class="link" href="GAsyncResult.html#g-async-result-get-source-object" title="g_async_result_get_source_object ()">g_async_result_get_source_object</a> (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> <a class="link" href="GAsyncResult.html#g-async-result-get-user-data" title="g_async_result_get_user_data ()">g_async_result_get_user_data</a> (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);

<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> * <a class="link" href="GAsyncResult.html#g-async-result-get-source-object" title="g_async_result_get_source_object ()">g_async_result_get_source_object</a> (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GAsyncResult.html#g-async-result-is-tagged" title="g_async_result_is_tagged ()">g_async_result_is_tagged</a> (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> source_tag</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GAsyncResult.html#g-async-result-legacy-propagate-error" title="g_async_result_legacy_propagate_error ()">g_async_result_legacy_propagate_error</a>

(<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);

</pre>

</div>

<a name="GAsyncResult.prerequisites"></a><h2>Prerequisites</h2>

GAsyncResult requires

<a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.

<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.

</div>

<a name="GAsyncResult.implementations"></a><h2>Known Implementations</h2>

GAsyncResult is implemented by

<a class="link" href="GSimpleAsyncResult.html" title="GSimpleAsyncResult">GSimpleAsyncResult</a>.

<a class="link" href="GSimpleAsyncResult.html" title="GSimpleAsyncResult">GSimpleAsyncResult</a> and <a class="link" href="GTask.html" title="GTask">GTask</a>.

</div>

<a name="GAsyncResult.description"></a><h2>Description</h2>

100

105

operation is not needed, there is no need to call the "<code class="function">_finish()</code>"

101

106

function; GIO will take care of cleaning up the result and error

102

107

information after the <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> returns. You can pass

103

<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> if you don't need to take any

108

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> if you don't need to take any

104

109

action at all after the operation completes. Applications may also

105

110

take a reference to the <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> and call "<code class="function">_finish()</code>" later;

106

111

however, the "<code class="function">_finish()</code>" function may be called at most once.

164

169

GAsyncResult *res,

165

170

gpointer user_data)

166

171

{

167

gboolean success = <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a>;

172

gboolean success = <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a>;

168

173

169

success = _theoretical_frobnitz_finish (source_object, res, <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>);

174

success = _theoretical_frobnitz_finish (source_object, res, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>);

170

175

171

176

if (success)

172

<a href="./../glib/glib/glib-String-Utility-Functions.html#g-printf">g_printf</a> ("Hurray!\n");

177

<a href="../glib/glib-String-Utility-Functions.html#g-printf">g_printf</a> ("Hurray!\n");

173

178

else

174

<a href="./../glib/glib/glib-String-Utility-Functions.html#g-printf">g_printf</a> ("Uh oh!\n");

179

<a href="../glib/glib-String-Utility-Functions.html#g-printf">g_printf</a> ("Uh oh!\n");

175

180

176

181

/* ... */

177

182

187

/* ... */

183

188

184

189

_theoretical_frobnitz_async (theoretical_data,

185

<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>,

190

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>,

186

191

frobnitz_result_func,

187

<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>);

192

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a>);

188

193

189

194

/* ... */

190

195

}</pre></td>

200

205

always called, even in the case of a cancelled operation. On cancellation

201

206

the result is a <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> error.

202

207

208

209

210

<a name="io-priority"></a> Many I/O-related asynchronous

211

operations have a priority parameter, which is used in certain

212

cases to determine the order in which operations are executed. They

213

are not used to determine system-wide I/O

214

scheduling. Priorities are integers, with lower numbers indicating

215

higher priority. It is recommended to choose priorities between

216

<a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-LOW:CAPS"><code class="literal">G_PRIORITY_LOW</code></a> and <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH:CAPS"><code class="literal">G_PRIORITY_HIGH</code></a>, with <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a> as a

217

default.

218

219

203

220

</div>

204

221

205

222

<a name="GAsyncResult.details"></a><h2>Details</h2>

221

238

222

239

gpointer (* get_user_data) (GAsyncResult *res);

223

240

GObject * (* get_source_object) (GAsyncResult *res);

241

242

gboolean (* is_tagged) (GAsyncResult *res,

243

gpointer source_tag);

224

244

};

225

245

</pre>

226

246

233

253

</colgroup>

234

254

<tbody>

235

255

<tr>

236

<td><a href="./../gobject/gobject/gobject-Type-Information.html#GTypeInterface">GTypeInterface</a> <code><a name="GAsyncResultIface.g-iface"></a>g_iface</code>;</td>

256

<td><a href="../gobject/gobject-Type-Information.html#GTypeInterface">GTypeInterface</a> <code><a name="GAsyncResultIface.g-iface"></a>g_iface</code>;</td>

237

257

<td>The parent interface.</td>

238

258

</tr>

239

259

<tr>

244

264

<td><code><a name="GAsyncResultIface.get-source-object"></a>get_source_object</code> ()</td>

245

265

<td>Gets the source object that issued the asynchronous operation.</td>

246

266

</tr>

267

<tr>

268

<td><code><a name="GAsyncResultIface.is-tagged"></a>is_tagged</code> ()</td>

269

<td>Checks if a result is tagged with a particular source.</td>

270

</tr>

247

271

</tbody>

248

272

</table></div>

249

273

</div>

250

274

<hr>

251

275

252

276

<a name="GAsyncReadyCallback"></a><h3>GAsyncReadyCallback ()</h3>

253

<pre class="programlisting">void (*GAsyncReadyCallback) (<code><a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *source_object</code>,

277

<pre class="programlisting">void (*GAsyncReadyCallback) (<code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *source_object</code>,

254

278

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

255

<code><a href="./../glib/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

279

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

256

280

257

281

Type definition for a function that will be called back when an asynchronous

258

282

operation within GIO has been completed.

281

305

<hr>

282

306

283

307

<a name="g-async-result-get-user-data"></a><h3>g_async_result_get_user_data ()</h3>

284

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gpointer">gpointer</a> g_async_result_get_user_data (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);</pre>

308

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> g_async_result_get_user_data (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);</pre>

285

309

286

310

Gets the user data from a <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a>.

287

311

306

330

<hr>

307

331

308

332

<a name="g-async-result-get-source-object"></a><h3>g_async_result_get_source_object ()</h3>

309

<pre class="programlisting"><a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> * g_async_result_get_source_object (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);</pre>

333

<pre class="programlisting"><a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> * g_async_result_get_source_object (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>);</pre>

310

334

311

335

Gets the source object from a <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a>.

312

336

324

348

<tr>

325

349

<td>Returns :</td>

326

350

<td>a new reference to the source object for the <code>res</code>,

327

or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is none. [<acronym title="Free data after the code is done.">transfer full</acronym>]

328

</td>

329

</tr>

330

</tbody>

331

</table></div>

351

or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is none. [<acronym title="Free data after the code is done.">transfer full</acronym>]

352

</td>

353

</tr>

354

</tbody>

355

</table></div>

356

</div>

357

<hr>

358

359

<a name="g-async-result-is-tagged"></a><h3>g_async_result_is_tagged ()</h3>

360

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_async_result_is_tagged (<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

361

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> source_tag</code>);</pre>

362

363

Checks if <code>res</code> has the given <code>source_tag</code> (generally a function

364

pointer indicating the function <code>res</code> was created by).

365

366

367

368

369

<col>

370

</colgroup>

371

<tbody>

372

<tr>

373

374

<td>a <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a>

375

</td>

376

</tr>

377

<tr>

378

<td><code>source_tag</code> :</td>

379

<td>an application-defined tag</td>

380

</tr>

381

<tr>

382

<td>Returns :</td>

383

<td>

384

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>res</code> has the indicated <code>source_tag</code>, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if

385

not.</td>

386

</tr>

387

</tbody>

388

</table></div>

389

Since 2.34

390

</div>

391

<hr>

392

393

<a name="g-async-result-legacy-propagate-error"></a><h3>g_async_result_legacy_propagate_error ()</h3>

394

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_async_result_legacy_propagate_error

395

(<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *res</code>,

396

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

397

398

If <code>res</code> is a <a class="link" href="GSimpleAsyncResult.html" title="GSimpleAsyncResult">GSimpleAsyncResult</a>, this is equivalent to

399

<a class="link" href="GSimpleAsyncResult.html#g-simple-async-result-propagate-error" title="g_simple_async_result_propagate_error ()"><code class="function">g_simple_async_result_propagate_error()</code></a>. Otherwise it returns

400

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

401

402

403

This can be used for legacy error handling in async

404

<code class="literal"><code class="function">_finish()</code></code> wrapper functions that traditionally

405

handled <a class="link" href="GSimpleAsyncResult.html" title="GSimpleAsyncResult">GSimpleAsyncResult</a> error returns themselves rather than

406

calling into the virtual method. This should not be used in new

407

code; <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> errors that are set by virtual methods should

408

also be extracted by virtual methods, to enable subclasses to chain

409

up correctly.

410

411

412

413

414

<col>

415

</colgroup>

416

<tbody>

417

<tr>

418

419

<td>a <a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a>

420

</td>

421

</tr>

422

<tr>

423

<td><code>error</code> :</td>

424

<td>a location to propagate the error to. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>]

425

</td>

426

</tr>

427

<tr>

428

<td>Returns :</td>

429

<td>

430

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>error</code> is has been filled in with an error from

431

<code>res</code>, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>

432

</tr>

433

</tbody>

434

</table></div>

435

Since 2.34

332

436

</div>

333

437

</div>

334

438

335

439

336

<a class="link" href="GSimpleAsyncResult.html" title="GSimpleAsyncResult">GSimpleAsyncResult</a>

440

<a class="link" href="GTask.html" title="GTask">GTask</a>

337

441

</div>

338

442

</div>

339

443

340

444

<hr>

341

Generated by GTK-Doc V1.18</div>

445

Generated by GTK-Doc V1.18.1</div>

342

446

</body>

343

447

</html>

b'\\ No newline at end of file'

Older »