Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > ce0cb4aec597dde3226843045ded906f > files > 183

freetds-doc-0.91-1.fc14.x86_64.rpm

<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FreeTDS API: /home/jklowden/releases/freetds-0.91/src/pool/pool.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>/home/jklowden/releases/freetds-0.91/src/pool/pool.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* TDSPool - Connection pooling for TDS based databases</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2001 Brian Bruns</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00005"></a>00005 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00006"></a>00006 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00007"></a>00007 <span class="comment"> * (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00012"></a>00012 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00015"></a>00015 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00016"></a>00016 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00017"></a>00017 <span class="comment"> *</span>
<a name="l00018"></a>00018 <span class="comment"> */</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _pool_h_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _pool_h_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#if HAVE_SYS_TYPES_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#include &lt;sys/types.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#if HAVE_NETINET_IN_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#endif</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="comment">/* </span>
<a name="l00032"></a>00032 <span class="comment"> * POSIX says fd_set type may be defined in either sys/select.h or sys/time.h. </span>
<a name="l00033"></a>00033 <span class="comment"> */</span>
<a name="l00034"></a>00034 <span class="preprocessor">#if HAVE_SYS_TIME_H</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#include &lt;sys/time.h&gt;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#endif</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include &quot;<a class="code" href="a00159.html" title="Main include file for libtds.">tds.h</a>&quot;</span>
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <a class="code" href="a00286.html#gabf3d9f8d5fe5089e1f34594843486b75">TDS_RCSID</a>(pool_h, <span class="stringliteral">&quot;$Id: pool.h,v 1.15 2006/06/12 19:45:59 freddy77 Exp $&quot;</span>);
<a name="l00041"></a>00041 
<a name="l00042"></a>00042 <span class="comment">/* defines */</span>
<a name="l00043"></a>00043 <span class="preprocessor">#define PGSIZ 2048</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define BLOCKSIZ 512</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define MAX_POOL_USERS 1024</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="comment">/* enums and typedefs */</span>
<a name="l00048"></a>00048 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050         TDS_SRV_LOGIN,
<a name="l00051"></a>00051         TDS_SRV_IDLE,
<a name="l00052"></a>00052         TDS_SRV_QUERY,
<a name="l00053"></a>00053         TDS_SRV_WAIT,           <span class="comment">/* if no members are free wait */</span>
<a name="l00054"></a>00054         TDS_SRV_CANCEL,
<a name="l00055"></a>00055         TDS_SRV_DEAD
<a name="l00056"></a>00056 } TDS_USER_STATE;
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="comment">/* forward declaration */</span>
<a name="l00059"></a>00059 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00116.html">tds_pool_member</a> <a class="code" href="a00116.html">TDS_POOL_MEMBER</a>;
<a name="l00060"></a>00060 
<a name="l00061"></a>00061 
<a name="l00062"></a><a class="code" href="a00117.html">00062</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00117.html">tds_pool_user</a>
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064         <a class="code" href="a00122.html" title="Information for a server connection.">TDSSOCKET</a> *tds;
<a name="l00065"></a>00065         TDS_USER_STATE user_state;
<a name="l00066"></a>00066         <a class="code" href="a00116.html">TDS_POOL_MEMBER</a> *assigned_member;
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 <a class="code" href="a00117.html">TDS_POOL_USER</a>;
<a name="l00069"></a>00069 
<a name="l00070"></a><a class="code" href="a00116.html">00070</a> <span class="keyword">struct </span><a class="code" href="a00116.html">tds_pool_member</a>
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072         <a class="code" href="a00122.html" title="Information for a server connection.">TDSSOCKET</a> *tds;
<a name="l00073"></a>00073         <span class="comment">/* sometimes we get a partial packet */</span>
<a name="l00074"></a>00074         <span class="keywordtype">int</span> need_more;
<a name="l00075"></a>00075         <span class="keywordtype">int</span> state;
<a name="l00076"></a>00076         time_t last_used_tm;
<a name="l00077"></a>00077         <a class="code" href="a00117.html">TDS_POOL_USER</a> *current_user;
<a name="l00078"></a>00078         <span class="comment">/* </span>
<a name="l00079"></a>00079 <span class="comment">         * these variables are used for tracking the state of the TDS protocol </span>
<a name="l00080"></a>00080 <span class="comment">         * so we know when to return the state to TDS_IDLE.</span>
<a name="l00081"></a>00081 <span class="comment">         */</span>
<a name="l00082"></a>00082         <span class="keywordtype">int</span> num_bytes_left;
<a name="l00083"></a>00083         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> fragment[PGSIZ];
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085 
<a name="l00086"></a><a class="code" href="a00115.html">00086</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00115.html">tds_pool</a>
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088         <span class="keywordtype">char</span> *name;
<a name="l00089"></a>00089         <span class="keywordtype">char</span> *user;
<a name="l00090"></a>00090         <span class="keywordtype">char</span> *password;
<a name="l00091"></a>00091         <span class="keywordtype">char</span> *server;
<a name="l00092"></a>00092         <span class="keywordtype">char</span> *database;
<a name="l00093"></a>00093         <span class="keywordtype">int</span> port;
<a name="l00094"></a>00094         <span class="keywordtype">int</span> max_member_age;     <span class="comment">/* in seconds */</span>
<a name="l00095"></a>00095         <span class="keywordtype">int</span> min_open_conn;
<a name="l00096"></a>00096         <span class="keywordtype">int</span> max_open_conn;
<a name="l00097"></a>00097         <span class="keywordtype">int</span> num_members;
<a name="l00098"></a>00098         <a class="code" href="a00116.html">TDS_POOL_MEMBER</a> *members;
<a name="l00099"></a>00099         <span class="keywordtype">int</span> max_users;
<a name="l00100"></a>00100         <a class="code" href="a00117.html">TDS_POOL_USER</a> *users;
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102 <a class="code" href="a00115.html">TDS_POOL</a>;
<a name="l00103"></a>00103 
<a name="l00104"></a>00104 <span class="comment">/* prototypes */</span>
<a name="l00105"></a>00105 
<a name="l00106"></a>00106 <span class="comment">/* member.c */</span>
<a name="l00107"></a>00107 <span class="keywordtype">int</span> pool_process_members(<a class="code" href="a00115.html">TDS_POOL</a> * pool, fd_set * fds);
<a name="l00108"></a>00108 <a class="code" href="a00116.html">TDS_POOL_MEMBER</a> *pool_find_idle_member(<a class="code" href="a00115.html">TDS_POOL</a> * pool);
<a name="l00109"></a>00109 <span class="keywordtype">void</span> pool_mbr_init(<a class="code" href="a00115.html">TDS_POOL</a> * pool);
<a name="l00110"></a>00110 <span class="keywordtype">void</span> pool_free_member(<a class="code" href="a00116.html">TDS_POOL_MEMBER</a> * pmbr);
<a name="l00111"></a>00111 <span class="keywordtype">void</span> pool_assign_member(<a class="code" href="a00116.html">TDS_POOL_MEMBER</a> * pmbr, <a class="code" href="a00117.html">TDS_POOL_USER</a> *puser);
<a name="l00112"></a>00112 <span class="keywordtype">void</span> pool_deassign_member(<a class="code" href="a00116.html">TDS_POOL_MEMBER</a> * pmbr);
<a name="l00113"></a>00113 <span class="keywordtype">void</span> pool_reset_member(<a class="code" href="a00116.html">TDS_POOL_MEMBER</a> * pmbr);
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 <span class="comment">/* user.c */</span>
<a name="l00116"></a>00116 <span class="keywordtype">int</span> pool_process_users(<a class="code" href="a00115.html">TDS_POOL</a> * pool, fd_set * fds);
<a name="l00117"></a>00117 <span class="keywordtype">void</span> pool_user_init(<a class="code" href="a00115.html">TDS_POOL</a> * pool);
<a name="l00118"></a>00118 <a class="code" href="a00117.html">TDS_POOL_USER</a> *pool_user_create(<a class="code" href="a00115.html">TDS_POOL</a> * pool, TDS_SYS_SOCKET s, <span class="keyword">struct</span> sockaddr_in *sin);
<a name="l00119"></a>00119 <span class="keywordtype">void</span> pool_free_user(<a class="code" href="a00117.html">TDS_POOL_USER</a> * puser);
<a name="l00120"></a>00120 <span class="keywordtype">void</span> pool_user_query(<a class="code" href="a00115.html">TDS_POOL</a> * pool, <a class="code" href="a00117.html">TDS_POOL_USER</a> * puser);
<a name="l00121"></a>00121 
<a name="l00122"></a>00122 <span class="comment">/* util.c */</span>
<a name="l00123"></a>00123 <span class="keywordtype">void</span> dump_buf(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">int</span> length);
<a name="l00124"></a>00124 <span class="keywordtype">void</span> dump_login(<a class="code" href="a00107.html">TDSLOGIN</a> * login);
<a name="l00125"></a>00125 <span class="keywordtype">void</span> die_if(<span class="keywordtype">int</span> expr, <span class="keyword">const</span> <span class="keywordtype">char</span> *msg);
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 <span class="comment">/* config.c */</span>
<a name="l00128"></a>00128 <span class="keywordtype">int</span> pool_read_conf_file(<span class="keywordtype">char</span> *poolname, <a class="code" href="a00115.html">TDS_POOL</a> * pool);
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 <span class="preprocessor">#endif</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 17 22:22:31 2011 for FreeTDS API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>