PageRenderTime 69ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 1ms

/docs/reference/gio/html/GSocketClient.html

https://gitlab.com/ImageMagick/glib
HTML | 2070 lines | 2068 code | 2 blank | 0 comment | 0 complexity | a0ba2450f919f8b86a3136f1c823e639 MD5 | raw file
Possible License(s): LGPL-2.1, AGPL-3.0

Large files files are truncated, but you can click here to view the full file

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <title>GSocketClient: GIO Reference Manual</title>
  6. <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
  7. <link rel="home" href="index.html" title="GIO Reference Manual">
  8. <link rel="up" href="highlevel-socket.html" title="High-level network functionallity">
  9. <link rel="prev" href="highlevel-socket.html" title="High-level network functionallity">
  10. <link rel="next" href="GSocketConnection.html" title="GSocketConnection">
  11. <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
  12. <link rel="stylesheet" href="style.css" type="text/css">
  13. </head>
  14. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15. <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16. <td width="100%" align="left" class="shortcuts">
  17. <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
  18. <a href="#GSocketClient.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
  19. <a href="#GSocketClient.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
  20. <a href="#GSocketClient.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
  21. <a href="#GSocketClient.signals" class="shortcut">Signals</a></span>
  22. </td>
  23. <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  24. <td><a accesskey="u" href="highlevel-socket.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  25. <td><a accesskey="p" href="highlevel-socket.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  26. <td><a accesskey="n" href="GSocketConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  27. </tr></table>
  28. <div class="refentry">
  29. <a name="GSocketClient"></a><div class="titlepage"></div>
  30. <div class="refnamediv"><table width="100%"><tr>
  31. <td valign="top">
  32. <h2><span class="refentrytitle"><a name="GSocketClient.top_of_page"></a>GSocketClient</span></h2>
  33. <p>GSocketClient Helper for connecting to a network service</p>
  34. </td>
  35. <td class="gallery_image" valign="top" align="right"></td>
  36. </tr></table></div>
  37. <div class="refsect1">
  38. <a name="GSocketClient.functions"></a><h2>Functions</h2>
  39. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  40. <colgroup>
  41. <col width="150px" class="functions_return">
  42. <col class="functions_name">
  43. </colgroup>
  44. <tbody>
  45. <tr>
  46. <td class="function_type">
  47. <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="returnvalue">GSocketClient</span></a> *
  48. </td>
  49. <td class="function_name">
  50. <a class="link" href="GSocketClient.html#g-socket-client-new" title="g_socket_client_new ()">g_socket_client_new</a> <span class="c_punctuation">()</span>
  51. </td>
  52. </tr>
  53. <tr>
  54. <td class="function_type">
  55. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  56. </td>
  57. <td class="function_name">
  58. <a class="link" href="GSocketClient.html#g-socket-client-connect" title="g_socket_client_connect ()">g_socket_client_connect</a> <span class="c_punctuation">()</span>
  59. </td>
  60. </tr>
  61. <tr>
  62. <td class="function_type">
  63. <span class="returnvalue">void</span>
  64. </td>
  65. <td class="function_name">
  66. <a class="link" href="GSocketClient.html#g-socket-client-connect-async" title="g_socket_client_connect_async ()">g_socket_client_connect_async</a> <span class="c_punctuation">()</span>
  67. </td>
  68. </tr>
  69. <tr>
  70. <td class="function_type">
  71. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  72. </td>
  73. <td class="function_name">
  74. <a class="link" href="GSocketClient.html#g-socket-client-connect-finish" title="g_socket_client_connect_finish ()">g_socket_client_connect_finish</a> <span class="c_punctuation">()</span>
  75. </td>
  76. </tr>
  77. <tr>
  78. <td class="function_type">
  79. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  80. </td>
  81. <td class="function_name">
  82. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host" title="g_socket_client_connect_to_host ()">g_socket_client_connect_to_host</a> <span class="c_punctuation">()</span>
  83. </td>
  84. </tr>
  85. <tr>
  86. <td class="function_type">
  87. <span class="returnvalue">void</span>
  88. </td>
  89. <td class="function_name">
  90. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host-async" title="g_socket_client_connect_to_host_async ()">g_socket_client_connect_to_host_async</a> <span class="c_punctuation">()</span>
  91. </td>
  92. </tr>
  93. <tr>
  94. <td class="function_type">
  95. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  96. </td>
  97. <td class="function_name">
  98. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host-finish" title="g_socket_client_connect_to_host_finish ()">g_socket_client_connect_to_host_finish</a> <span class="c_punctuation">()</span>
  99. </td>
  100. </tr>
  101. <tr>
  102. <td class="function_type">
  103. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  104. </td>
  105. <td class="function_name">
  106. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-service" title="g_socket_client_connect_to_service ()">g_socket_client_connect_to_service</a> <span class="c_punctuation">()</span>
  107. </td>
  108. </tr>
  109. <tr>
  110. <td class="function_type">
  111. <span class="returnvalue">void</span>
  112. </td>
  113. <td class="function_name">
  114. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-service-async" title="g_socket_client_connect_to_service_async ()">g_socket_client_connect_to_service_async</a> <span class="c_punctuation">()</span>
  115. </td>
  116. </tr>
  117. <tr>
  118. <td class="function_type">
  119. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  120. </td>
  121. <td class="function_name">
  122. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-service-finish" title="g_socket_client_connect_to_service_finish ()">g_socket_client_connect_to_service_finish</a> <span class="c_punctuation">()</span>
  123. </td>
  124. </tr>
  125. <tr>
  126. <td class="function_type">
  127. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  128. </td>
  129. <td class="function_name">
  130. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-uri" title="g_socket_client_connect_to_uri ()">g_socket_client_connect_to_uri</a> <span class="c_punctuation">()</span>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td class="function_type">
  135. <span class="returnvalue">void</span>
  136. </td>
  137. <td class="function_name">
  138. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-uri-async" title="g_socket_client_connect_to_uri_async ()">g_socket_client_connect_to_uri_async</a> <span class="c_punctuation">()</span>
  139. </td>
  140. </tr>
  141. <tr>
  142. <td class="function_type">
  143. <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  144. </td>
  145. <td class="function_name">
  146. <a class="link" href="GSocketClient.html#g-socket-client-connect-to-uri-finish" title="g_socket_client_connect_to_uri_finish ()">g_socket_client_connect_to_uri_finish</a> <span class="c_punctuation">()</span>
  147. </td>
  148. </tr>
  149. <tr>
  150. <td class="function_type">
  151. <span class="returnvalue">void</span>
  152. </td>
  153. <td class="function_name">
  154. <a class="link" href="GSocketClient.html#g-socket-client-set-family" title="g_socket_client_set_family ()">g_socket_client_set_family</a> <span class="c_punctuation">()</span>
  155. </td>
  156. </tr>
  157. <tr>
  158. <td class="function_type">
  159. <span class="returnvalue">void</span>
  160. </td>
  161. <td class="function_name">
  162. <a class="link" href="GSocketClient.html#g-socket-client-set-local-address" title="g_socket_client_set_local_address ()">g_socket_client_set_local_address</a> <span class="c_punctuation">()</span>
  163. </td>
  164. </tr>
  165. <tr>
  166. <td class="function_type">
  167. <span class="returnvalue">void</span>
  168. </td>
  169. <td class="function_name">
  170. <a class="link" href="GSocketClient.html#g-socket-client-set-protocol" title="g_socket_client_set_protocol ()">g_socket_client_set_protocol</a> <span class="c_punctuation">()</span>
  171. </td>
  172. </tr>
  173. <tr>
  174. <td class="function_type">
  175. <span class="returnvalue">void</span>
  176. </td>
  177. <td class="function_name">
  178. <a class="link" href="GSocketClient.html#g-socket-client-set-socket-type" title="g_socket_client_set_socket_type ()">g_socket_client_set_socket_type</a> <span class="c_punctuation">()</span>
  179. </td>
  180. </tr>
  181. <tr>
  182. <td class="function_type">
  183. <span class="returnvalue">void</span>
  184. </td>
  185. <td class="function_name">
  186. <a class="link" href="GSocketClient.html#g-socket-client-set-timeout" title="g_socket_client_set_timeout ()">g_socket_client_set_timeout</a> <span class="c_punctuation">()</span>
  187. </td>
  188. </tr>
  189. <tr>
  190. <td class="function_type">
  191. <span class="returnvalue">void</span>
  192. </td>
  193. <td class="function_name">
  194. <a class="link" href="GSocketClient.html#g-socket-client-set-enable-proxy" title="g_socket_client_set_enable_proxy ()">g_socket_client_set_enable_proxy</a> <span class="c_punctuation">()</span>
  195. </td>
  196. </tr>
  197. <tr>
  198. <td class="function_type">
  199. <span class="returnvalue">void</span>
  200. </td>
  201. <td class="function_name">
  202. <a class="link" href="GSocketClient.html#g-socket-client-set-proxy-resolver" title="g_socket_client_set_proxy_resolver ()">g_socket_client_set_proxy_resolver</a> <span class="c_punctuation">()</span>
  203. </td>
  204. </tr>
  205. <tr>
  206. <td class="function_type">
  207. <span class="returnvalue">void</span>
  208. </td>
  209. <td class="function_name">
  210. <a class="link" href="GSocketClient.html#g-socket-client-set-tls" title="g_socket_client_set_tls ()">g_socket_client_set_tls</a> <span class="c_punctuation">()</span>
  211. </td>
  212. </tr>
  213. <tr>
  214. <td class="function_type">
  215. <span class="returnvalue">void</span>
  216. </td>
  217. <td class="function_name">
  218. <a class="link" href="GSocketClient.html#g-socket-client-set-tls-validation-flags" title="g_socket_client_set_tls_validation_flags ()">g_socket_client_set_tls_validation_flags</a> <span class="c_punctuation">()</span>
  219. </td>
  220. </tr>
  221. <tr>
  222. <td class="function_type">
  223. <a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="returnvalue">GSocketFamily</span></a>
  224. </td>
  225. <td class="function_name">
  226. <a class="link" href="GSocketClient.html#g-socket-client-get-family" title="g_socket_client_get_family ()">g_socket_client_get_family</a> <span class="c_punctuation">()</span>
  227. </td>
  228. </tr>
  229. <tr>
  230. <td class="function_type">
  231. <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="returnvalue">GSocketAddress</span></a> *
  232. </td>
  233. <td class="function_name">
  234. <a class="link" href="GSocketClient.html#g-socket-client-get-local-address" title="g_socket_client_get_local_address ()">g_socket_client_get_local_address</a> <span class="c_punctuation">()</span>
  235. </td>
  236. </tr>
  237. <tr>
  238. <td class="function_type">
  239. <a class="link" href="GSocket.html#GSocketProtocol" title="enum GSocketProtocol"><span class="returnvalue">GSocketProtocol</span></a>
  240. </td>
  241. <td class="function_name">
  242. <a class="link" href="GSocketClient.html#g-socket-client-get-protocol" title="g_socket_client_get_protocol ()">g_socket_client_get_protocol</a> <span class="c_punctuation">()</span>
  243. </td>
  244. </tr>
  245. <tr>
  246. <td class="function_type">
  247. <a class="link" href="GSocket.html#GSocketType" title="enum GSocketType"><span class="returnvalue">GSocketType</span></a>
  248. </td>
  249. <td class="function_name">
  250. <a class="link" href="GSocketClient.html#g-socket-client-get-socket-type" title="g_socket_client_get_socket_type ()">g_socket_client_get_socket_type</a> <span class="c_punctuation">()</span>
  251. </td>
  252. </tr>
  253. <tr>
  254. <td class="function_type">
  255. <a href="../glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
  256. </td>
  257. <td class="function_name">
  258. <a class="link" href="GSocketClient.html#g-socket-client-get-timeout" title="g_socket_client_get_timeout ()">g_socket_client_get_timeout</a> <span class="c_punctuation">()</span>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td class="function_type">
  263. <a href="../glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  264. </td>
  265. <td class="function_name">
  266. <a class="link" href="GSocketClient.html#g-socket-client-get-enable-proxy" title="g_socket_client_get_enable_proxy ()">g_socket_client_get_enable_proxy</a> <span class="c_punctuation">()</span>
  267. </td>
  268. </tr>
  269. <tr>
  270. <td class="function_type">
  271. <a class="link" href="GProxyResolver.html" title="GProxyResolver"><span class="returnvalue">GProxyResolver</span></a> *
  272. </td>
  273. <td class="function_name">
  274. <a class="link" href="GSocketClient.html#g-socket-client-get-proxy-resolver" title="g_socket_client_get_proxy_resolver ()">g_socket_client_get_proxy_resolver</a> <span class="c_punctuation">()</span>
  275. </td>
  276. </tr>
  277. <tr>
  278. <td class="function_type">
  279. <a href="../glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  280. </td>
  281. <td class="function_name">
  282. <a class="link" href="GSocketClient.html#g-socket-client-get-tls" title="g_socket_client_get_tls ()">g_socket_client_get_tls</a> <span class="c_punctuation">()</span>
  283. </td>
  284. </tr>
  285. <tr>
  286. <td class="function_type">
  287. <a class="link" href="gio-TLS-Overview.html#GTlsCertificateFlags" title="enum GTlsCertificateFlags"><span class="returnvalue">GTlsCertificateFlags</span></a>
  288. </td>
  289. <td class="function_name">
  290. <a class="link" href="GSocketClient.html#g-socket-client-get-tls-validation-flags" title="g_socket_client_get_tls_validation_flags ()">g_socket_client_get_tls_validation_flags</a> <span class="c_punctuation">()</span>
  291. </td>
  292. </tr>
  293. <tr>
  294. <td class="function_type">
  295. <span class="returnvalue">void</span>
  296. </td>
  297. <td class="function_name">
  298. <a class="link" href="GSocketClient.html#g-socket-client-add-application-proxy" title="g_socket_client_add_application_proxy ()">g_socket_client_add_application_proxy</a> <span class="c_punctuation">()</span>
  299. </td>
  300. </tr>
  301. </tbody>
  302. </table></div>
  303. </div>
  304. <div class="refsect1">
  305. <a name="GSocketClient.properties"></a><h2>Properties</h2>
  306. <div class="informaltable"><table class="informaltable" border="0">
  307. <colgroup>
  308. <col width="150px" class="properties_type">
  309. <col width="300px" class="properties_name">
  310. <col width="200px" class="properties_flags">
  311. </colgroup>
  312. <tbody>
  313. <tr>
  314. <td class="property_type"><a href="../glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
  315. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--enable-proxy" title="The “enable-proxy” property">enable-proxy</a></td>
  316. <td class="property_flags">Read / Write / Construct</td>
  317. </tr>
  318. <tr>
  319. <td class="property_type"><a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily"><span class="type">GSocketFamily</span></a></td>
  320. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--family" title="The “family” property">family</a></td>
  321. <td class="property_flags">Read / Write / Construct</td>
  322. </tr>
  323. <tr>
  324. <td class="property_type">
  325. <a class="link" href="GSocketAddress.html" title="GSocketAddress"><span class="type">GSocketAddress</span></a> *</td>
  326. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--local-address" title="The “local-address” property">local-address</a></td>
  327. <td class="property_flags">Read / Write / Construct</td>
  328. </tr>
  329. <tr>
  330. <td class="property_type"><a class="link" href="GSocket.html#GSocketProtocol" title="enum GSocketProtocol"><span class="type">GSocketProtocol</span></a></td>
  331. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--protocol" title="The “protocol” property">protocol</a></td>
  332. <td class="property_flags">Read / Write / Construct</td>
  333. </tr>
  334. <tr>
  335. <td class="property_type">
  336. <a class="link" href="GProxyResolver.html" title="GProxyResolver"><span class="type">GProxyResolver</span></a> *</td>
  337. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--proxy-resolver" title="The “proxy-resolver” property">proxy-resolver</a></td>
  338. <td class="property_flags">Read / Write / Construct</td>
  339. </tr>
  340. <tr>
  341. <td class="property_type"><a href="../glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
  342. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--timeout" title="The “timeout” property">timeout</a></td>
  343. <td class="property_flags">Read / Write / Construct</td>
  344. </tr>
  345. <tr>
  346. <td class="property_type"><a href="../glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
  347. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--tls" title="The “tls” property">tls</a></td>
  348. <td class="property_flags">Read / Write / Construct</td>
  349. </tr>
  350. <tr>
  351. <td class="property_type"><a class="link" href="gio-TLS-Overview.html#GTlsCertificateFlags" title="enum GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a></td>
  352. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--tls-validation-flags" title="The “tls-validation-flags” property">tls-validation-flags</a></td>
  353. <td class="property_flags">Read / Write / Construct</td>
  354. </tr>
  355. <tr>
  356. <td class="property_type"><a class="link" href="GSocket.html#GSocketType" title="enum GSocketType"><span class="type">GSocketType</span></a></td>
  357. <td class="property_name"><a class="link" href="GSocketClient.html#GSocketClient--type" title="The “type” property">type</a></td>
  358. <td class="property_flags">Read / Write / Construct</td>
  359. </tr>
  360. </tbody>
  361. </table></div>
  362. </div>
  363. <div class="refsect1">
  364. <a name="GSocketClient.signals"></a><h2>Signals</h2>
  365. <div class="informaltable"><table class="informaltable" border="0">
  366. <colgroup>
  367. <col width="150px" class="signals_return">
  368. <col width="300px" class="signals_name">
  369. <col width="200px" class="signals_flags">
  370. </colgroup>
  371. <tbody><tr>
  372. <td class="signal_type"><span class="returnvalue">void</span></td>
  373. <td class="signal_name"><a class="link" href="GSocketClient.html#GSocketClient-event" title="The “event” signal">event</a></td>
  374. <td class="signal_flags"><a href="../gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
  375. </tr></tbody>
  376. </table></div>
  377. </div>
  378. <div class="refsect1">
  379. <a name="GSocketClient.other"></a><h2>Types and Values</h2>
  380. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  381. <colgroup>
  382. <col width="150px" class="name">
  383. <col class="description">
  384. </colgroup>
  385. <tbody>
  386. <tr>
  387. <td class="datatype_keyword"> </td>
  388. <td class="function_name"><a class="link" href="GSocketClient.html#GSocketClient-struct" title="GSocketClient">GSocketClient</a></td>
  389. </tr>
  390. <tr>
  391. <td class="datatype_keyword">enum</td>
  392. <td class="function_name"><a class="link" href="GSocketClient.html#GSocketClientEvent" title="enum GSocketClientEvent">GSocketClientEvent</a></td>
  393. </tr>
  394. </tbody>
  395. </table></div>
  396. </div>
  397. <div class="refsect1">
  398. <a name="GSocketClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
  399. <pre class="screen"> <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
  400. <span class="lineart"></span> GSocketClient
  401. </pre>
  402. </div>
  403. <div class="refsect1">
  404. <a name="GSocketClient.includes"></a><h2>Includes</h2>
  405. <pre class="synopsis">#include &lt;gio/gio.h&gt;
  406. </pre>
  407. </div>
  408. <div class="refsect1">
  409. <a name="GSocketClient.description"></a><h2>Description</h2>
  410. <p><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> is a lightweight high-level utility class for connecting to
  411. a network host using a connection oriented socket type.</p>
  412. <p>You create a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> object, set any options you want, and then
  413. call a sync or async connect operation, which returns a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a>
  414. subclass on success.</p>
  415. <p>The type of the <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> object returned depends on the type of
  416. the underlying socket that is in use. For instance, for a TCP/IP connection
  417. it will be a <a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a>.</p>
  418. <p>As <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> is a lightweight object, you don't need to cache it. You
  419. can just create a new one any time you need one.</p>
  420. </div>
  421. <div class="refsect1">
  422. <a name="GSocketClient.functions_details"></a><h2>Functions</h2>
  423. <div class="refsect2">
  424. <a name="g-socket-client-new"></a><h3>g_socket_client_new ()</h3>
  425. <pre class="programlisting"><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="returnvalue">GSocketClient</span></a> *
  426. g_socket_client_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  427. <p>Creates a new <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> with the default options.</p>
  428. <div class="refsect3">
  429. <a name="g-socket-client-new.returns"></a><h4>Returns</h4>
  430. <p> a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a>.
  431. Free the returned object with <a href="../gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p>
  432. </div>
  433. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  434. </div>
  435. <hr>
  436. <div class="refsect2">
  437. <a name="g-socket-client-connect"></a><h3>g_socket_client_connect ()</h3>
  438. <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  439. g_socket_client_connect (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  440. <em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>,
  441. <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  442. <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  443. <p>Tries to resolve the <em class="parameter"><code>connectable</code></em>
  444. and make a network connection to it.</p>
  445. <p>Upon a successful connection, a new <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> is constructed
  446. and returned. The caller owns this new object and must drop their
  447. reference to it when finished with it.</p>
  448. <p>The type of the <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> object returned depends on the type of
  449. the underlying socket that is used. For instance, for a TCP/IP connection
  450. it will be a <a class="link" href="GTcpConnection.html" title="GTcpConnection"><span class="type">GTcpConnection</span></a>.</p>
  451. <p>The socket created will be the same family as the address that the
  452. <em class="parameter"><code>connectable</code></em>
  453. resolves to, unless family is set with <a class="link" href="GSocketClient.html#g-socket-client-set-family" title="g_socket_client_set_family ()"><code class="function">g_socket_client_set_family()</code></a>
  454. or indirectly via <a class="link" href="GSocketClient.html#g-socket-client-set-local-address" title="g_socket_client_set_local_address ()"><code class="function">g_socket_client_set_local_address()</code></a>. The socket type
  455. defaults to <a class="link" href="GSocket.html#G-SOCKET-TYPE-STREAM:CAPS"><code class="literal">G_SOCKET_TYPE_STREAM</code></a> but can be set with
  456. <a class="link" href="GSocketClient.html#g-socket-client-set-socket-type" title="g_socket_client_set_socket_type ()"><code class="function">g_socket_client_set_socket_type()</code></a>.</p>
  457. <p>If a local address is specified with <a class="link" href="GSocketClient.html#g-socket-client-set-local-address" title="g_socket_client_set_local_address ()"><code class="function">g_socket_client_set_local_address()</code></a> the
  458. socket will be bound to this address before connecting.</p>
  459. <div class="refsect3">
  460. <a name="g-socket-client-connect.parameters"></a><h4>Parameters</h4>
  461. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  462. <colgroup>
  463. <col width="150px" class="parameters_name">
  464. <col class="parameters_description">
  465. <col width="200px" class="parameters_annotations">
  466. </colgroup>
  467. <tbody>
  468. <tr>
  469. <td class="parameter_name"><p>client</p></td>
  470. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a>.</p></td>
  471. <td class="parameter_annotations"> </td>
  472. </tr>
  473. <tr>
  474. <td class="parameter_name"><p>connectable</p></td>
  475. <td class="parameter_description"><p>a <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> specifying the remote address.</p></td>
  476. <td class="parameter_annotations"> </td>
  477. </tr>
  478. <tr>
  479. <td class="parameter_name"><p>cancellable</p></td>
  480. <td class="parameter_description"><p> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
  481. <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
  482. </tr>
  483. <tr>
  484. <td class="parameter_name"><p>error</p></td>
  485. <td class="parameter_description"><p><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for error reporting, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</p></td>
  486. <td class="parameter_annotations"> </td>
  487. </tr>
  488. </tbody>
  489. </table></div>
  490. </div>
  491. <div class="refsect3">
  492. <a name="g-socket-client-connect.returns"></a><h4>Returns</h4>
  493. <p> a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> on success, <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
  494. <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
  495. </div>
  496. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  497. </div>
  498. <hr>
  499. <div class="refsect2">
  500. <a name="g-socket-client-connect-async"></a><h3>g_socket_client_connect_async ()</h3>
  501. <pre class="programlisting"><span class="returnvalue">void</span>
  502. g_socket_client_connect_async (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  503. <em class="parameter"><code><a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> *connectable</code></em>,
  504. <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  505. <em class="parameter"><code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
  506. <em class="parameter"><code><a href="../glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
  507. <p>This is the asynchronous version of <a class="link" href="GSocketClient.html#g-socket-client-connect" title="g_socket_client_connect ()"><code class="function">g_socket_client_connect()</code></a>.</p>
  508. <p>When the operation is finished <em class="parameter"><code>callback</code></em>
  509. will be
  510. called. You can then call <a class="link" href="GSocketClient.html#g-socket-client-connect-finish" title="g_socket_client_connect_finish ()"><code class="function">g_socket_client_connect_finish()</code></a> to get
  511. the result of the operation.</p>
  512. <div class="refsect3">
  513. <a name="g-socket-client-connect-async.parameters"></a><h4>Parameters</h4>
  514. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  515. <colgroup>
  516. <col width="150px" class="parameters_name">
  517. <col class="parameters_description">
  518. <col width="200px" class="parameters_annotations">
  519. </colgroup>
  520. <tbody>
  521. <tr>
  522. <td class="parameter_name"><p>client</p></td>
  523. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a></p></td>
  524. <td class="parameter_annotations"> </td>
  525. </tr>
  526. <tr>
  527. <td class="parameter_name"><p>connectable</p></td>
  528. <td class="parameter_description"><p>a <a class="link" href="GSocketConnectable.html" title="GSocketConnectable"><span class="type">GSocketConnectable</span></a> specifying the remote address.</p></td>
  529. <td class="parameter_annotations"> </td>
  530. </tr>
  531. <tr>
  532. <td class="parameter_name"><p>cancellable</p></td>
  533. <td class="parameter_description"><p> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
  534. <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
  535. </tr>
  536. <tr>
  537. <td class="parameter_name"><p>callback</p></td>
  538. <td class="parameter_description"><p> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a>. </p></td>
  539. <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
  540. </tr>
  541. <tr>
  542. <td class="parameter_name"><p>user_data</p></td>
  543. <td class="parameter_description"><p> user data for the callback. </p></td>
  544. <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
  545. </tr>
  546. </tbody>
  547. </table></div>
  548. </div>
  549. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  550. </div>
  551. <hr>
  552. <div class="refsect2">
  553. <a name="g-socket-client-connect-finish"></a><h3>g_socket_client_connect_finish ()</h3>
  554. <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  555. g_socket_client_connect_finish (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  556. <em class="parameter"><code><a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a> *result</code></em>,
  557. <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  558. <p>Finishes an async connect operation. See <a class="link" href="GSocketClient.html#g-socket-client-connect-async" title="g_socket_client_connect_async ()"><code class="function">g_socket_client_connect_async()</code></a></p>
  559. <div class="refsect3">
  560. <a name="g-socket-client-connect-finish.parameters"></a><h4>Parameters</h4>
  561. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  562. <colgroup>
  563. <col width="150px" class="parameters_name">
  564. <col class="parameters_description">
  565. <col width="200px" class="parameters_annotations">
  566. </colgroup>
  567. <tbody>
  568. <tr>
  569. <td class="parameter_name"><p>client</p></td>
  570. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a>.</p></td>
  571. <td class="parameter_annotations"> </td>
  572. </tr>
  573. <tr>
  574. <td class="parameter_name"><p>result</p></td>
  575. <td class="parameter_description"><p>a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.</p></td>
  576. <td class="parameter_annotations"> </td>
  577. </tr>
  578. <tr>
  579. <td class="parameter_name"><p>error</p></td>
  580. <td class="parameter_description"><p>a <a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
  581. ignore.</p></td>
  582. <td class="parameter_annotations"> </td>
  583. </tr>
  584. </tbody>
  585. </table></div>
  586. </div>
  587. <div class="refsect3">
  588. <a name="g-socket-client-connect-finish.returns"></a><h4>Returns</h4>
  589. <p> a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> on success, <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
  590. <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
  591. </div>
  592. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  593. </div>
  594. <hr>
  595. <div class="refsect2">
  596. <a name="g-socket-client-connect-to-host"></a><h3>g_socket_client_connect_to_host ()</h3>
  597. <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  598. g_socket_client_connect_to_host (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  599. <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host_and_port</code></em>,
  600. <em class="parameter"><code><a href="../glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> default_port</code></em>,
  601. <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  602. <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  603. <p>This is a helper function for <a class="link" href="GSocketClient.html#g-socket-client-connect" title="g_socket_client_connect ()"><code class="function">g_socket_client_connect()</code></a>.</p>
  604. <p>Attempts to create a TCP connection to the named host.</p>
  605. <p><em class="parameter"><code>host_and_port</code></em>
  606. may be in any of a number of recognized formats; an IPv6
  607. address, an IPv4 address, or a domain name (in which case a DNS
  608. lookup is performed). Quoting with [] is supported for all address
  609. types. A port override may be specified in the usual way with a
  610. colon. Ports may be given as decimal numbers or symbolic names (in
  611. which case an /etc/services lookup is performed).</p>
  612. <p>If no port override is given in <em class="parameter"><code>host_and_port</code></em>
  613. then <em class="parameter"><code>default_port</code></em>
  614. will be
  615. used as the port number to connect to.</p>
  616. <p>In general, <em class="parameter"><code>host_and_port</code></em>
  617. is expected to be provided by the user (allowing
  618. them to give the hostname, and a port override if necessary) and
  619. <em class="parameter"><code>default_port</code></em>
  620. is expected to be provided by the application.</p>
  621. <p>In the case that an IP address is given, a single connection
  622. attempt is made. In the case that a name is given, multiple
  623. connection attempts may be made, in turn and according to the
  624. number of address records in DNS, until a connection succeeds.</p>
  625. <p>Upon a successful connection, a new <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> is constructed
  626. and returned. The caller owns this new object and must drop their
  627. reference to it when finished with it.</p>
  628. <p>In the event of any failure (DNS error, service not found, no hosts
  629. connectable) <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em>
  630. (if non-<a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) is set
  631. accordingly.</p>
  632. <div class="refsect3">
  633. <a name="g-socket-client-connect-to-host.parameters"></a><h4>Parameters</h4>
  634. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  635. <colgroup>
  636. <col width="150px" class="parameters_name">
  637. <col class="parameters_description">
  638. <col width="200px" class="parameters_annotations">
  639. </colgroup>
  640. <tbody>
  641. <tr>
  642. <td class="parameter_name"><p>client</p></td>
  643. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a></p></td>
  644. <td class="parameter_annotations"> </td>
  645. </tr>
  646. <tr>
  647. <td class="parameter_name"><p>host_and_port</p></td>
  648. <td class="parameter_description"><p>the name and optionally port of the host to connect to</p></td>
  649. <td class="parameter_annotations"> </td>
  650. </tr>
  651. <tr>
  652. <td class="parameter_name"><p>default_port</p></td>
  653. <td class="parameter_description"><p>the default port to connect to</p></td>
  654. <td class="parameter_annotations"> </td>
  655. </tr>
  656. <tr>
  657. <td class="parameter_name"><p>cancellable</p></td>
  658. <td class="parameter_description"><p> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
  659. <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
  660. </tr>
  661. <tr>
  662. <td class="parameter_name"><p>error</p></td>
  663. <td class="parameter_description"><p>a pointer to a <a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
  664. <td class="parameter_annotations"> </td>
  665. </tr>
  666. </tbody>
  667. </table></div>
  668. </div>
  669. <div class="refsect3">
  670. <a name="g-socket-client-connect-to-host.returns"></a><h4>Returns</h4>
  671. <p> a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> on success, <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
  672. <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
  673. </div>
  674. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  675. </div>
  676. <hr>
  677. <div class="refsect2">
  678. <a name="g-socket-client-connect-to-host-async"></a><h3>g_socket_client_connect_to_host_async ()</h3>
  679. <pre class="programlisting"><span class="returnvalue">void</span>
  680. g_socket_client_connect_to_host_async (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  681. <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host_and_port</code></em>,
  682. <em class="parameter"><code><a href="../glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> default_port</code></em>,
  683. <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  684. <em class="parameter"><code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
  685. <em class="parameter"><code><a href="../glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
  686. <p>This is the asynchronous version of <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host" title="g_socket_client_connect_to_host ()"><code class="function">g_socket_client_connect_to_host()</code></a>.</p>
  687. <p>When the operation is finished <em class="parameter"><code>callback</code></em>
  688. will be
  689. called. You can then call <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host-finish" title="g_socket_client_connect_to_host_finish ()"><code class="function">g_socket_client_connect_to_host_finish()</code></a> to get
  690. the result of the operation.</p>
  691. <div class="refsect3">
  692. <a name="g-socket-client-connect-to-host-async.parameters"></a><h4>Parameters</h4>
  693. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  694. <colgroup>
  695. <col width="150px" class="parameters_name">
  696. <col class="parameters_description">
  697. <col width="200px" class="parameters_annotations">
  698. </colgroup>
  699. <tbody>
  700. <tr>
  701. <td class="parameter_name"><p>client</p></td>
  702. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a></p></td>
  703. <td class="parameter_annotations"> </td>
  704. </tr>
  705. <tr>
  706. <td class="parameter_name"><p>host_and_port</p></td>
  707. <td class="parameter_description"><p>the name and optionally the port of the host to connect to</p></td>
  708. <td class="parameter_annotations"> </td>
  709. </tr>
  710. <tr>
  711. <td class="parameter_name"><p>default_port</p></td>
  712. <td class="parameter_description"><p>the default port to connect to</p></td>
  713. <td class="parameter_annotations"> </td>
  714. </tr>
  715. <tr>
  716. <td class="parameter_name"><p>cancellable</p></td>
  717. <td class="parameter_description"><p> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
  718. <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
  719. </tr>
  720. <tr>
  721. <td class="parameter_name"><p>callback</p></td>
  722. <td class="parameter_description"><p> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a>. </p></td>
  723. <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
  724. </tr>
  725. <tr>
  726. <td class="parameter_name"><p>user_data</p></td>
  727. <td class="parameter_description"><p> user data for the callback. </p></td>
  728. <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
  729. </tr>
  730. </tbody>
  731. </table></div>
  732. </div>
  733. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  734. </div>
  735. <hr>
  736. <div class="refsect2">
  737. <a name="g-socket-client-connect-to-host-finish"></a><h3>g_socket_client_connect_to_host_finish ()</h3>
  738. <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  739. g_socket_client_connect_to_host_finish
  740. (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  741. <em class="parameter"><code><a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a> *result</code></em>,
  742. <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  743. <p>Finishes an async connect operation. See <a class="link" href="GSocketClient.html#g-socket-client-connect-to-host-async" title="g_socket_client_connect_to_host_async ()"><code class="function">g_socket_client_connect_to_host_async()</code></a></p>
  744. <div class="refsect3">
  745. <a name="g-socket-client-connect-to-host-finish.parameters"></a><h4>Parameters</h4>
  746. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  747. <colgroup>
  748. <col width="150px" class="parameters_name">
  749. <col class="parameters_description">
  750. <col width="200px" class="parameters_annotations">
  751. </colgroup>
  752. <tbody>
  753. <tr>
  754. <td class="parameter_name"><p>client</p></td>
  755. <td class="parameter_description"><p>a <a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a>.</p></td>
  756. <td class="parameter_annotations"> </td>
  757. </tr>
  758. <tr>
  759. <td class="parameter_name"><p>result</p></td>
  760. <td class="parameter_description"><p>a <a class="link" href="GAsyncResult.html" title="GAsyncResult"><span class="type">GAsyncResult</span></a>.</p></td>
  761. <td class="parameter_annotations"> </td>
  762. </tr>
  763. <tr>
  764. <td class="parameter_name"><p>error</p></td>
  765. <td class="parameter_description"><p>a <a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
  766. ignore.</p></td>
  767. <td class="parameter_annotations"> </td>
  768. </tr>
  769. </tbody>
  770. </table></div>
  771. </div>
  772. <div class="refsect3">
  773. <a name="g-socket-client-connect-to-host-finish.returns"></a><h4>Returns</h4>
  774. <p> a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> on success, <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p>
  775. <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
  776. </div>
  777. <p class="since">Since: <a class="link" href="api-index-2-22.html#api-index-2.22">2.22</a></p>
  778. </div>
  779. <hr>
  780. <div class="refsect2">
  781. <a name="g-socket-client-connect-to-service"></a><h3>g_socket_client_connect_to_service ()</h3>
  782. <pre class="programlisting"><a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="returnvalue">GSocketConnection</span></a> *
  783. g_socket_client_connect_to_service (<em class="parameter"><code><a class="link" href="GSocketClient.html" title="GSocketClient"><span class="type">GSocketClient</span></a> *client</code></em>,
  784. <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>,
  785. <em class="parameter"><code>const <a href="../glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service</code></em>,
  786. <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
  787. <em class="parameter"><code><a href="../glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  788. <p>Attempts to create a TCP connection to a service.</p>
  789. <p>This call looks up the SRV record for <em class="parameter"><code>service</code></em>
  790. at <em class="parameter"><code>domain</code></em>
  791. for the
  792. "tcp" protocol. It then attempts to connect, in turn, to each of
  793. the hosts providing the service until either a connection succeeds
  794. or there are no hosts remaining.</p>
  795. <p>Upon a successful connection, a new <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> is constructed
  796. and returned. The caller owns this new object and must drop their
  797. reference to it when finished with it.</p>
  798. <p>In the event of any failure (DNS error, service not found, no hosts
  799. connectable) <a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned and <em class="parameter"><code>error</code></em>
  800. (if non-<a href="../glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) is set
  801. accordingly.</p>
  802. <div class="refsect3">
  803. <a name="g-socket-client-connect-to-service.parameters"></a><h4>Parameters</h4>
  804. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  805. <colgroup>
  806. <col width="150px" class="parameters_name">
  807. <col class="parameters_description">
  808. <col width="200px" class="parameters_annotations">
  809. </colgroup>
  810. <tbody>
  811. <tr>
  812. <td class="parameter_name"><p>client</p></td>
  813. <td class="parameter_description"><p>a <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSo

Large files files are truncated, but you can click here to view the full file