~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

void (<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">*GnomeVFSModuleCallback</a>) (gconstpointer in,

gsize in_size,

gpointer out,

gsize out_size,

gpointer callback_data);

void (<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()">*GnomeVFSModuleCallbackResponse</a>) (gpointer response_data);

void (<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">*GnomeVFSAsyncModuleCallback</a>) (gconstpointer in,

gsize in_size,

gpointer out,

gsize out_size,

gpointer callback_data,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()">GnomeVFSModuleCallbackResponse</a> response,

gpointer response_data);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-set-default" title="gnome_vfs_module_callback_set_default ()">gnome_vfs_module_callback_set_default</a>

(const char *callback_name,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">GnomeVFSModuleCallback</a> callback,

gpointer callback_data,

GDestroyNotify destroy_notify);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-push" title="gnome_vfs_module_callback_push ()">gnome_vfs_module_callback_push</a> (const char *callback_name,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">GnomeVFSModuleCallback</a> callback,

gpointer callback_data,

GDestroyNotify destroy_notify);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-pop" title="gnome_vfs_module_callback_pop ()">gnome_vfs_module_callback_pop</a> (const char *callback_name);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-set-default" title="gnome_vfs_async_module_callback_set_default ()">gnome_vfs_async_module_callback_set_default</a>

(const char *callback_name,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">GnomeVFSAsyncModuleCallback</a> callback,

gpointer callback_data,

GDestroyNotify destroy_notify);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()">gnome_vfs_async_module_callback_push</a>

(const char *callback_name,

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">GnomeVFSAsyncModuleCallback</a> callback,

gpointer callback_data,

GDestroyNotify destroy_notify);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-pop" title="gnome_vfs_async_module_callback_pop ()">gnome_vfs_async_module_callback_pop</a> (const char *callback_name);

</pre>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-module-callback.description"></a><h2>Description</h2>

<p>

</p>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-module-callback.details"></a><h2>Details</h2>

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

<pre class="programlisting">void (*GnomeVFSModuleCallback) (gconstpointer in,

gsize in_size,

gpointer out,

gsize out_size,

gpointer callback_data);</pre>

100

<p>

101

Modules use a <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()"><span class="type">GnomeVFSModuleCallback</span></a> to send data to

102

client applications and request data from them synchronously.

103

</p>

104

<p>

105

The format of <em class="parameter"><code>in</code></em> and <em class="parameter"><code>out</code></em> is determined by the callback name.</p>

106

<p>

107

</p>

108

109

110

<tbody>

111

<tr>

112

113

<td> data passed from module to application.

114

</td>

115

</tr>

116

<tr>

117

118

<td> size of <em class="parameter"><code>in</code></em> bytes.

119

</td>

120

</tr>

121

<tr>

122

123

<td> data passed from application to module.

124

</td>

125

</tr>

126

<tr>

127

128

<td> size of <em class="parameter"><code>out</code></em> in bytes.

129

</td>

130

</tr>

131

<tr>

132

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

133

<td> user data passed when connecting the callback.

134

</td>

135

</tr>

136

</tbody>

137

</table></div>

138

</div>

139

<hr>

140

141

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

142

<pre class="programlisting">void (*GnomeVFSModuleCallbackResponse) (gpointer response_data);</pre>

143

<p>

144

This is the type of the response function passed to a

145

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()"><code class="function">GnomeVFSAsyncModuleCallback()</code></a>. It should be called when the async

146

callback has completed.</p>

147

<p>

148

</p>

149

150

151

152

<td><p><span class="term"><em class="parameter"><code>response_data</code></em> :</span></p></td>

153

<td> pass the response data argument originally passed to the async callback.

154

</td>

155

</tr></tbody>

156

</table></div>

157

</div>

158

<hr>

159

160

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

161

<pre class="programlisting">void (*GnomeVFSAsyncModuleCallback) (gconstpointer in,

162

gsize in_size,

163

gpointer out,

164

gsize out_size,

165

gpointer callback_data,

166

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()">GnomeVFSModuleCallbackResponse</a> response,

167

gpointer response_data);</pre>

