HDBC-1.0.1: doc/Database-HDBC-DriverUtils.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Database.HDBC.DriverUtils</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>Haskell Database Connectivity (HDBC)</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Database.HDBC.DriverUtils</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>provisional</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>John Goerzen <jgoerzen@complete.org></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>Utilities for database backend drivers.
</P
><P
>Please note: this module is intended for authors of database driver libraries
only. Authors of applications using HDBC should use <TT
><A HREF="Database.html#t%3AHDBC"
>HDBC</A
></TT
>
exclusively.
</P
><P
>Written by John Goerzen, jgoerzen@complete.org
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AChildList"
>ChildList</A
> = MVar [Weak <A HREF="Database-HDBC-Types.html#t%3AStatement"
>Statement</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcloseAllChildren"
>closeAllChildren</A
> :: <A HREF="Database-HDBC-DriverUtils.html#t%3AChildList"
>ChildList</A
> -> IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddChild"
>addChild</A
> :: <A HREF="Database-HDBC-DriverUtils.html#t%3AChildList"
>ChildList</A
> -> <A HREF="Database-HDBC-Types.html#t%3AStatement"
>Statement</A
> -> IO ()</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t%3AChildList"
></A
><B
>ChildList</B
> = MVar [Weak <A HREF="Database-HDBC-Types.html#t%3AStatement"
>Statement</A
>]</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AcloseAllChildren"
></A
><B
>closeAllChildren</B
> :: <A HREF="Database-HDBC-DriverUtils.html#t%3AChildList"
>ChildList</A
> -> IO ()</TD
></TR
><TR
><TD CLASS="doc"
><P
>Close all children. Intended to be called by the <TT
><A HREF="Database-HDBC-Types.html#v%3Adisconnect"
>disconnect</A
></TT
> function
in <TT
><A HREF="Database-HDBC-Types.html#t%3AConnection"
>Connection</A
></TT
>.
</P
><P
>There may be a potential race condition wherein a call to newSth at the same
time as a call to this function may result in the new child not being closed.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AaddChild"
></A
><B
>addChild</B
> :: <A HREF="Database-HDBC-DriverUtils.html#t%3AChildList"
>ChildList</A
> -> <A HREF="Database-HDBC-Types.html#t%3AStatement"
>Statement</A
> -> IO ()</TD
></TR
><TR
><TD CLASS="doc"
>Adds a new child to the existing list. Also takes care of registering
a finalizer for it, to remove it from the list when possible.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 0.7</TD
></TR
></TABLE
></BODY
></HTML
>