<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pcsc-lite: winscard_msg.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pcsc-lite
 <span id="projectnumber">1.8.26</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">winscard_msg.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This is responsible for client/server communication.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "config.h"</code><br />
<code>#include <fcntl.h></code><br />
<code>#include <unistd.h></code><br />
<code>#include <sys/types.h></code><br />
<code>#include <sys/stat.h></code><br />
<code>#include <sys/socket.h></code><br />
<code>#include <sys/time.h></code><br />
<code>#include <sys/un.h></code><br />
<code>#include <sys/ioctl.h></code><br />
<code>#include <errno.h></code><br />
<code>#include <poll.h></code><br />
<code>#include <stdio.h></code><br />
<code>#include <time.h></code><br />
<code>#include <string.h></code><br />
<code>#include <stdlib.h></code><br />
<code>#include "misc.h"</code><br />
<code>#include "<a class="el" href="pcscd_8h_source.html">pcscd.h</a>"</code><br />
<code>#include "<a class="el" href="winscard_8h_source.html">winscard.h</a>"</code><br />
<code>#include "<a class="el" href="debuglog_8h_source.html">debuglog.h</a>"</code><br />
<code>#include "<a class="el" href="winscard__msg_8h_source.html">winscard_msg.h</a>"</code><br />
<code>#include "<a class="el" href="sys__generic_8h_source.html">sys_generic.h</a>"</code><br />
<code>#include "utils.h"</code><br />
</div>
<p><a href="winscard__msg_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac337901f5606f0cf6f8e9867ef3fc1c4"><td class="memItemLeft" align="right" valign="top"><a id="ac337901f5606f0cf6f8e9867ef3fc1c4"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SOCK_CLOEXEC</b>   0</td></tr>
<tr class="separator:ac337901f5606f0cf6f8e9867ef3fc1c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af89f4d2d8177557601d0ebd71d4500bf"><td class="memItemLeft" align="right" valign="top"><a id="af89f4d2d8177557601d0ebd71d4500bf"></a>
#define </td><td class="memItemRight" valign="bottom"><b>member_size</b>(type, member)   sizeof(((type *)0)->member)</td></tr>
<tr class="separator:af89f4d2d8177557601d0ebd71d4500bf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a05e2e987d41cf83a2de0948064b9e232"><td class="memItemLeft" align="right" valign="top"><a id="a05e2e987d41cf83a2de0948064b9e232"></a>
char * </td><td class="memItemRight" valign="bottom"><b>getSocketName</b> (void)</td></tr>
<tr class="separator:a05e2e987d41cf83a2de0948064b9e232"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a616a7d779449d1dc6a8a5d925d8212b1"><td class="memItemLeft" align="right" valign="top">INTERNAL int </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#a616a7d779449d1dc6a8a5d925d8212b1">ClientSetupSession</a> (uint32_t *pdwClientID)</td></tr>
<tr class="memdesc:a616a7d779449d1dc6a8a5d925d8212b1"><td class="mdescLeft"> </td><td class="mdescRight">Prepares a communication channel for the client to talk to the server. <a href="#a616a7d779449d1dc6a8a5d925d8212b1">More...</a><br /></td></tr>
<tr class="separator:a616a7d779449d1dc6a8a5d925d8212b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9f1f305942fabf0861227000c1a9af5"><td class="memItemLeft" align="right" valign="top">INTERNAL void </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#ab9f1f305942fabf0861227000c1a9af5">ClientCloseSession</a> (uint32_t dwClientID)</td></tr>
<tr class="memdesc:ab9f1f305942fabf0861227000c1a9af5"><td class="mdescLeft"> </td><td class="mdescRight">Closes the socket used by the client to communicate with the server. <a href="#ab9f1f305942fabf0861227000c1a9af5">More...</a><br /></td></tr>
<tr class="separator:ab9f1f305942fabf0861227000c1a9af5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d872cca20f53a9758a6f0baa5f05c51"><td class="memItemLeft" align="right" valign="top">INTERNAL LONG </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#a7d872cca20f53a9758a6f0baa5f05c51">MessageReceiveTimeout</a> (uint32_t command, void *buffer_void, uint64_t buffer_size, int32_t filedes, long timeOut)</td></tr>
<tr class="memdesc:a7d872cca20f53a9758a6f0baa5f05c51"><td class="mdescLeft"> </td><td class="mdescRight">Called by the Client to get the reponse from the server or vice-versa. <a href="#a7d872cca20f53a9758a6f0baa5f05c51">More...</a><br /></td></tr>
<tr class="separator:a7d872cca20f53a9758a6f0baa5f05c51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a922f8b35802c2449f80a9bd02a25b05b"><td class="memItemLeft" align="right" valign="top">INTERNAL LONG </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#a922f8b35802c2449f80a9bd02a25b05b">MessageSendWithHeader</a> (uint32_t command, uint32_t dwClientID, uint64_t size, void *data_void)</td></tr>
<tr class="memdesc:a922f8b35802c2449f80a9bd02a25b05b"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for the <a class="el" href="winscard__msg_8c.html#aacd09139ce5667d3b651de29c0d62057" title="Sends a menssage from client to server or vice-versa.">MessageSend()</a> function. <a href="#a922f8b35802c2449f80a9bd02a25b05b">More...</a><br /></td></tr>
<tr class="separator:a922f8b35802c2449f80a9bd02a25b05b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacd09139ce5667d3b651de29c0d62057"><td class="memItemLeft" align="right" valign="top">INTERNAL LONG </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#aacd09139ce5667d3b651de29c0d62057">MessageSend</a> (void *buffer_void, uint64_t buffer_size, int32_t filedes)</td></tr>
<tr class="memdesc:aacd09139ce5667d3b651de29c0d62057"><td class="mdescLeft"> </td><td class="mdescRight">Sends a menssage from client to server or vice-versa. <a href="#aacd09139ce5667d3b651de29c0d62057">More...</a><br /></td></tr>
<tr class="separator:aacd09139ce5667d3b651de29c0d62057"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbb09969d5d410393ae441b9a18c7a0c"><td class="memItemLeft" align="right" valign="top">INTERNAL LONG </td><td class="memItemRight" valign="bottom"><a class="el" href="winscard__msg_8c.html#adbb09969d5d410393ae441b9a18c7a0c">MessageReceive</a> (void *buffer_void, uint64_t buffer_size, int32_t filedes)</td></tr>
<tr class="memdesc:adbb09969d5d410393ae441b9a18c7a0c"><td class="mdescLeft"> </td><td class="mdescRight">Called by the Client to get the reponse from the server or vice-versa. <a href="#adbb09969d5d410393ae441b9a18c7a0c">More...</a><br /></td></tr>
<tr class="separator:adbb09969d5d410393ae441b9a18c7a0c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is responsible for client/server communication. </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 file: <code>sharedSegmentMsg</code>. </p>
<p class="definition">Definition in file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ab9f1f305942fabf0861227000c1a9af5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f1f305942fabf0861227000c1a9af5">◆ </a></span>ClientCloseSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL void ClientCloseSession </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dwClientID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the socket used by the client to communicate with the server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dwClientID</td><td>Client socket handle to be closed. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00175">175</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
<a id="a616a7d779449d1dc6a8a5d925d8212b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a616a7d779449d1dc6a8a5d925d8212b1">◆ </a></span>ClientSetupSession()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL int ClientSetupSession </td>
<td>(</td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>pdwClientID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepares a communication channel for the client to talk to the server. </p>
<p>This is called by the application to create a socket for local IPC with the server. The socket is associated to the file <code>PCSCLITE_CSOCK_NAME</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">pdwClientID</td><td>Client Connection ID.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>Success. </td></tr>
<tr><td class="paramname">-1</td><td><ul>
<li>Can not create the socket</li>
<li>or the socket can not open a connection</li>
<li>or can not set the socket to non-blocking. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00121">121</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
<a id="adbb09969d5d410393ae441b9a18c7a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbb09969d5d410393ae441b9a18c7a0c">◆ </a></span>MessageReceive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL LONG MessageReceive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer_void</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>filedes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the Client to get the reponse from the server or vice-versa. </p>
<p>Reads the message from the file <code>filedes</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">buffer_void</td><td>Message read. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer_size</td><td>Size to read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filedes</td><td>Socket handle.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SCARD_S_SUCCESS</td><td>Success. </td></tr>
<tr><td class="paramname">SCARD_F_COMM_ERROR</td><td><ul>
<li>Socket is closed</li>
<li>or a signal was received. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00457">457</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
<a id="a7d872cca20f53a9758a6f0baa5f05c51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d872cca20f53a9758a6f0baa5f05c51">◆ </a></span>MessageReceiveTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL LONG MessageReceiveTimeout </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer_void</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>filedes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeOut</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by the Client to get the reponse from the server or vice-versa. </p>
<p>Reads the message from the file <code>filedes</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>one of the <a class="el" href="winscard__msg_8h.html#add241284f0460327d523aec6e1cd17dc">pcsc_msg_commands</a> commands </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buffer_void</td><td>Message read. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer_size</td><td>Size to read </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filedes</td><td>Socket handle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeOut</td><td>Timeout in milliseconds.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SCARD_S_SUCCESS</td><td>Success. </td></tr>
<tr><td class="paramname">SCARD_E_TIMEOUT</td><td>Timeout. </td></tr>
<tr><td class="paramname">SCARD_F_COMM_ERROR</td><td><ul>
<li>Socket is closed</li>
<li>or a signal was received. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00197">197</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
<a id="aacd09139ce5667d3b651de29c0d62057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacd09139ce5667d3b651de29c0d62057">◆ </a></span>MessageSend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL LONG MessageSend </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer_void</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>filedes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a menssage from client to server or vice-versa. </p>
<p>Writes the message in the shared file <code>filedes</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer_void</td><td>Message to be sent. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer_size</td><td>Size of the message to send </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filedes</td><td>Socket handle.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">SCARD_S_SUCCESS</td><td>Success </td></tr>
<tr><td class="paramname">SCARD_E_TIMEOUT</td><td>Timeout. </td></tr>
<tr><td class="paramname">SCARD_F_COMM_ERROR</td><td><ul>
<li>Socket is closed</li>
<li>or a signal was received. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00357">357</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
<a id="a922f8b35802c2449f80a9bd02a25b05b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a922f8b35802c2449f80a9bd02a25b05b">◆ </a></span>MessageSendWithHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">INTERNAL LONG MessageSendWithHeader </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dwClientID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data_void</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper for the <a class="el" href="winscard__msg_8c.html#aacd09139ce5667d3b651de29c0d62057" title="Sends a menssage from client to server or vice-versa.">MessageSend()</a> function. </p>
<p>Called by clients to send messages to the server. The parameters <code>command</code> and <code>data</code> are set in the <code>sharedSegmentMsg</code> struct in order to be sent.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">command</td><td>Command to be sent. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dwClientID</td><td>Client socket handle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the message (<code>data</code>). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data_void</td><td>Data to be sent.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Same error codes as <a class="el" href="winscard__msg_8c.html#aacd09139ce5667d3b651de29c0d62057" title="Sends a menssage from client to server or vice-versa.">MessageSend()</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="winscard__msg_8c_source.html#l00320">320</a> of file <a class="el" href="winscard__msg_8c_source.html">winscard_msg.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 8 2020 17:42:35 for pcsc-lite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
c875c5048f444faf6c3a434137f1088a
>
files
>
213