168

<p>

169

170

client applications and request data from them asynchronously.

171

</p>

172

<p>

173

The application is expected to invoke the <em class="parameter"><code>response</code></em> with <em class="parameter"><code>response_data</code></em>

174

when it is able to satisfy the request.

175

</p>

176

<p>

177

The format of <em class="parameter"><code>in</code></em> and <em class="parameter"><code>out</code></em> is determined by the callback name.</p>

178

<p>

179

</p>

180

181

182

<tbody>

183

<tr>

184

185

<td> data passed from module to application.

186

</td>

187

</tr>

188

<tr>

189

190

<td> size of <em class="parameter"><code>in</code></em> bytes.

191

</td>

192

</tr>

193

<tr>

194

195

<td> data passed from application to module.

196

</td>

197

</tr>

198

<tr>

199

200

<td> size of <em class="parameter"><code>out</code></em> in bytes.

201

</td>

202

</tr>

203

<tr>

204

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

205

<td> user data passed when connecting the callback.

206

</td>

207

</tr>

208

<tr>

209

<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>

210

<td> <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()"><span class="type">GnomeVFSModuleCallbackResponse</span></a> that must be invoked when the request is satisfied.

211

</td>

212

</tr>

213

<tr>

214

<td><p><span class="term"><em class="parameter"><code>response_data</code></em> :</span></p></td>

215

<td> data that must be passed to <em class="parameter"><code>response</code></em> when the request is satisfied.

216

</td>

217

</tr>

218

</tbody>

219

</table></div>

220

</div>

221

<hr>

222

223

<a name="gnome-vfs-module-callback-set-default"></a><h3>gnome_vfs_module_callback_set_default ()</h3>

224

<pre class="programlisting">void gnome_vfs_module_callback_set_default

225

(const char *callback_name,

226

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">GnomeVFSModuleCallback</a> callback,

227

gpointer callback_data,

228

GDestroyNotify destroy_notify);</pre>

229

<p>

230

Set the default callback for <em class="parameter"><code>callback_name</code></em> to

231

<em class="parameter"><code>callback</code></em>. <em class="parameter"><code>callback</code></em> will be called with <em class="parameter"><code>callback_data</code></em> on the

232

same thread as the gnome-vfs operation that invokes it. The default

233

value is shared for all threads, but setting it is thread-safe.

234

</p>

235

<p>

236

Use this function if you want to set a handler to be used by your

237

whole application. You can use <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-push" title="gnome_vfs_module_callback_push ()"><code class="function">gnome_vfs_module_callback_push()</code></a> to

238

set a callback function that will temporarily override the default

239

on the current thread instead. Or you can also use

240

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-set-default" title="gnome_vfs_async_module_callback_set_default ()"><code class="function">gnome_vfs_async_module_callback_set_default()</code></a> to set an async

241

callback function.

242

</p>

243

<p>

244

Note: <em class="parameter"><code>destroy_notify</code></em> may be called on any thread - it is not

245

guaranteed to be called on the main thread.</p>

246

<p>

247

</p>

248

249

250

<tbody>

251

<tr>

252

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

253

<td> name of the module callback to set.

254

</td>

255

</tr>

256

<tr>

257

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

258

<td> function to call when the <em class="parameter"><code>callback</code></em> is invoked.

259

</td>

260

</tr>

261

<tr>

262

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

263

<td> data to pass to <em class="parameter"><code>callback</code></em>.

264

</td>

265

</tr>

266

<tr>

267

<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>

268

<td> function to call when <em class="parameter"><code>callback_data</code></em> is to be freed.

269

</td>

270

</tr>

271

</tbody>

272

</table></div>

273

</div>

274

<hr>

275

276

<a name="gnome-vfs-module-callback-push"></a><h3>gnome_vfs_module_callback_push ()</h3>

277

