Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 6c21d55247420ace69cad1d05267fc34 > files > 302

pcsc-lite-doc-1.7.2-4.fc15.noarch.rpm

<!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>pcsc-lite: winscard_msg_srv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">pcsc-lite&#160;<span id="projectnumber">1.7.2</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="dir_7a4553ee0c3b13d0e595a5d1659110a6.html">src</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">winscard_msg_srv.c File Reference</div>  </div>
</div>
<div class="contents">

<p>client/server communication (on the server side only)  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;config.h&quot;</code><br/>
<code>#include &lt;fcntl.h&gt;</code><br/>
<code>#include &lt;unistd.h&gt;</code><br/>
<code>#include &lt;sys/types.h&gt;</code><br/>
<code>#include &lt;sys/stat.h&gt;</code><br/>
<code>#include &lt;sys/socket.h&gt;</code><br/>
<code>#include &lt;sys/time.h&gt;</code><br/>
<code>#include &lt;sys/un.h&gt;</code><br/>
<code>#include &lt;sys/ioctl.h&gt;</code><br/>
<code>#include &lt;errno.h&gt;</code><br/>
<code>#include &lt;stdio.h&gt;</code><br/>
<code>#include &lt;time.h&gt;</code><br/>
<code>#include &lt;string.h&gt;</code><br/>
<code>#include &quot;misc.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="pcscd_8h_source.html">pcscd.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="winscard_8h_source.html">winscard.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="debuglog_8h_source.html">debuglog.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="winscard__msg_8h_source.html">winscard_msg.h</a>&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for winscard_msg_srv.c:</div>
<div class="dyncontent">
<div class="center"><img src="winscard__msg__srv_8c__incl.png" border="0" usemap="#winscard__msg__srv_8c" alt=""/></div>
<map name="winscard__msg__srv_8c" id="winscard__msg__srv_8c">
<area shape="rect" id="node29" href="misc_8h_source.html" title="misc.h" alt="" coords="1259,83,1320,112"/><area shape="rect" id="node31" href="pcscd_8h.html" title="This keeps a list of defines for pcsc&#45;lite." alt="" coords="1344,83,1411,112"/><area shape="rect" id="node33" href="winscard_8h.html" title="This handles smartcard reader communications." alt="" coords="1435,83,1520,112"/><area shape="rect" id="node39" href="debuglog_8h.html" title="This handles debugging." alt="" coords="1544,83,1629,112"/><area shape="rect" id="node41" href="winscard__msg_8h.html" title="This defines some structures and #defines to be used over the transport layer." alt="" coords="1653,83,1771,112"/><area shape="rect" id="node35" href="pcsclite_8h.html" title="This keeps a list of defines for pcsc&#45;lite." alt="" coords="1439,160,1516,189"/><area shape="rect" id="node37" href="wintypes_8h.html" title="This keeps a list of Windows(R) types." alt="" coords="1435,237,1520,267"/></map>
</div>
</div>
<p><a href="winscard__msg__srv_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg__srv_8c.html#a7c421010b7e933a8ed46927e5b9316e8">ProcessCommonChannelRequest</a> (uint32_t *pdwClientID)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts a Client connection.  <a href="#a7c421010b7e933a8ed46927e5b9316e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">INTERNAL int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg__srv_8c.html#a061a490f5d2103751eb6b64573b5fb9d">InitializeSocket</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares the communication channel used by the server to talk to the clients.  <a href="#a061a490f5d2103751eb6b64573b5fb9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">INTERNAL int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg__srv_8c.html#a187cf841551d3e7b97e23d73067ec2d3">ProcessEventsServer</a> (uint32_t *pdwClientID)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks for messages sent by clients.  <a href="#a187cf841551d3e7b97e23d73067ec2d3"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a840eb2cc63fe5b38ec8edb835bc7c40c"></a><!-- doxytag: member="winscard_msg_srv.c::commonSocket" ref="a840eb2cc63fe5b38ec8edb835bc7c40c" args="" -->
static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg__srv_8c.html#a840eb2cc63fe5b38ec8edb835bc7c40c">commonSocket</a> = 0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Socket to a file, used for clients-server comminication. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c1bcbba3beb47ba1f62a370bd7ec32c"></a><!-- doxytag: member="winscard_msg_srv.c::AraKiri" ref="a7c1bcbba3beb47ba1f62a370bd7ec32c" args="" -->
char&#160;</td><td class="memItemRight" valign="bottom"><b>AraKiri</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>client/server communication (on the server side only) </p>
<p>A file based socket (<code>commonSocket</code>) is used to send/receive only messages among clients and server.<br/>
 The messages' data are passed throw a memory mapped <a href="file:">file:</a> <code>sharedSegmentMsg</code>. </p>

