Sophie

Sophie

distrib > Fedora > 17 > i386 > by-pkgid > f47ddb753435c655fc691eb594d59ce5 > files > 134

libgadu-doc-1.11.2-1.fc17.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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libgadu: Tokeny</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">libgadu
   &#160;<span id="projectnumber">1.11.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Wygenerowano przez Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Szukaj');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Strona&#160;główna</span></a></li>
      <li><a href="pages.html"><span>Dodatkowe&#160;strony</span></a></li>
      <li><a href="modules.html"><span>Moduły</span></a></li>
      <li><a href="annotated.html"><span>Struktury&#160;Danych</span></a></li>
      <li><a href="files.html"><span>Pliki</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Szukaj" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Struktury Danych</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Pliki</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Funkcje</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Zmienne</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Definicje typów</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Wyliczenia</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Wartości wyliczeń</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Definicje</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Grupay</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Strony</a></div>

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

<div class="header">
  <div class="summary">
<a href="#nested-classes">Struktury danych</a> &#124;
<a href="#func-members">Funkcje</a>  </div>
  <div class="headertitle">
<div class="title">Tokeny</div>  </div>
<div class="ingroups"><a class="el" href="group__services.html">Usługi dodatkowe</a></div></div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Struktury danych</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgg__token.html">gg_token</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token autoryzacji niektórych operacji HTTP.  <a href="structgg__token.html#details">Więcej...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Funkcje</h2></td></tr>
<tr class="memitem:ga64271e3505ae06d2e683f4298ac65edf"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structgg__http.html">gg_http</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__token.html#ga64271e3505ae06d2e683f4298ac65edf">gg_token</a> (int async)</td></tr>
<tr class="memdesc:ga64271e3505ae06d2e683f4298ac65edf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pobiera token do autoryzacji operacji na katalogu publicznym.  <a href="#ga64271e3505ae06d2e683f4298ac65edf"></a><br/></td></tr>
<tr class="memitem:ga662a93012568809b745d73bc9937ea7b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__token.html#ga662a93012568809b745d73bc9937ea7b">gg_token_watch_fd</a> (struct <a class="el" href="structgg__http.html">gg_http</a> *h)</td></tr>
<tr class="memdesc:ga662a93012568809b745d73bc9937ea7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia.  <a href="#ga662a93012568809b745d73bc9937ea7b"></a><br/></td></tr>
<tr class="memitem:gafc103504bf9e1c48ad5ec29eac8b4f0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__token.html#gafc103504bf9e1c48ad5ec29eac8b4f0f">gg_token_free</a> (struct <a class="el" href="structgg__http.html">gg_http</a> *h)</td></tr>
<tr class="memdesc:gafc103504bf9e1c48ad5ec29eac8b4f0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zwalnia zasoby po operacji pobierania tokenu.  <a href="#gafc103504bf9e1c48ad5ec29eac8b4f0f"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Opis szczegółowy</h2>
<p>W celu zarejestrowania konta lub zmiany hasła, należy pobrać z serwera token. Przy asynchronicznej operacji, po wywołaniu funkcji <code><a class="el" href="group__token.html#ga64271e3505ae06d2e683f4298ac65edf" title="Pobiera token do autoryzacji operacji na katalogu publicznym.">gg_token()</a></code> wynikową strukturę <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code> należy traktować tak jak każde połączenie HTTP. Po zakończeniu operacji asynchronicznej (<code>state</code> równe <code>GG_STATE_DONE</code>) lub wyjściu z funkcji <code><a class="el" href="group__token.html#ga64271e3505ae06d2e683f4298ac65edf" title="Pobiera token do autoryzacji operacji na katalogu publicznym.">gg_token()</a></code> w operacji synchronicznej, w polu <code>data</code> struktury będzie znajdował się wskaźnik na strukturą <code><a class="el" href="structgg__token.html" title="Token autoryzacji niektórych operacji HTTP.">gg_token</a></code> zawierającą informacje o tokenie. W polu <code>body</code> struktury <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code> znajdzie się obrazek tokenu o rozmiarze <code>body_size</code>. Aplikacja powinna wyświetlić token użytkownikowi w celu odczytania i przekazania treści, która następnie zostana przekazana do odpowiedniej funkcji wywołania usługi dodatkowej.</p>
<h1><a class="anchor" id="example"></a>
Przykład pobierania tokenu</h1>
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a> *token;</div>
<div class="line">FILE *f;</div>
<div class="line"></div>
<div class="line">token = <a class="code" href="group__token.html#ga64271e3505ae06d2e683f4298ac65edf" title="Pobiera token do autoryzacji operacji na katalogu publicznym.">gg_token</a>(0);</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">if</span> (!token) {</div>
<div class="line">    błąd(<span class="stringliteral">&quot;Błąd pobierania tokenu&quot;</span>);</div>
<div class="line">    exit(1);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line">plik = fopen(((<span class="keyword">struct</span> <a class="code" href="structgg__token.html" title="Token autoryzacji niektórych operacji HTTP.">gg_token</a> *) token-&gt;<a class="code" href="structgg__http.html#a735984d41155bc1032e09bece8f8d66d" title="Dane prywatne usługi HTTP.">data</a>)-&gt;tokenid, <span class="stringliteral">&quot;w&quot;</span>);</div>
<div class="line"></div>
<div class="line"><span class="keywordflow">if</span> (!plik) {</div>
<div class="line">    błąd(<span class="stringliteral">&quot;Błąd otwarcia pliku&quot;</span>);</div>
<div class="line">    <a class="code" href="group__token.html#gafc103504bf9e1c48ad5ec29eac8b4f0f" title="Zwalnia zasoby po operacji pobierania tokenu.">gg_token_free</a>(token);</div>
<div class="line">    exit(1);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line">fwrite(token-&gt;<a class="code" href="structgg__http.html#a15ab326eb76ae067ffbf0e770b14350e" title="Odebrana strona.">body</a>, token-&gt;<a class="code" href="structgg__http.html#a99a3ad921f1e59ba70ba4b3de268c2a7" title="Rozmiar strony.">body_size</a>, 1, plik);</div>
<div class="line">fclose(plik);</div>
<div class="line"></div>
<div class="line"><a class="code" href="group__token.html#gafc103504bf9e1c48ad5ec29eac8b4f0f" title="Zwalnia zasoby po operacji pobierania tokenu.">gg_token_free</a>(token);</div>
</div><!-- fragment --> <hr/><h2>Dokumentacja funkcji</h2>
<a class="anchor" id="ga64271e3505ae06d2e683f4298ac65edf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structgg__http.html">gg_http</a>* <a class="el" href="structgg__token.html">gg_token</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>async</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Pobiera token do autoryzacji operacji na katalogu publicznym. </p>
<p>Token jest niezbędny do tworzenia nowego i usuwania użytkownika, zmiany hasła itd.</p>
<dl class="params"><dt>Parametry:</dt><dd>
  <table class="params">
    <tr><td class="paramname">async</td><td>Flaga połączenia asynchronicznego</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Zwraca:</dt><dd>Struktura <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code> lub <code>NULL</code> w przypadku błędu </dd></dl>

</div>
</div>
<a class="anchor" id="ga662a93012568809b745d73bc9937ea7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gg_token_watch_fd </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structgg__http.html">gg_http</a> *&#160;</td>
          <td class="paramname"><em>h</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia. </p>
<p>Operacja będzie zakończona, gdy pole <code>state</code> będzie równe <code>GG_STATE_DONE</code>. Jeśli wystąpi błąd, <code>state</code> będzie równe <code>GG_STATE_ERROR</code>, a kod błędu znajdzie się w polu <code>error</code>.</p>
<dl class="params"><dt>Parametry:</dt><dd>
  <table class="params">
    <tr><td class="paramname">h</td><td>Struktura połączenia</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Zwraca:</dt><dd>0 jeśli się powiodło, -1 w przypadku błędu </dd></dl>

</div>
</div>
<a class="anchor" id="gafc103504bf9e1c48ad5ec29eac8b4f0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gg_token_free </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structgg__http.html">gg_http</a> *&#160;</td>
          <td class="paramname"><em>h</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Zwalnia zasoby po operacji pobierania tokenu. </p>
<dl class="params"><dt>Parametry:</dt><dd>
  <table class="params">
    <tr><td class="paramname">h</td><td>Struktura połączenia </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Wygenerowano przez &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>