<pre class="programlisting">void gnome_vfs_module_callback_push (const char *callback_name,

278

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">GnomeVFSModuleCallback</a> callback,

279

gpointer callback_data,

280

GDestroyNotify destroy_notify);</pre>

281

<p>

282

Set <em class="parameter"><code>callback</code></em> as a temprary handler for <em class="parameter"><code>callback_name</code></em>. <em class="parameter"><code>callback</code></em>

283

will be called with <em class="parameter"><code>callback_data</code></em> on the same thread as the

284

gnome-vfs operation that invokes it. The temporary handler is set

285

per-thread.

286

</p>

287

<p>

288

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-pop" title="gnome_vfs_module_callback_pop ()"><code class="function">gnome_vfs_module_callback_pop()</code></a> removes the most recently set

289

temporary handler. The temporary handlers are treated as a first-in

290

first-out stack.

291

</p>

292

<p>

293

Use this function to set a temporary callback handler for a single

294

call or a few calls. You can use

295

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-set-default" title="gnome_vfs_module_callback_set_default ()"><code class="function">gnome_vfs_module_callback_set_default()</code></a> to set a callback function

296

that will establish a permanent global setting for all threads

297

instead.

298

</p>

299

<p>

300

Note: <em class="parameter"><code>destroy_notify</code></em> may be called on any thread - it is not

301

guaranteed to be called on the main thread.</p>

302

<p>

303

</p>

304

305

306

<tbody>

307

<tr>

308

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

309

<td> name of the module callback to set temporarily.

310

</td>

311

</tr>

312

<tr>

313

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

314

<td> function to call when the <em class="parameter"><code>callback</code></em> is invoked.

315

</td>

316

</tr>

317

<tr>

318

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

319

<td> data to pass to <em class="parameter"><code>callback</code></em>.

320

</td>

321

</tr>

322

<tr>

323

<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>

324

<td> function to call when <em class="parameter"><code>callback_data</code></em> is to be freed.

325

</td>

326

</tr>

327

</tbody>

328

</table></div>

329

</div>

330

<hr>

331

332

<a name="gnome-vfs-module-callback-pop"></a><h3>gnome_vfs_module_callback_pop ()</h3>

333

<pre class="programlisting">void gnome_vfs_module_callback_pop (const char *callback_name);</pre>

334

<p>

335

</p>

336

337

338

339

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

340

<td>

341

</td>

342

</tr></tbody>

343

</table></div>

344

</div>

345

<hr>

346

347

<a name="gnome-vfs-async-module-callback-set-default"></a><h3>gnome_vfs_async_module_callback_set_default ()</h3>

348

<pre class="programlisting">void gnome_vfs_async_module_callback_set_default

349

(const char *callback_name,

350

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">GnomeVFSAsyncModuleCallback</a> callback,

351

gpointer callback_data,

352

GDestroyNotify destroy_notify);</pre>

353

<p>

354

Set the default async callback for <em class="parameter"><code>callback_name</code></em> to

355

<em class="parameter"><code>callback</code></em>. <em class="parameter"><code>callback</code></em> will be called with <em class="parameter"><code>callback_data</code></em>

356

from a callback on the main thread. It will be passed a response

357

function which should be called to signal completion of the callback.

358

The callback function itself may return in the meantime.

359

</p>

360

<p>

361

The default value is shared for all threads, but setting it is

362

thread-safe.

363

</p>

364

<p>

365

Use this function if you want to globally set a callback handler

366

for use with async operations.

367

</p>

368

<p>

369

You can use <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()"><code class="function">gnome_vfs_async_module_callback_push()</code></a> to set an async

370

callback function that will temporarily override the default on the

371

current thread instead. Or you can also use

372

373

function.

374

</p>

375

<p>

376

Note: <em class="parameter"><code>destroy_notify</code></em> may be called on any thread - it is not

377

guaranteed to be called on the main thread.</p>

378

<p>

379

</p>

380

381

382

<tbody>

383

<tr>

384

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

385

