<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-matevfs-context">
  <refnamediv>
    <refname>matevfs.Context</refname>
    <refpurpose>Thread tracking and cancellation object</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>
    <classsynopsis language="python">
      <ooclass><classname>matevfs.Context</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-matevfs-context--get_cancellation">get_cancellation</link></methodname>
        <methodparam />
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-matevfs-context--check_cancellation">check_cancellation</link></methodname>
        <methodparam />
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-matevfs-context--cancel">cancel</link></methodname>
        <methodparam />
      </methodsynopsis>
    </classsynopsis>
  </refsect1>

  <refsect1>
    <title>Description</title>
    <para></para>
  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-matevfs-context--get_cancellation">
      <title>matevfs.Context.get_cancellation</title>
      <programlisting><methodsynopsis language="python">
          <methodname>get_cancellation</methodname>
          <methodparam />
        </methodsynopsis>
      </programlisting>
      <para>As far as I can tell, the python binding for this is incomplete.</para>
    </refsect2>

    <refsect2 id="method-matevfs-context--check_cancellation">
      <title>matevfs.Context.check_cancellation</title>
      <programlisting><methodsynopsis language="python">
          <methodname>check_cancellation</methodname>
          <methodparam />
        </methodsynopsis>
      </programlisting>
      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>:</term>
          <listitem><simpara><literal>TRUE</literal> if the context has been cancelled</simpara></listitem>
        </varlistentry>
      </variablelist>
      <para>Checks to see if this operation represented by this context has been cancelled.</para>
    </refsect2>

    <refsect2 id="method-matevfs-context--cancel">
      <title>matevfs.Context.cancel</title>
      <programlisting><methodsynopsis language="python">
          <methodname>cancel</methodname>
          <methodparam />
        </methodsynopsis>
      </programlisting>
      <para>Cancel the operation represented by this context.</para>
    </refsect2>
  </refsect1>
</refentry>
