<!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: Usługi HTTP</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
 <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 główna</span></a></li>
<li><a href="pages.html"><span>Dodatkowe strony</span></a></li>
<li><a href="modules.html"><span>Moduły</span></a></li>
<li><a href="annotated.html"><span>Struktury 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Struktury Danych</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Pliki</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Funkcje</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Zmienne</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Definicje typów</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Wyliczenia</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Wartości wyliczeń</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Definicje</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Grupay</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </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> |
<a href="#func-members">Funkcje</a> </div>
<div class="headertitle">
<div class="title">Usługi HTTP</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgg__http.html">gg_http</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Połączenie HTTP. <a href="structgg__http.html#details">Więcej...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgg__pubdir.html">gg_pubdir</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Wynik operacji na katalogu publicznym. <a href="structgg__pubdir.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:gafdc928d79ae554ce1f71f02cb28859a0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structgg__http.html">gg_http</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__http.html#gafdc928d79ae554ce1f71f02cb28859a0">gg_http_connect</a> (const char *hostname, int port, int async, const char *method, const char *path, const char *header)</td></tr>
<tr class="memdesc:gafdc928d79ae554ce1f71f02cb28859a0"><td class="mdescLeft"> </td><td class="mdescRight">Rozpoczyna połączenie HTTP. <a href="#gafdc928d79ae554ce1f71f02cb28859a0"></a><br/></td></tr>
<tr class="memitem:ga28be8503c269520f7954668b8d26dcea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__http.html#ga28be8503c269520f7954668b8d26dcea">gg_http_watch_fd</a> (struct <a class="el" href="structgg__http.html">gg_http</a> *h)</td></tr>
<tr class="memdesc:ga28be8503c269520f7954668b8d26dcea"><td class="mdescLeft"> </td><td class="mdescRight">Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia. <a href="#ga28be8503c269520f7954668b8d26dcea"></a><br/></td></tr>
<tr class="memitem:gae3f4a17c9feb1c07c9532e328b17a85b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__http.html#gae3f4a17c9feb1c07c9532e328b17a85b">gg_http_stop</a> (struct <a class="el" href="structgg__http.html">gg_http</a> *h)</td></tr>
<tr class="memdesc:gae3f4a17c9feb1c07c9532e328b17a85b"><td class="mdescLeft"> </td><td class="mdescRight">Kończy asynchroniczne połączenie HTTP. <a href="#gae3f4a17c9feb1c07c9532e328b17a85b"></a><br/></td></tr>
<tr class="memitem:gad7f9890845fb4af31815158e3b888ca7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__http.html#gad7f9890845fb4af31815158e3b888ca7">gg_http_free</a> (struct <a class="el" href="structgg__http.html">gg_http</a> *h)</td></tr>
<tr class="memdesc:gad7f9890845fb4af31815158e3b888ca7"><td class="mdescLeft"> </td><td class="mdescRight">Zwalnia zasoby po połączeniu HTTP. <a href="#gad7f9890845fb4af31815158e3b888ca7"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Opis szczegółowy</h2>
<p>Obecnie wszystkie usługi dodatkowe są realizowane za pomocą protokołu HTTP. Przy operacjach synchronicznych należy jedynie wywołać funkcję, sprawdzić kod błędu i jeśli operacja się powiodła, należy odczytać wynik funkcji z odpowiedniej struktury.</p>
<p>Operacje asynchroniczne różnią się od zwykłych połączeń z serwerem jedynie tym, że zakończenie operacji jest określane przez pole <code>state</code>, które przyjmuje wartość <code>GG_STATE_DONE</code> w przypadku sukcesu lub <code>GG_STATE_ERROR</code> w przypadku błędu. Podobnie jak w przypadku połączenia z serwerem, należy wywoływać funkcję <code><a class="el" href="group__http.html#ga28be8503c269520f7954668b8d26dcea" title="Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia.">gg_http_watch_fd()</a></code> po zaobserwowaniu zmian na określonym deskryptorze.</p>
<p>Każdą operację asynchroniczną można ponadto zatrzymać w trakcie działania za pomocą funkcji <code><a class="el" href="group__http.html#gae3f4a17c9feb1c07c9532e328b17a85b" title="Kończy asynchroniczne połączenie HTTP.">gg_http_stop()</a></code>.</p>
<p>Część operacji związanych z katalogiem publicznym w polu <code>data</code> struktury <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code> przekazuje strukturę <code><a class="el" href="structgg__pubdir.html" title="Wynik operacji na katalogu publicznym.">gg_pubdir</a></code> zawierającą wynik danej operacji. Szczegóły znajdują się na stronach poszczególnych usług dodatkowych. </p>
<hr/><h2>Dokumentacja funkcji</h2>
<a class="anchor" id="gafdc928d79ae554ce1f71f02cb28859a0"></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>* gg_http_connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hostname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>async</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>header</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Rozpoczyna połączenie HTTP. </p>
<p>Funkcja przeprowadza połączenie HTTP przy połączeniu synchronicznym, zwracając wynik w polach struktury <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code>, lub błąd, gdy sesja się nie powiedzie.</p>
<p>Przy połączeniu asynchronicznym, funkcja rozpoczyna połączenie, a dalsze etapy będą przeprowadzane po wykryciu zmian (<code>watch</code>) na obserwowanym deskryptorze (<code>fd</code>) i wywołaniu funkcji <code><a class="el" href="group__http.html#ga28be8503c269520f7954668b8d26dcea" title="Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia.">gg_http_watch_fd()</a></code>.</p>
<p>Po zakończeniu, należy zwolnić strukturę za pomocą funkcji <code><a class="el" href="group__http.html#gad7f9890845fb4af31815158e3b888ca7" title="Zwalnia zasoby po połączeniu HTTP.">gg_http_free()</a></code>. Połączenie asynchroniczne można zatrzymać w każdej chwili za pomocą <code><a class="el" href="group__http.html#gae3f4a17c9feb1c07c9532e328b17a85b" title="Kończy asynchroniczne połączenie HTTP.">gg_http_stop()</a></code>.</p>
<dl class="params"><dt>Parametry:</dt><dd>
<table class="params">
<tr><td class="paramname">hostname</td><td>Adres serwera </td></tr>
<tr><td class="paramname">port</td><td>Port serwera </td></tr>
<tr><td class="paramname">async</td><td>Flaga asynchronicznego połączenia </td></tr>
<tr><td class="paramname">method</td><td>Metoda HTTP </td></tr>
<tr><td class="paramname">path</td><td>Ścieżka do zasobu (musi być poprzedzona znakiem '/') </td></tr>
<tr><td class="paramname">header</td><td>Nagłówek zapytania plus ewentualne dane dla POST</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Zwraca:</dt><dd>Zaalokowana struktura <code><a class="el" href="structgg__http.html" title="Połączenie HTTP.">gg_http</a></code> lub NULL, jeśli wystąpił błąd. </dd></dl>
</div>
</div>
<a class="anchor" id="ga28be8503c269520f7954668b8d26dcea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gg_http_watch_fd </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structgg__http.html">gg_http</a> * </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_PARSING</code>. W tym miejscu działanie przejmuje zwykle funkcja korzystająca z <code><a class="el" href="group__http.html#ga28be8503c269520f7954668b8d26dcea" title="Funkcja wywoływana po zaobserwowaniu zmian na deskryptorze połączenia.">gg_http_watch_fd()</a></code>. W przypadku błędu połączenia, pole <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></dd>
<dd>
0 jeśli się powiodło, -1 w przypadku błędu </dd></dl>
</div>
</div>
<a class="anchor" id="gae3f4a17c9feb1c07c9532e328b17a85b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gg_http_stop </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structgg__http.html">gg_http</a> * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Kończy asynchroniczne połączenie HTTP. </p>
<p>Po zatrzymaniu należy zwolnić zasoby funkcją <code><a class="el" href="group__http.html#gad7f9890845fb4af31815158e3b888ca7" title="Zwalnia zasoby po połączeniu HTTP.">gg_http_free()</a></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>
</div>
</div>
<a class="anchor" id="gad7f9890845fb4af31815158e3b888ca7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gg_http_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structgg__http.html">gg_http</a> * </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Zwalnia zasoby po połączeniu HTTP. </p>
<p>Jeśli połączenie nie zostało jeszcze zakończone, jest przerywane.</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  <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>