<td> name of the async module callback to set.

386

</td>

387

</tr>

388

<tr>

389

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

390

<td> function to call when <em class="parameter"><code>callback</code></em> is invoked.

391

</td>

392

</tr>

393

<tr>

394

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

395

<td> data to pass to <em class="parameter"><code>callback</code></em>.

396

</td>

397

</tr>

398

<tr>

399

<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>

400

<td> function to call when <em class="parameter"><code>callback_data</code></em> is to be freed.

401

</td>

402

</tr>

403

</tbody>

404

</table></div>

405

</div>

406

<hr>

407

408

<a name="gnome-vfs-async-module-callback-push"></a><h3>gnome_vfs_async_module_callback_push ()</h3>

409

<pre class="programlisting">void gnome_vfs_async_module_callback_push

410

(const char *callback_name,

411

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">GnomeVFSAsyncModuleCallback</a> callback,

412

gpointer callback_data,

413

GDestroyNotify destroy_notify);</pre>

414

<p>

415

Set <em class="parameter"><code>callback</code></em> as a temprary async handler for

416

<em class="parameter"><code>callback_name</code></em>. <em class="parameter"><code>callback</code></em> will be called with <em class="parameter"><code>callback_data</code></em>

417

from a callback on the main thread. It will be passed a response

418

function which should be called to signal completion of the

419

callback. The callback function itself may return in the meantime.

420

</p>

421

<p>

422

The temporary async handler is set per-thread.

423

</p>

424

<p>

425

<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-pop" title="gnome_vfs_async_module_callback_pop ()"><code class="function">gnome_vfs_async_module_callback_pop()</code></a> removes the most recently set

426

temporary handler. The temporary async handlers are

427

treated as a first-in first-out stack.

428

</p>

429

<p>

430

Use this function to set a temporary async callback handler for a

431

single call or a few calls. You can use

432

433

callback function that will establish a permanent global setting

434

for all threads instead.

435

</p>

436

<p>

437

Note: <em class="parameter"><code>destroy_notify</code></em> may be called on any thread - it is not

438

guaranteed to be called on the main thread.</p>

439

<p>

440

</p>

441

442

443

<tbody>

444

<tr>

445

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

446

<td> name of the module callback to set temporarily.

447

</td>

448

</tr>

449

<tr>

450

<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>

451

<td> function to call when <em class="parameter"><code>callback</code></em> is invoked.

452

</td>

453

</tr>

454

<tr>

455

<td><p><span class="term"><em class="parameter"><code>callback_data</code></em> :</span></p></td>

456

<td> data to pass to <em class="parameter"><code>callback</code></em>.

457

</td>

458

</tr>

459

<tr>

460

<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>

461

<td> function to call when <em class="parameter"><code>callback_data</code></em> is to be freed.

462

</td>

463

</tr>

464

</tbody>

465

</table></div>

466

</div>

467

<hr>

468

469

<a name="gnome-vfs-async-module-callback-pop"></a><h3>gnome_vfs_async_module_callback_pop ()</h3>

470

<pre class="programlisting">void gnome_vfs_async_module_callback_pop (const char *callback_name);</pre>

471

<p>

472

Remove the temporary async handler for <em class="parameter"><code>callback_name</code></em> most recently

473

set with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()"><code class="function">gnome_vfs_async_module_callback_push()</code></a>. If another

474

temporary async handler was previously set on the same thread, it

475

becomes the current handler. Otherwise, the default async handler,

476

if any, becomes current.

477

</p>

478

<p>

479

The temporary async handlers are treated as a first-in first-out

480

stack.</p>

481

<p>

482

</p>

483

484

485

486

<td><p><span class="term"><em class="parameter"><code>callback_name</code></em> :</span></p></td>

487

<td> name of the module callback to remove a temporary handler for.

488

</td>

489

</tr></tbody>

490

</table></div>

491

</div>

492

</div>

493

</div>

494

495

<hr>

496

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

497

</body>

498

</html>

Older »