doc/html/gnome-vfs-cancellation.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >Cancellation</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64
   8 "><LINK
   9 REL="HOME"
  10 TITLE="GnomeVFS - Filesystem Abstraction library"
  11 HREF="index.html"><LINK
  12 REL="UP"
  13 TITLE="Other APIs"
  14 HREF="everything-else.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="Other APIs"
  17 HREF="everything-else.html"><LINK
  18 REL="NEXT"
  19 TITLE="Configuration"
  20 HREF="gnome-vfs-configuration.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFFFFF"
  24 TEXT="#000000"
  25 LINK="#0000FF"
  26 VLINK="#840084"
  27 ALINK="#0000FF"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 WIDTH="100%"
  32 BORDER="0"
  33 BGCOLOR="#000000"
  34 CELLPADDING="1"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="4"
  39 ALIGN="center"
  40 ><FONT
  41 COLOR="#FFFFFF"
  42 SIZE="5"
  43 >GnomeVFS - Filesystem Abstraction library</FONT
  44 ></TH
  45 ></TR
  46 ><TR
  47 ><TD
  48 WIDTH="25%"
  49 BGCOLOR="#C00000"
  50 ALIGN="left"
  51 ><A
  52 HREF="everything-else.html"
  53 ><FONT
  54 COLOR="#FFFFFF"
  55 SIZE="3"
  56 ><B
  57 >&#60;&#60;&#60; Previous Page</B
  58 ></FONT
  59 ></A
  60 ></TD
  61 ><TD
  62 WIDTH="25%"
  63 BGCOLOR="#0000C0"
  64 ALIGN="center"
  65 ><FONT
  66 COLOR="#FFFFFF"
  67 SIZE="3"
  68 ><B
  69 ><A
  70 HREF="index.html"
  71 ><FONT
  72 COLOR="#FFFFFF"
  73 SIZE="3"
  74 ><B
  75 >Home</B
  76 ></FONT
  77 ></A
  78 ></B
  79 ></FONT
  80 ></TD
  81 ><TD
  82 WIDTH="25%"
  83 BGCOLOR="#00C000"
  84 ALIGN="center"
  85 ><FONT
  86 COLOR="#FFFFFF"
  87 SIZE="3"
  88 ><B
  89 ><A
  90 HREF="everything-else.html"
  91 ><FONT
  92 COLOR="#FFFFFF"
  93 SIZE="3"
  94 ><B
  95 >Up</B
  96 ></FONT
  97 ></A
  98 ></B
  99 ></FONT
 100 ></TD
 101 ><TD
 102 WIDTH="25%"
 103 BGCOLOR="#C00000"
 104 ALIGN="right"
 105 ><A
 106 HREF="gnome-vfs-configuration.html"
 107 ><FONT
 108 COLOR="#FFFFFF"
 109 SIZE="3"
 110 ><B
 111 >Next Page &#62;&#62;&#62;</B
 112 ></FONT
 113 ></A
 114 ></TD
 115 ></TR
 116 ></TABLE
 117 ></DIV
 118 ><H1
 119 ><A
 120 NAME="GNOME-VFS-CANCELLATION"
 121 >Cancellation</A
 122 ></H1
 123 ><DIV
 124 CLASS="REFNAMEDIV"
 125 ><A
 126 NAME="AEN9058"
 127 ></A
 128 ><H2
 129 >Name</H2
 130 >Cancellation&nbsp;--&nbsp;</DIV
 131 ><DIV
 132 CLASS="REFSYNOPSISDIV"
 133 ><A
 134 NAME="AEN9061"
 135 ></A
 136 ><H2
 137 >Synopsis</H2
 138 ><TABLE
 139 BORDER="0"
 140 BGCOLOR="#D6E8FF"
 141 WIDTH="100%"
 142 CELLPADDING="6"
 143 ><TR
 144 ><TD
 145 ><PRE
 146 CLASS="SYNOPSIS"
 147 >&#13;
 148
 149 GnomeVFSCancellation* <A
 150 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-NEW"
 151 >gnome_vfs_cancellation_new</A
 152 >
 153                                             (void);
 154 void        <A
 155 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-DESTROY"
 156 >gnome_vfs_cancellation_destroy</A
 157 >  (GnomeVFSCancellation *cancellation);
 158 void        <A
 159 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-CANCEL"
 160 >gnome_vfs_cancellation_cancel</A
 161 >   (GnomeVFSCancellation *cancellation);
 162 <A
 163 HREF=../glib/glib-basic-types.html#GBOOLEAN
 164 >gboolean</A>    <A
 165 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-CHECK"
 166 >gnome_vfs_cancellation_check</A
 167 >    (GnomeVFSCancellation *cancellation);
 168 void        <A
 169 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-ACK"
 170 >gnome_vfs_cancellation_ack</A
 171 >      (GnomeVFSCancellation *cancellation);
 172 <A
 173 HREF=../glib/glib-basic-types.html#GINT
 174 >gint</A>        <A
 175 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-GET-FD"
 176 >gnome_vfs_cancellation_get_fd</A
 177 >   (GnomeVFSCancellation *cancellation);</PRE
 178 ></TD
 179 ></TR
 180 ></TABLE
 181 ></DIV
 182 ><DIV
 183 CLASS="REFSECT1"
 184 ><A
 185 NAME="AEN9078"
 186 ></A
 187 ><H2
 188 >Description</H2
 189 ><P
 190 ></P
 191 ></DIV
 192 ><DIV
 193 CLASS="REFSECT1"
 194 ><A
 195 NAME="AEN9081"
 196 ></A
 197 ><H2
 198 >Details</H2
 199 ><DIV
 200 CLASS="REFSECT2"
 201 ><A
 202 NAME="AEN9083"
 203 ></A
 204 ><H3
 205 ><A
 206 NAME="GNOME-VFS-CANCELLATION-NEW"
 207 ></A
 208 >gnome_vfs_cancellation_new ()</H3
 209 ><TABLE
 210 BORDER="0"
 211 BGCOLOR="#D6E8FF"
 212 WIDTH="100%"
 213 CELLPADDING="6"
 214 ><TR
 215 ><TD
 216 ><PRE
 217 CLASS="PROGRAMLISTING"
 218 >GnomeVFSCancellation* gnome_vfs_cancellation_new
 219                                             (void);</PRE
 220 ></TD
 221 ></TR
 222 ></TABLE
 223 ><P
 224 >Create a new GnomeVFSCancellation object for reporting cancellation to a
 225 GNOME VFS module.</P
 226 ><P
 227 ></P
 228 ><DIV
 229 CLASS="INFORMALTABLE"
 230 ><A
 231 NAME="AEN9090"
 232 ></A
 233 ><P
 234 ></P
 235 ><TABLE
 236 BORDER="0"
 237 WIDTH="100%"
 238 BGCOLOR="#FFD0D0"
 239 CELLSPACING="0"
 240 CELLPADDING="4"
 241 CLASS="CALSTABLE"
 242 ><TBODY
 243 ><TR
 244 ><TD
 245 WIDTH="20%"
 246 ALIGN="RIGHT"
 247 VALIGN="TOP"
 248 ><I
 249 CLASS="EMPHASIS"
 250 >Returns</I
 251 > :</TD
 252 ><TD
 253 WIDTH="80%"
 254 ALIGN="LEFT"
 255 VALIGN="TOP"
 256 > A pointer to the new GnomeVFSCancellation object.</TD
 257 ></TR
 258 ></TBODY
 259 ></TABLE
 260 ><P
 261 ></P
 262 ></DIV
 263 ></DIV
 264 ><HR><DIV
 265 CLASS="REFSECT2"
 266 ><A
 267 NAME="AEN9099"
 268 ></A
 269 ><H3
 270 ><A
 271 NAME="GNOME-VFS-CANCELLATION-DESTROY"
 272 ></A
 273 >gnome_vfs_cancellation_destroy ()</H3
 274 ><TABLE
 275 BORDER="0"
 276 BGCOLOR="#D6E8FF"
 277 WIDTH="100%"
 278 CELLPADDING="6"
 279 ><TR
 280 ><TD
 281 ><PRE
 282 CLASS="PROGRAMLISTING"
 283 >void        gnome_vfs_cancellation_destroy  (GnomeVFSCancellation *cancellation);</PRE
 284 ></TD
 285 ></TR
 286 ></TABLE
 287 ><P
 288 >Destroy <TT
 289 CLASS="PARAMETER"
 290 ><I
 291 >cancellation</I
 292 ></TT
 293 >.</P
 294 ><P
 295 ></P
 296 ><DIV
 297 CLASS="INFORMALTABLE"
 298 ><A
 299 NAME="AEN9107"
 300 ></A
 301 ><P
 302 ></P
 303 ><TABLE
 304 BORDER="0"
 305 WIDTH="100%"
 306 BGCOLOR="#FFD0D0"
 307 CELLSPACING="0"
 308 CELLPADDING="4"
 309 CLASS="CALSTABLE"
 310 ><TBODY
 311 ><TR
 312 ><TD
 313 WIDTH="20%"
 314 ALIGN="RIGHT"
 315 VALIGN="TOP"
 316 ><TT
 317 CLASS="PARAMETER"
 318 ><I
 319 >cancellation</I
 320 ></TT
 321 >&nbsp;:</TD
 322 ><TD
 323 WIDTH="80%"
 324 ALIGN="LEFT"
 325 VALIGN="TOP"
 326 > A GnomeVFSCancellation object</TD
 327 ></TR
 328 ></TBODY
 329 ></TABLE
 330 ><P
 331 ></P
 332 ></DIV
 333 ></DIV
 334 ><HR><DIV
 335 CLASS="REFSECT2"
 336 ><A
 337 NAME="AEN9116"
 338 ></A
 339 ><H3
 340 ><A
 341 NAME="GNOME-VFS-CANCELLATION-CANCEL"
 342 ></A
 343 >gnome_vfs_cancellation_cancel ()</H3
 344 ><TABLE
 345 BORDER="0"
 346 BGCOLOR="#D6E8FF"
 347 WIDTH="100%"
 348 CELLPADDING="6"
 349 ><TR
 350 ><TD
 351 ><PRE
 352 CLASS="PROGRAMLISTING"
 353 >void        gnome_vfs_cancellation_cancel   (GnomeVFSCancellation *cancellation);</PRE
 354 ></TD
 355 ></TR
 356 ></TABLE
 357 ><P
 358 >Send a cancellation request through <TT
 359 CLASS="PARAMETER"
 360 ><I
 361 >cancellation</I
 362 ></TT
 363 >.</P
 364 ><P
 365 ></P
 366 ><DIV
 367 CLASS="INFORMALTABLE"
 368 ><A
 369 NAME="AEN9124"
 370 ></A
 371 ><P
 372 ></P
 373 ><TABLE
 374 BORDER="0"
 375 WIDTH="100%"
 376 BGCOLOR="#FFD0D0"
 377 CELLSPACING="0"
 378 CELLPADDING="4"
 379 CLASS="CALSTABLE"
 380 ><TBODY
 381 ><TR
 382 ><TD
 383 WIDTH="20%"
 384 ALIGN="RIGHT"
 385 VALIGN="TOP"
 386 ><TT
 387 CLASS="PARAMETER"
 388 ><I
 389 >cancellation</I
 390 ></TT
 391 >&nbsp;:</TD
 392 ><TD
 393 WIDTH="80%"
 394 ALIGN="LEFT"
 395 VALIGN="TOP"
 396 > A GnomeVFSCancellation object</TD
 397 ></TR
 398 ></TBODY
 399 ></TABLE
 400 ><P
 401 ></P
 402 ></DIV
 403 ></DIV
 404 ><HR><DIV
 405 CLASS="REFSECT2"
 406 ><A
 407 NAME="AEN9133"
 408 ></A
 409 ><H3
 410 ><A
 411 NAME="GNOME-VFS-CANCELLATION-CHECK"
 412 ></A
 413 >gnome_vfs_cancellation_check ()</H3
 414 ><TABLE
 415 BORDER="0"
 416 BGCOLOR="#D6E8FF"
 417 WIDTH="100%"
 418 CELLPADDING="6"
 419 ><TR
 420 ><TD
 421 ><PRE
 422 CLASS="PROGRAMLISTING"
 423 ><A
 424 HREF=../glib/glib-basic-types.html#GBOOLEAN
 425 >gboolean</A>    gnome_vfs_cancellation_check    (GnomeVFSCancellation *cancellation);</PRE
 426 ></TD
 427 ></TR
 428 ></TABLE
 429 ><P
 430 >Check for pending cancellation.</P
 431 ><P
 432 ></P
 433 ><DIV
 434 CLASS="INFORMALTABLE"
 435 ><A
 436 NAME="AEN9141"
 437 ></A
 438 ><P
 439 ></P
 440 ><TABLE
 441 BORDER="0"
 442 WIDTH="100%"
 443 BGCOLOR="#FFD0D0"
 444 CELLSPACING="0"
 445 CELLPADDING="4"
 446 CLASS="CALSTABLE"
 447 ><TBODY
 448 ><TR
 449 ><TD
 450 WIDTH="20%"
 451 ALIGN="RIGHT"
 452 VALIGN="TOP"
 453 ><TT
 454 CLASS="PARAMETER"
 455 ><I
 456 >cancellation</I
 457 ></TT
 458 >&nbsp;:</TD
 459 ><TD
 460 WIDTH="80%"
 461 ALIGN="LEFT"
 462 VALIGN="TOP"
 463 > A GnomeVFSCancellation object</TD
 464 ></TR
 465 ><TR
 466 ><TD
 467 WIDTH="20%"
 468 ALIGN="RIGHT"
 469 VALIGN="TOP"
 470 ><I
 471 CLASS="EMPHASIS"
 472 >Returns</I
 473 > :</TD
 474 ><TD
 475 WIDTH="80%"
 476 ALIGN="LEFT"
 477 VALIGN="TOP"
 478 > <TT
 479 CLASS="LITERAL"
 480 >TRUE</TT
 481 > if the operation should be interrupted.</TD
 482 ></TR
 483 ></TBODY
 484 ></TABLE
 485 ><P
 486 ></P
 487 ></DIV
 488 ></DIV
 489 ><HR><DIV
 490 CLASS="REFSECT2"
 491 ><A
 492 NAME="AEN9155"
 493 ></A
 494 ><H3
 495 ><A
 496 NAME="GNOME-VFS-CANCELLATION-ACK"
 497 ></A
 498 >gnome_vfs_cancellation_ack ()</H3
 499 ><TABLE
 500 BORDER="0"
 501 BGCOLOR="#D6E8FF"
 502 WIDTH="100%"
 503 CELLPADDING="6"
 504 ><TR
 505 ><TD
 506 ><PRE
 507 CLASS="PROGRAMLISTING"
 508 >void        gnome_vfs_cancellation_ack      (GnomeVFSCancellation *cancellation);</PRE
 509 ></TD
 510 ></TR
 511 ></TABLE
 512 ><P
 513 >Acknowledge a cancellation.  This should be called if
 514 `<A
 515 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-CHECK"
 516 >gnome_vfs_cancellation_check</A
 517 >()' returns <TT
 518 CLASS="LITERAL"
 519 >TRUE</TT
 520 > or if `select()' reports that
 521 input is available on the file descriptor returned by
 522 `<A
 523 HREF="gnome-vfs-cancellation.html#GNOME-VFS-CANCELLATION-GET-FD"
 524 >gnome_vfs_cancellation_get_fd</A
 525 >()'.</P
 526 ><P
 527 ></P
 528 ><DIV
 529 CLASS="INFORMALTABLE"
 530 ><A
 531 NAME="AEN9166"
 532 ></A
 533 ><P
 534 ></P
 535 ><TABLE
 536 BORDER="0"
 537 WIDTH="100%"
 538 BGCOLOR="#FFD0D0"
 539 CELLSPACING="0"
 540 CELLPADDING="4"
 541 CLASS="CALSTABLE"
 542 ><TBODY
 543 ><TR
 544 ><TD
 545 WIDTH="20%"
 546 ALIGN="RIGHT"
 547 VALIGN="TOP"
 548 ><TT
 549 CLASS="PARAMETER"
 550 ><I
 551 >cancellation</I
 552 ></TT
 553 >&nbsp;:</TD
 554 ><TD
 555 WIDTH="80%"
 556 ALIGN="LEFT"
 557 VALIGN="TOP"
 558 > A GnomeVFSCancellation object</TD
 559 ></TR
 560 ></TBODY
 561 ></TABLE
 562 ><P
 563 ></P
 564 ></DIV
 565 ></DIV
 566 ><HR><DIV
 567 CLASS="REFSECT2"
 568 ><A
 569 NAME="AEN9175"
 570 ></A
 571 ><H3
 572 ><A
 573 NAME="GNOME-VFS-CANCELLATION-GET-FD"
 574 ></A
 575 >gnome_vfs_cancellation_get_fd ()</H3
 576 ><TABLE
 577 BORDER="0"
 578 BGCOLOR="#D6E8FF"
 579 WIDTH="100%"
 580 CELLPADDING="6"
 581 ><TR
 582 ><TD
 583 ><PRE
 584 CLASS="PROGRAMLISTING"
 585 ><A
 586 HREF=../glib/glib-basic-types.html#GINT
 587 >gint</A>        gnome_vfs_cancellation_get_fd   (GnomeVFSCancellation *cancellation);</PRE
 588 ></TD
 589 ></TR
 590 ></TABLE
 591 ><P
 592 >Get a file descriptor -based notificator for <TT
 593 CLASS="PARAMETER"
 594 ><I
 595 >cancellation</I
 596 ></TT
 597 >.  When
 598 <TT
 599 CLASS="PARAMETER"
 600 ><I
 601 >cancellation</I
 602 ></TT
 603 > receives a cancellation request, a character will be made
 604 available on the returned file descriptor for input.</P
 605 ><P
 606 >This is very useful for detecting cancellation during I/O operations: you
 607 can use the `select()' call to check for available input/output on the file
 608 you are reading/writing, and on the notificator's file descriptor at the
 609 same time.  If a data is available on the notificator's file descriptor, you
 610 know you have to cancel the read/write operation.</P
 611 ><P
 612 ></P
 613 ><DIV
 614 CLASS="INFORMALTABLE"
 615 ><A
 616 NAME="AEN9187"
 617 ></A
 618 ><P
 619 ></P
 620 ><TABLE
 621 BORDER="0"
 622 WIDTH="100%"
 623 BGCOLOR="#FFD0D0"
 624 CELLSPACING="0"
 625 CELLPADDING="4"
 626 CLASS="CALSTABLE"
 627 ><TBODY
 628 ><TR
 629 ><TD
 630 WIDTH="20%"
 631 ALIGN="RIGHT"
 632 VALIGN="TOP"
 633 ><TT
 634 CLASS="PARAMETER"
 635 ><I
 636 >cancellation</I
 637 ></TT
 638 >&nbsp;:</TD
 639 ><TD
 640 WIDTH="80%"
 641 ALIGN="LEFT"
 642 VALIGN="TOP"
 643 > A GnomeVFSCancellation object</TD
 644 ></TR
 645 ><TR
 646 ><TD
 647 WIDTH="20%"
 648 ALIGN="RIGHT"
 649 VALIGN="TOP"
 650 ><I
 651 CLASS="EMPHASIS"
 652 >Returns</I
 653 > :</TD
 654 ><TD
 655 WIDTH="80%"
 656 ALIGN="LEFT"
 657 VALIGN="TOP"
 658 > the notificator's file descriptor.</TD
 659 ></TR
 660 ></TBODY
 661 ></TABLE
 662 ><P
 663 ></P
 664 ></DIV
 665 ></DIV
 666 ></DIV
 667 ><DIV
 668 CLASS="NAVFOOTER"
 669 ><BR
 670 CLEAR="all"><BR><TABLE
 671 WIDTH="100%"
 672 BORDER="0"
 673 BGCOLOR="#000000"
 674 CELLPADDING="1"
 675 CELLSPACING="0"
 676 ><TR
 677 ><TD
 678 WIDTH="25%"
 679 BGCOLOR="#C00000"
 680 ALIGN="left"
 681 ><A
 682 HREF="everything-else.html"
 683 ><FONT
 684 COLOR="#FFFFFF"
 685 SIZE="3"
 686 ><B
 687 >&#60;&#60;&#60; Previous Page</B
 688 ></FONT
 689 ></A
 690 ></TD
 691 ><TD
 692 WIDTH="25%"
 693 BGCOLOR="#0000C0"
 694 ALIGN="center"
 695 ><FONT
 696 COLOR="#FFFFFF"
 697 SIZE="3"
 698 ><B
 699 ><A
 700 HREF="index.html"
 701 ><FONT
 702 COLOR="#FFFFFF"
 703 SIZE="3"
 704 ><B
 705 >Home</B
 706 ></FONT
 707 ></A
 708 ></B
 709 ></FONT
 710 ></TD
 711 ><TD
 712 WIDTH="25%"
 713 BGCOLOR="#00C000"
 714 ALIGN="center"
 715 ><FONT
 716 COLOR="#FFFFFF"
 717 SIZE="3"
 718 ><B
 719 ><A
 720 HREF="everything-else.html"
 721 ><FONT
 722 COLOR="#FFFFFF"
 723 SIZE="3"
 724 ><B
 725 >Up</B
 726 ></FONT
 727 ></A
 728 ></B
 729 ></FONT
 730 ></TD
 731 ><TD
 732 WIDTH="25%"
 733 BGCOLOR="#C00000"
 734 ALIGN="right"
 735 ><A
 736 HREF="gnome-vfs-configuration.html"
 737 ><FONT
 738 COLOR="#FFFFFF"
 739 SIZE="3"
 740 ><B
 741 >Next Page &#62;&#62;&#62;</B
 742 ></FONT
 743 ></A
 744 ></TD
 745 ></TR
 746 ><TR
 747 ><TD
 748 COLSPAN="2"
 749 ALIGN="left"
 750 ><FONT
 751 COLOR="#FFFFFF"
 752 SIZE="3"
 753 ><B
 754 >Other APIs</B
 755 ></FONT
 756 ></TD
 757 ><TD
 758 COLSPAN="2"
 759 ALIGN="right"
 760 ><FONT
 761 COLOR="#FFFFFF"
 762 SIZE="3"
 763 ><B
 764 >Configuration</B
 765 ></FONT
 766 ></TD
 767 ></TR
 768 ></TABLE
 769 ></DIV
 770 ></BODY
 771 ></HTML
 772 >