<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.mongodb-driver-session" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The MongoDB\Driver\Session class</title>
 <titleabbrev>MongoDB\Driver\Session</titleabbrev>

 <partintro>

<!-- {{{ MongoDB\Driver\Session intro -->
  <section xml:id="mongodb-driver-session.intro">
   &reftitle.intro;
   <para>
    The <classname>MongoDB\Driver\Session</classname> class represents a
    client session and is returned by
    <methodname>MongoDB\Driver\Manager::startSession</methodname>. Commands,
    queries, and write operations may then be associated the session.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="mongodb-driver-session.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoDB\Driver\Session</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <modifier>final</modifier>
     <ooclass>
      <classname>MongoDB\Driver\Session</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-session.constants.transaction-none">MongoDB\Driver\Session::TRANSACTION_NONE</varname>
     <initializer>none</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-session.constants.transaction-starting">MongoDB\Driver\Session::TRANSACTION_STARTING</varname>
     <initializer>starting</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-session.constants.transaction-in-progress">MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS</varname>
     <initializer>in_progress</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-session.constants.transaction-committed">MongoDB\Driver\Session::TRANSACTION_COMMITTED</varname>
     <initializer>committed</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>string</type>
     <varname linkend="mongodb-driver-session.constants.transaction-aborted">MongoDB\Driver\Session::TRANSACTION_ABORTED</varname>
     <initializer>aborted</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-session')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

  <!-- {{{ MongoDB\Driver\Session constants -->
  <section xml:id="mongodb-driver-session.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="mongodb-driver-session.constants.transaction-none">
     <term><constant>MongoDB\Driver\Session::TRANSACTION_NONE</constant></term>
     <listitem>
      <para>
       There is no transaction in progress.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-session.constants.transaction-starting">
     <term><constant>MongoDB\Driver\Session::TRANSACTION_STARTING</constant></term>
     <listitem>
      <para>
       A transaction has been started, but no operation has been sent to the server.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-session.constants.transaction-in-progress">
     <term><constant>MongoDB\Driver\Session::TRANSACTION_IN_PROGRESS</constant></term>
     <listitem>
      <para>
       A transaction is in progress.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-session.constants.transaction-committed">
     <term><constant>MongoDB\Driver\Session::TRANSACTION_COMMITTED</constant></term>
     <listitem>
      <para>
       The transaction was committed.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="mongodb-driver-session.constants.transaction-aborted">
     <term><constant>MongoDB\Driver\Session::TRANSACTION_ABORTED</constant></term>
     <listitem>
      <para>
       The transaction was aborted.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
  <!-- }}} -->

 </partintro>

 &reference.mongodb.mongodb.driver.entities.session;

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