<p>Definition in file <a class="el" href="winscard__msg__srv_8c_source.html">winscard_msg_srv.c</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a061a490f5d2103751eb6b64573b5fb9d"></a><!-- doxytag: member="winscard_msg_srv.c::InitializeSocket" ref="a061a490f5d2103751eb6b64573b5fb9d" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">INTERNAL int32_t InitializeSocket </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Prepares the communication channel used by the server to talk to the clients. </p>
<p>This is called by the server to create a socket for local IPC with the clients. The socket is associated to the file <code>PCSCLITE_CSOCK_NAME</code>. Each client will open a connection to this socket.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success </td></tr>
    <tr><td class="paramname">-1</td><td>Can not create the socket. </td></tr>
    <tr><td class="paramname">-1</td><td>Can not bind the socket to the file <code>PCSCLITE_CSOCK_NAME</code>. </td></tr>
    <tr><td class="paramname">-1</td><td>Can not put the socket in listen mode. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="winscard__msg__srv_8c_source.html#l00098">98</a> of file <a class="el" href="winscard__msg__srv_8c_source.html">winscard_msg_srv.c</a>.</p>

<p>References <a class="el" href="winscard__msg__srv_8c_source.html#l00049">commonSocket</a>.</p>

</div>
</div>
<a class="anchor" id="a7c421010b7e933a8ed46927e5b9316e8"></a><!-- doxytag: member="winscard_msg_srv.c::ProcessCommonChannelRequest" ref="a7c421010b7e933a8ed46927e5b9316e8" args="(uint32_t *pdwClientID)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int ProcessCommonChannelRequest </td>
          <td>(</td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>pdwClientID</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Accepts a Client connection. </p>
<p>Called by <code><a class="el" href="winscard__msg__srv_8c.html#a187cf841551d3e7b97e23d73067ec2d3" title="Looks for messages sent by clients.">ProcessEventsServer()</a></code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">pdwClientID</td><td>Connection ID used to reference the Client.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success. </td></tr>
    <tr><td class="paramname">-1</td><td>Can not establish the connection. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="winscard__msg__srv_8c_source.html#l00063">63</a> of file <a class="el" href="winscard__msg__srv_8c_source.html">winscard_msg_srv.c</a>.</p>

<p>References <a class="el" href="winscard__msg__srv_8c_source.html#l00049">commonSocket</a>.</p>

<p>Referenced by <a class="el" href="winscard__msg__srv_8c_source.html#l00156">ProcessEventsServer()</a>.</p>

</div>
</div>
<a class="anchor" id="a187cf841551d3e7b97e23d73067ec2d3"></a><!-- doxytag: member="winscard_msg_srv.c::ProcessEventsServer" ref="a187cf841551d3e7b97e23d73067ec2d3" args="(uint32_t *pdwClientID)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">INTERNAL int32_t ProcessEventsServer </td>
          <td>(</td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>pdwClientID</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Looks for messages sent by clients. </p>
<p>This is called by the Server's function <code><a class="el" href="pcscdaemon_8c.html#aa4c7ad16505a34733683cf8c08241783" title="The Server&#39;s Message Queue Listener function.">SVCServiceRunLoop()</a></code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">pdwClientID</td><td>Connection ID used to reference the Client.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success. </td></tr>
    <tr><td class="paramname">-1</td><td>Error accessing the communication channel. </td></tr>
    <tr><td class="paramname">-2</td><td>EINTR </td></tr>
    <tr><td class="paramname">2</td><td>Timeout. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="winscard__msg__srv_8c_source.html#l00156">156</a> of file <a class="el" href="winscard__msg__srv_8c_source.html">winscard_msg_srv.c</a>.</p>

<p>References <a class="el" href="winscard__msg__srv_8c_source.html#l00049">commonSocket</a>, and <a class="el" href="winscard__msg__srv_8c_source.html#l00063">ProcessCommonChannelRequest()</a>.</p>

<p>Referenced by <a class="el" href="pcscdaemon_8c_source.html#l00079">SVCServiceRunLoop()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="winscard__msg__srv_8c_a187cf841551d3e7b97e23d73067ec2d3_cgraph.png" border="0" usemap="#winscard__msg__srv_8c_a187cf841551d3e7b97e23d73067ec2d3_cgraph" alt=""/></div>
<map name="winscard__msg__srv_8c_a187cf841551d3e7b97e23d73067ec2d3_cgraph" id="winscard__msg__srv_8c_a187cf841551d3e7b97e23d73067ec2d3_cgraph">
<area shape="rect" id="node3" href="winscard__msg__srv_8c.html#a7c421010b7e933a8ed46927e5b9316e8" title="Accepts a Client connection." alt="" coords="204,5,423,35"/></map>
</div>
</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for pcsc-lite by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>