~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed : revision 203

44

<tbody>

45

<tr>

46

47

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

47

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

48

</td>

49

50

(<a class="link" href="GSocket.html#GSocketSourceFunc" title="GSocketSourceFunc ()">*GSocketSourceFunc</a>) ()

68

</tr>

69

<tr>

70

71

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

71

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

72

</td>

73

74

<a class="link" href="GSocket.html#g-socket-bind" title="g_socket_bind ()">g_socket_bind</a> ()

76

</tr>

77

<tr>

78

79

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

79

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

80

</td>

81

82

<a class="link" href="GSocket.html#g-socket-listen" title="g_socket_listen ()">g_socket_listen</a> ()

92

</tr>

93

<tr>

94

95

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

95

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

96

</td>

97

98

<a class="link" href="GSocket.html#g-socket-connect" title="g_socket_connect ()">g_socket_connect</a> ()

100

</tr>

101

<tr>

102

103

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

103

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

104

</td>

105

106

<a class="link" href="GSocket.html#g-socket-check-connect-result" title="g_socket_check_connect_result ()">g_socket_check_connect_result</a> ()

108

</tr>

109

<tr>

110

111

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

111

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

112

</td>

113

114

<a class="link" href="GSocket.html#g-socket-receive" title="g_socket_receive ()">g_socket_receive</a> ()

116

</tr>

117

<tr>

118

119

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

119

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

120

</td>

121

122

<a class="link" href="GSocket.html#g-socket-receive-from" title="g_socket_receive_from ()">g_socket_receive_from</a> ()

124

</tr>

125

<tr>

126

127

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

127

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

128

</td>

129

130

<a class="link" href="GSocket.html#g-socket-receive-message" title="g_socket_receive_message ()">g_socket_receive_message</a> ()

132

</tr>

133

<tr>

134

135

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

135

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

136

</td>

137

138

<a class="link" href="GSocket.html#g-socket-receive-with-blocking" title="g_socket_receive_with_blocking ()">g_socket_receive_with_blocking</a> ()

140

</tr>

141

<tr>

142

143

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

143

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

144

</td>

145

146

<a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()">g_socket_send</a> ()

148

</tr>

149

<tr>

150

151

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

151

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

152

</td>

153

154

<a class="link" href="GSocket.html#g-socket-send-to" title="g_socket_send_to ()">g_socket_send_to</a> ()

156

</tr>

157

<tr>

158

159

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

159

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

160

</td>

161

162

<a class="link" href="GSocket.html#g-socket-send-message" title="g_socket_send_message ()">g_socket_send_message</a> ()

164

</tr>

165

<tr>

166

167

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

167

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

168

</td>

169

170

<a class="link" href="GSocket.html#g-socket-send-with-blocking" title="g_socket_send_with_blocking ()">g_socket_send_with_blocking</a> ()

172

</tr>

173

<tr>

174

175

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

175

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

176

</td>

177

178

<a class="link" href="GSocket.html#g-socket-close" title="g_socket_close ()">g_socket_close</a> ()

180

</tr>

181

<tr>

182

183

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

183

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

184

</td>

185

186

<a class="link" href="GSocket.html#g-socket-is-closed" title="g_socket_is_closed ()">g_socket_is_closed</a> ()

188

</tr>

189

<tr>

190

191

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

191

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

192

</td>

193

194

<a class="link" href="GSocket.html#g-socket-shutdown" title="g_socket_shutdown ()">g_socket_shutdown</a> ()

196

</tr>

197

<tr>

198

199

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

199

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

200

</td>

201

202

<a class="link" href="GSocket.html#g-socket-is-connected" title="g_socket_is_connected ()">g_socket_is_connected</a> ()

204

</tr>

205

<tr>

206

207

<a href="../glib/glib-The-Main-Event-Loop.html#GSource">GSource</a> *

207

<a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource">GSource</a> *

208

</td>

209

210

<a class="link" href="GSocket.html#g-socket-create-source" title="g_socket_create_source ()">g_socket_create_source</a> ()

212

</tr>

213

<tr>

214

215

<a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a>

215

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a>

216

</td>

217

218

<a class="link" href="GSocket.html#g-socket-condition-check" title="g_socket_condition_check ()">g_socket_condition_check</a> ()

220

</tr>

221

<tr>

222

223

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

223

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

224

</td>

225

226

<a class="link" href="GSocket.html#g-socket-condition-wait" title="g_socket_condition_wait ()">g_socket_condition_wait</a> ()

228

</tr>

229

<tr>

230

231

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

231

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

232

</td>

233

234

<a class="link" href="GSocket.html#g-socket-condition-timed-wait" title="g_socket_condition_timed_wait ()">g_socket_condition_timed_wait</a> ()

236

</tr>

237

<tr>

238

239

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

239

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

240

</td>

241

242

<a class="link" href="GSocket.html#g-socket-get-available-bytes" title="g_socket_get_available_bytes ()">g_socket_get_available_bytes</a> ()

252

</tr>

253

<tr>

254

255

255

256

</td>

257

258

<a class="link" href="GSocket.html#g-socket-get-listen-backlog" title="g_socket_get_listen_backlog ()">g_socket_get_listen_backlog</a> ()

260

</tr>

261

<tr>

262

263

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

263

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

264

</td>

265

266

<a class="link" href="GSocket.html#g-socket-get-blocking" title="g_socket_get_blocking ()">g_socket_get_blocking</a> ()

276

</tr>

277

<tr>

278

279

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

279

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

280

</td>

281

282

<a class="link" href="GSocket.html#g-socket-get-keepalive" title="g_socket_get_keepalive ()">g_socket_get_keepalive</a> ()

292

</tr>

293

<tr>

294

295

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

295

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

296

</td>

297

298

<a class="link" href="GSocket.html#g-socket-get-timeout" title="g_socket_get_timeout ()">g_socket_get_timeout</a> ()

316

</tr>

317

<tr>

318

319

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

319

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

320

</td>

321

322

<a class="link" href="GSocket.html#g-socket-get-ttl" title="g_socket_get_ttl ()">g_socket_get_ttl</a> ()

324

</tr>

325

<tr>

326

327

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

327

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

328

</td>

329

330

<a class="link" href="GSocket.html#g-socket-get-broadcast" title="g_socket_get_broadcast ()">g_socket_get_broadcast</a> ()

340

</tr>

341

<tr>

342

343

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

343

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

344

</td>

345

346

<a class="link" href="GSocket.html#g-socket-get-option" title="g_socket_get_option ()">g_socket_get_option</a> ()

348

</tr>

349

<tr>

350

351

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

351

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

352

</td>

353

354

<a class="link" href="GSocket.html#g-socket-set-option" title="g_socket_set_option ()">g_socket_set_option</a> ()

404

</tr>

405

<tr>

406

407

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

407

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

408

</td>

409

410

<a class="link" href="GSocket.html#g-socket-speaks-ipv4" title="g_socket_speaks_ipv4 ()">g_socket_speaks_ipv4</a> ()

420

</tr>

421

<tr>

422

423

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

423

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

424

</td>

425

426

<a class="link" href="GSocket.html#g-socket-join-multicast-group" title="g_socket_join_multicast_group ()">g_socket_join_multicast_group</a> ()

428

</tr>

429

<tr>

430

431

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

431

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

432

</td>

433

434

<a class="link" href="GSocket.html#g-socket-leave-multicast-group" title="g_socket_leave_multicast_group ()">g_socket_leave_multicast_group</a> ()

436

</tr>

437

<tr>

438

439

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

439

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

440

</td>

441

442

<a class="link" href="GSocket.html#g-socket-get-multicast-loopback" title="g_socket_get_multicast_loopback ()">g_socket_get_multicast_loopback</a> ()

452

</tr>

453

<tr>

454

455

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

455

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

456

</td>

457

458

<a class="link" href="GSocket.html#g-socket-get-multicast-ttl" title="g_socket_get_multicast_ttl ()">g_socket_get_multicast_ttl</a> ()

479

</colgroup>

480

<tbody>

481

<tr>

482

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

482

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

483

<td class="property_name"><a class="link" href="GSocket.html#GSocket--blocking" title="The “blocking” property">blocking</a></td>

484

<td class="property_flags">Read / Write</td>

485

</tr>

486

<tr>

487

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

487

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

488

<td class="property_name"><a class="link" href="GSocket.html#GSocket--broadcast" title="The “broadcast” property">broadcast</a></td>

489

<td class="property_flags">Read / Write</td>

490

</tr>

494

<td class="property_flags">Read / Write / Construct Only</td>

495

</tr>

496

<tr>

497

497

498

499

<td class="property_flags">Read / Write / Construct Only</td>

500

</tr>

501

<tr>

502

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

502

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

503

<td class="property_name"><a class="link" href="GSocket.html#GSocket--keepalive" title="The “keepalive” property">keepalive</a></td>

504

<td class="property_flags">Read / Write</td>

505

</tr>

506

<tr>

507

507

508

<td class="property_name"><a class="link" href="GSocket.html#GSocket--listen-backlog" title="The “listen-backlog” property">listen-backlog</a></td>

509

<td class="property_flags">Read / Write</td>

510

</tr>

515

516

</tr>

517

<tr>

518

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

518

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

519

<td class="property_name"><a class="link" href="GSocket.html#GSocket--multicast-loopback" title="The “multicast-loopback” property">multicast-loopback</a></td>

520

<td class="property_flags">Read / Write</td>

521

</tr>

522

<tr>

523

<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint">guint</a></td>

523

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></td>

524

<td class="property_name"><a class="link" href="GSocket.html#GSocket--multicast-ttl" title="The “multicast-ttl” property">multicast-ttl</a></td>

525

<td class="property_flags">Read / Write</td>

526

</tr>

536

537

</tr>

538

<tr>

539

<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint">guint</a></td>

539

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></td>

540

<td class="property_name"><a class="link" href="GSocket.html#GSocket--timeout" title="The “timeout” property">timeout</a></td>

541

<td class="property_flags">Read / Write</td>

542

</tr>

543

<tr>

544

<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint">guint</a></td>

544

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></td>

545

546

<td class="property_flags">Read / Write</td>

547

</tr>

590

</div>

591

592

<a name="GSocket.object-hierarchy"></a><h2>Object Hierarchy</h2>

593

<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

593

<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

594

╰── GSocket

595

</pre>

596

</div>

616

<a class="link" href="GSocketService.html" title="GSocketService">GSocketService</a> and <a class="link" href="GSocketConnection.html" title="GSocketConnection">GSocketConnection</a>. However there may be cases where

617

direct use of <a class="link" href="GSocket.html" title="GSocket">GSocket</a> is useful.

618

<a class="link" href="GSocket.html" title="GSocket">GSocket</a> implements the <a class="link" href="GInitable.html" title="GInitable">GInitable</a> interface, so if it is manually constructed

619

by e.g. <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a> you must call <a class="link" href="GInitable.html#g-initable-init" title="g_initable_init ()"><code class="function">g_initable_init()</code></a> and check the

619

by e.g. <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a> you must call <a class="link" href="GInitable.html#g-initable-init" title="g_initable_init ()"><code class="function">g_initable_init()</code></a> and check the

620

results before using the object. This is done automatically in

621

<a class="link" href="GSocket.html#g-socket-new" title="g_socket_new ()"><code class="function">g_socket_new()</code></a> and <a class="link" href="GSocket.html#g-socket-new-from-fd" title="g_socket_new_from_fd ()"><code class="function">g_socket_new_from_fd()</code></a>, so these functions can return

622

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

622

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

623

Sockets operate in two general modes, blocking or non-blocking. When

624

in blocking mode all operations block until the requested operation

625

is finished or there is an error. In non-blocking mode all calls that

626

would block return immediately with a <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error.

627

To know when a call would successfully run you can call <a class="link" href="GSocket.html#g-socket-condition-check" title="g_socket_condition_check ()"><code class="function">g_socket_condition_check()</code></a>,

628

or <a class="link" href="GSocket.html#g-socket-condition-wait" title="g_socket_condition_wait ()"><code class="function">g_socket_condition_wait()</code></a>. You can also use <a class="link" href="GSocket.html#g-socket-create-source" title="g_socket_create_source ()"><code class="function">g_socket_create_source()</code></a> and

629

attach it to a <a href="../glib/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> to get callbacks when I/O is possible.

629

attach it to a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> to get callbacks when I/O is possible.

630

Note that all sockets are always set to non blocking mode in the system, and

631

blocking mode is emulated in GSocket.

632

When working in non-blocking mode applications should always be able to

651

<a name="GSocket.functions_details"></a><h2>Functions</h2>

652

653

<a name="GSocketSourceFunc"></a><h3>GSocketSourceFunc ()</h3>

654

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

654

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

655

(*GSocketSourceFunc) (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

656

<code><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

657

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

658

This is the function type of the callback used for the <a href="../glib/glib-The-Main-Event-Loop.html#GSource">GSource</a>

656

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

657

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

658

This is the function type of the callback used for the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource">GSource</a>

659

returned by <a class="link" href="GSocket.html#g-socket-create-source" title="g_socket_create_source ()"><code class="function">g_socket_create_source()</code></a>.

660

661

<a name="id-1.4.13.2.10.2.5"></a><h4>Parameters</h4>

686

</div>

687

688

<a name="id-1.4.13.2.10.2.6"></a><h4>Returns</h4>

689

it should return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the source should be removed.

689

it should return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the source should be removed.

690

691

</div>

692

Since 2.22

698

g_socket_new (<code><a class="link" href="GSocketAddress.html#GSocketFamily" title="enum GSocketFamily">GSocketFamily</a> family</code>,

699

<code><a class="link" href="GSocket.html#GSocketType" title="enum GSocketType">GSocketType</a> type</code>,

700

<code><a class="link" href="GSocket.html#GSocketProtocol" title="enum GSocketProtocol">GSocketProtocol</a> protocol</code>,

701

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

701

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

702

Creates a new <a class="link" href="GSocket.html" title="GSocket">GSocket</a> with the defined family, type and protocol.

703

If <code>protocol</code>

704

is 0 (<a class="link" href="GSocket.html#G-SOCKET-PROTOCOL-DEFAULT:CAPS"><code class="literal">G_SOCKET_PROTOCOL_DEFAULT</code></a>) the default protocol type

738

</tr>

739

<tr>

740

<td class="parameter_name">error</td>

741

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

741

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

742

743

</tr>

744

</tbody>

746

</div>

747

748

<a name="id-1.4.13.2.10.3.8"></a><h4>Returns</h4>

749

a <a class="link" href="GSocket.html" title="GSocket">GSocket</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

750

Free the returned object with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

749

a <a class="link" href="GSocket.html" title="GSocket">GSocket</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

750

Free the returned object with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

751

752

</div>

753

Since 2.22

756

757

<a name="g-socket-new-from-fd"></a><h3>g_socket_new_from_fd ()</h3>

758

<pre class="programlisting"><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *

759

g_socket_new_from_fd (<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> fd</code>,

760

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

759

g_socket_new_from_fd (<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> fd</code>,

760

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

761

Creates a new <a class="link" href="GSocket.html" title="GSocket">GSocket</a> from a native file descriptor

762

or winsock SOCKET handle.

763

This reads all the settings from the file descriptor so that

780

</tr>

781

<tr>

782

<td class="parameter_name">error</td>

783

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

783

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

784

785

</tr>

786

</tbody>

788

</div>

789

790

<a name="id-1.4.13.2.10.4.7"></a><h4>Returns</h4>

791

a <a class="link" href="GSocket.html" title="GSocket">GSocket</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

792

Free the returned object with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

791

a <a class="link" href="GSocket.html" title="GSocket">GSocket</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

792

Free the returned object with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

793

794

</div>

795

Since 2.22

797

<hr>

798

799

<a name="g-socket-bind"></a><h3>g_socket_bind ()</h3>

800

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

800

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

801

g_socket_bind (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

802

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *address</code>,

803

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> allow_reuse</code>,

804

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

803

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> allow_reuse</code>,

804

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

805

When a socket is created it is attached to an address family, but it

806

doesn't have an address in this family. <a class="link" href="GSocket.html#g-socket-bind" title="g_socket_bind ()"><code class="function">g_socket_bind()</code></a> assigns the

807

address (sometimes called name) of the socket.

812

If <code>socket</code>

813

is a TCP socket, then <code>allow_reuse</code>

814

controls the setting

815

of the <code class="literal">SO_REUSEADDR</code> socket option; normally it should be <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for

815

of the <code class="literal">SO_REUSEADDR</code> socket option; normally it should be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for

816

server sockets (sockets that you will eventually call

817

<a class="link" href="GSocket.html#g-socket-accept" title="g_socket_accept ()"><code class="function">g_socket_accept()</code></a> on), and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for client sockets. (Failing to

817

<a class="link" href="GSocket.html#g-socket-accept" title="g_socket_accept ()"><code class="function">g_socket_accept()</code></a> on), and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for client sockets. (Failing to

818

set this flag on a server socket may cause <a class="link" href="GSocket.html#g-socket-bind" title="g_socket_bind ()"><code class="function">g_socket_bind()</code></a> to return

819

<a class="link" href="gio-GIOError.html#G-IO-ERROR-ADDRESS-IN-USE:CAPS"><code class="literal">G_IO_ERROR_ADDRESS_IN_USE</code></a> if the server program is stopped and then

820

immediately restarted.)

852

</tr>

853

<tr>

854

<td class="parameter_name">error</td>

855

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

855

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

856

857

</tr>

858

</tbody>

860

</div>

861

862

<a name="id-1.4.13.2.10.5.9"></a><h4>Returns</h4>

863

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

863

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

864

865

</div>

866

Since 2.22

868

<hr>

869

870

<a name="g-socket-listen"></a><h3>g_socket_listen ()</h3>

871

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

871

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

872

g_socket_listen (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

873

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

873

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

874

Marks the socket as a server socket, i.e. a socket that is used

875

to accept incoming requests using <a class="link" href="GSocket.html#g-socket-accept" title="g_socket_accept ()"><code class="function">g_socket_accept()</code></a>.

876

Before calling this the socket must be bound to a local address using

893

</tr>

894

<tr>

895

<td class="parameter_name">error</td>

896

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

896

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

897

898

</tr>

899

</tbody>

901

</div>

902

903

<a name="id-1.4.13.2.10.6.8"></a><h4>Returns</h4>

904

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

904

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

905

906

</div>

907

Since 2.22

912

<pre class="programlisting"><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *

913

g_socket_accept (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

914

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

915

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

915

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

916

Accept incoming connections on a connection-based socket. This removes

917

the first outstanding connection request from the listening socket and

918

creates a <a class="link" href="GSocket.html" title="GSocket">GSocket</a> object for it.

921

must be listening for incoming connections (<a class="link" href="GSocket.html#g-socket-listen" title="g_socket_listen ()"><code class="function">g_socket_listen()</code></a>).

922

If there are no outstanding connections then the operation will block

923

or return <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> if non-blocking I/O is enabled.

924

To be notified of an incoming connection, wait for the <code class="literal">G_IO_IN</code> condition.

924

To be notified of an incoming connection, wait for the <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-IN:CAPS"><code class="literal">G_IO_IN</code></a> condition.

925

926

<a name="id-1.4.13.2.10.7.7"></a><h4>Parameters</h4>

927

938

</tr>

939

<tr>

940

<td class="parameter_name">cancellable</td>

941

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

941

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

942

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

943

</tr>

944

<tr>

945

<td class="parameter_name">error</td>

946

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

946

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

947

948

</tr>

949

</tbody>

951

</div>

952

953

<a name="id-1.4.13.2.10.7.8"></a><h4>Returns</h4>

954

a new <a class="link" href="GSocket.html" title="GSocket">GSocket</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

955

Free the returned object with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

954

a new <a class="link" href="GSocket.html" title="GSocket">GSocket</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

955

Free the returned object with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

956

[<acronym title="Free data after the code is done.">transfer full</acronym>]

957

</div>

958

Since 2.22

960

<hr>

961

962

<a name="g-socket-connect"></a><h3>g_socket_connect ()</h3>

963

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

963

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

964

g_socket_connect (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

965

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *address</code>,

966

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

967

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

967

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

968

Connect the socket to the specified remote address.

969

For connection oriented socket this generally means we attempt to make

970

a connection to the <code>address</code>

1000

</tr>

1001

<tr>

1002

<td class="parameter_name">cancellable</td>

1003

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1003

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1004

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1005

</tr>

1006

<tr>

1007

<td class="parameter_name">error</td>

1008

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1008

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1009

1010

</tr>

1011

</tbody>

1013

</div>

1014

1015

<a name="id-1.4.13.2.10.8.9"></a><h4>Returns</h4>

1016

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if connected, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

1016

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if connected, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

1017

1018

</div>

1019

Since 2.22

1021

<hr>

1022

1023

<a name="g-socket-check-connect-result"></a><h3>g_socket_check_connect_result ()</h3>

1024

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1024

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1025

g_socket_check_connect_result (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1026

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1026

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1027

Checks and resets the pending connect error for the socket.

1028

This is used to check for errors when <a class="link" href="GSocket.html#g-socket-connect" title="g_socket_connect ()"><code class="function">g_socket_connect()</code></a> is

1029

used in non-blocking mode.

1043

</tr>

1044

<tr>

1045

<td class="parameter_name">error</td>

1046

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1046

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1047

1048

</tr>

1049

</tbody>

1051

</div>

1052

1053

<a name="id-1.4.13.2.10.9.6"></a><h4>Returns</h4>

1054

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise, setting <code>error</code>

1054

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if no error, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise, setting <code>error</code>

1055

to the error

1056

1057

</div>

1060

<hr>

1061

1062

<a name="g-socket-receive"></a><h3>g_socket_receive ()</h3>

1063

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1063

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1064

g_socket_receive (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1065

<code><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1066

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1065

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1066

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1067

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1068

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1068

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1069

Receive data (up to <code>size</code>

1070

bytes) from a socket. This is mainly used by

1071

connection-oriented sockets; it is identical to <a class="link" href="GSocket.html#g-socket-receive-from" title="g_socket_receive_from ()"><code class="function">g_socket_receive_from()</code></a>

1072

with <code>address</code>

1073

set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1073

set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1074

For <a class="link" href="GSocket.html#G-SOCKET-TYPE-DATAGRAM:CAPS"><code class="literal">G_SOCKET_TYPE_DATAGRAM</code></a> and <a class="link" href="GSocket.html#G-SOCKET-TYPE-SEQPACKET:CAPS"><code class="literal">G_SOCKET_TYPE_SEQPACKET</code></a> sockets,

1075

<a class="link" href="GSocket.html#g-socket-receive" title="g_socket_receive ()"><code class="function">g_socket_receive()</code></a> will always read either 0 or 1 complete messages from

1076

the socket. If the received message is too large to fit in <code>buffer</code>

1089

error. If there is no data available and the socket is in

1090

non-blocking mode, a <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error will be

1091

returned. To be notified when data is available, wait for the

1092

<code class="literal">G_IO_IN</code> condition.

1092

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-IN:CAPS"><code class="literal">G_IO_IN</code></a> condition.

1093

On error -1 is returned and <code>error</code>

1094

is set accordingly.

1095

1120

</tr>

1121

<tr>

1122

<td class="parameter_name">cancellable</td>

1123

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1123

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1124

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1125

</tr>

1126

<tr>

1127

<td class="parameter_name">error</td>

1128

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1128

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1129

1130

</tr>

1131

</tbody>

1142

<hr>

1143

1144

<a name="g-socket-receive-from"></a><h3>g_socket_receive_from ()</h3>

1145

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1145

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1146

g_socket_receive_from (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1147

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> **address</code>,

1148

<code><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1149

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1148

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1149

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1150

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1151

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1151

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1152

Receive data (up to <code>size</code>

1153

bytes) from a socket.

1154

If <code>address</code>

1155

is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <code>address</code>

1155

is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <code>address</code>

1156

will be set equal to the

1157

source address of the received packet.

1158

<code>address</code>

1175

<tr>

1176

<td class="parameter_name">address</td>

1177

<td class="parameter_description"> a pointer to a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>

1178

pointer, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1178

pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1179

<td class="parameter_annotations">[<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1180

</tr>

1181

<tr>

1192

</tr>

1193

<tr>

1194

<td class="parameter_name">cancellable</td>

1195

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1195

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1196

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1197

</tr>

1198

<tr>

1199

<td class="parameter_name">error</td>

1200

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1200

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1201

1202

</tr>

1203

</tbody>

1214

<hr>

1215

1216

<a name="g-socket-receive-message"></a><h3>g_socket_receive_message ()</h3>

1217

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1217

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1218

g_socket_receive_message (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1219

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> **address</code>,

1220

<code><a class="link" href="GSocket.html#GInputVector" title="struct GInputVector">GInputVector</a> *vectors</code>,

1221

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> num_vectors</code>,

1221

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> num_vectors</code>,

1222

<code><a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> ***messages</code>,

1223

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> *num_messages</code>,

1224

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> *flags</code>,

1223

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *num_messages</code>,

1224

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *flags</code>,

1225

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1226

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1226

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1227

Receive data from a socket. This is the most complicated and

1228

fully-featured version of this call. For easier use, see

1229

<a class="link" href="GSocket.html#g-socket-receive" title="g_socket_receive ()"><code class="function">g_socket_receive()</code></a> and <a class="link" href="GSocket.html#g-socket-receive-from" title="g_socket_receive_from ()"><code class="function">g_socket_receive_from()</code></a>.

1230

If <code>address</code>

1231

is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <code>address</code>

1231

is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then <code>address</code>

1232

will be set equal to the

1233

source address of the received packet.

1234

<code>address</code>

1241

If <code>num_vectors</code>

1242

is -1, then <code>vectors</code>

1243

is assumed to be terminated

1244

by a <a class="link" href="GSocket.html#GInputVector" title="struct GInputVector">GInputVector</a> with a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.

1244

by a <a class="link" href="GSocket.html#GInputVector" title="struct GInputVector">GInputVector</a> with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.

1245

As a special case, if <code>num_vectors</code>

1246

is 0 (in which case, <code>vectors</code>

1247

1248

may of course be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>), then a single byte is received and

1248

may of course be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>), then a single byte is received and

1249

discarded. This is to facilitate the common practice of sending a

1250

single '\0' byte for the purposes of transferring ancillary data.

1251

<code>messages</code>

1252

, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be set to point to a newly-allocated

1253

array of <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> instances or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such

1252

, if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be set to point to a newly-allocated

1253

array of <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> instances or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such

1254

messages was received. These correspond to the control messages

1255

received from the kernel, one <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> per message

1256

from the kernel. This array is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated and must be freed

1257

by the caller using <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after calling <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> on each

1256

from the kernel. This array is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated and must be freed

1257

by the caller using <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> after calling <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> on each

1258

element. If <code>messages</code>

1259

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, any control messages received will

1259

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, any control messages received will

1260

be discarded.

1261

<code>num_messages</code>

1262

, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be set to the number of control

1262

, if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be set to the number of control

1263

messages received.

1264

If both <code>messages</code>

1265

and <code>num_messages</code>

1266

are non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then

1266

are non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then

1267

<code>num_messages</code>

1268

gives the number of <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> instances

1269

in <code>messages</code>

1270

(ie: not including the <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminator).

1270

(ie: not including the <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminator).

1271

<code>flags</code>

1272

is an in/out parameter. The commonly available arguments

1273

for this are available in the <a class="link" href="GSocket.html#GSocketMsgFlags" title="enum GSocketMsgFlags">GSocketMsgFlags</a> enum, but the

1288

error. If there is no data available and the socket is in

1289

non-blocking mode, a <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error will be

1290

returned. To be notified when data is available, wait for the

1291

<code class="literal">G_IO_IN</code> condition.

1291

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-IN:CAPS"><code class="literal">G_IO_IN</code></a> condition.

1292

On error -1 is returned and <code>error</code>

1293

is set accordingly.

1294

1308

<tr>

1309

<td class="parameter_name">address</td>

1310

<td class="parameter_description"> a pointer to a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>

1311

pointer, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1311

pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1312

<td class="parameter_annotations">[<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1313

</tr>

1314

<tr>

1325

<tr>

1326

<td class="parameter_name">messages</td>

1327

<td class="parameter_description"> a pointer which

1328

may be filled with an array of <a href="GSocketControlMessage.html">GSocketControlMessages</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1328

may be filled with an array of <a href="GSocketControlMessage.html">GSocketControlMessages</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1329

<td class="parameter_annotations">[<acronym title="Parameter points to an array of items.">array</acronym> length=num_messages][<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1330

</tr>

1331

<tr>

1332

<td class="parameter_name">num_messages</td>

1333

<td class="parameter_description">a pointer which will be filled with the number of

1334

elements in <code>messages</code>

1335

, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1335

, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1336

1337

</tr>

1338

<tr>

1342

</tr>

1343

<tr>

1344

<td class="parameter_name">cancellable</td>

1345

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1345

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1346

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1347

</tr>

1348

<tr>

1349

<td class="parameter_name">error</td>

1350

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1350

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

1351

1352

</tr>

1353

</tbody>

1364

<hr>

1365

1366

<a name="g-socket-receive-with-blocking"></a><h3>g_socket_receive_with_blocking ()</h3>

1367

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1367

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1368

g_socket_receive_with_blocking (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1369

<code><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1370

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1371

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>,

1369

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1370

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1371

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>,

1372

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1373

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1373

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1374

This behaves exactly the same as <a class="link" href="GSocket.html#g-socket-receive" title="g_socket_receive ()"><code class="function">g_socket_receive()</code></a>, except that

1375

the choice of blocking or non-blocking behavior is determined by

1376

the <code>blocking</code>

1409

</tr>

1410

<tr>

1411

<td class="parameter_name">cancellable</td>

1412

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1412

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1413

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1414

</tr>

1415

<tr>

1416

<td class="parameter_name">error</td>

1417

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1417

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1418

1419

</tr>

1420

</tbody>

1431

<hr>

1432

1433

<a name="g-socket-send"></a><h3>g_socket_send ()</h3>

1434

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1434

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1435

g_socket_send (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1436

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1437

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1436

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1437

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1438

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1439

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1439

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1440

Tries to send <code>size</code>

1441

bytes from <code>buffer</code>

1442

on the socket. This is

1443

mainly used by connection-oriented sockets; it is identical to

1444

<a class="link" href="GSocket.html#g-socket-send-to" title="g_socket_send_to ()"><code class="function">g_socket_send_to()</code></a> with <code>address</code>

1445

set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1445

set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1446

If the socket is in blocking mode the call will block until there is

1447

space for the data in the socket queue. If there is no space available

1448

and the socket is in non-blocking mode a <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error

1449

will be returned. To be notified when space is available, wait for the

1450

<code class="literal">G_IO_OUT</code> condition. Note though that you may still receive

1450

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-OUT:CAPS"><code class="literal">G_IO_OUT</code></a> condition. Note though that you may still receive

1451

<a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> from <a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a> even if you were previously

1452

notified of a <code class="literal">G_IO_OUT</code> condition. (On Windows in particular, this is

1452

notified of a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-OUT:CAPS"><code class="literal">G_IO_OUT</code></a> condition. (On Windows in particular, this is

1453

very common due to the way the underlying APIs work.)

1454

On error -1 is returned and <code>error</code>

1455

is set accordingly.

1480

</tr>

1481

<tr>

1482

<td class="parameter_name">cancellable</td>

1483

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1483

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1484

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1485

</tr>

1486

<tr>

1487

<td class="parameter_name">error</td>

1488

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1488

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1489

1490

</tr>

1491

</tbody>

1503

<hr>

1504

1505

<a name="g-socket-send-to"></a><h3>g_socket_send_to ()</h3>

1506

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1506

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1507

g_socket_send_to (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1508

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *address</code>,

1509

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1510

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1509

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1510

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1511

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1512

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1512

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1513

Tries to send <code>size</code>

1514

bytes from <code>buffer</code>

1515

to <code>address</code>

1516

. If <code>address</code>

1517

is

1518

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the message is sent to the default receiver (set by

1518

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the message is sent to the default receiver (set by

1519

<a class="link" href="GSocket.html#g-socket-connect" title="g_socket_connect ()"><code class="function">g_socket_connect()</code></a>).

1520

See <a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a> for additional information.

1521

1534

</tr>

1535

<tr>

1536

<td class="parameter_name">address</td>

1537

<td class="parameter_description"> a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1537

<td class="parameter_description"> a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1538

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1539

</tr>

1540

<tr>

1550

</tr>

1551

<tr>

1552

<td class="parameter_name">cancellable</td>

1553

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1553

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1554

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1555

</tr>

1556

<tr>

1557

<td class="parameter_name">error</td>

1558

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1558

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1559

1560

</tr>

1561

</tbody>

1573

<hr>

1574

1575

<a name="g-socket-send-message"></a><h3>g_socket_send_message ()</h3>

1576

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1576

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1577

g_socket_send_message (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1578

<code><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *address</code>,

1579

<code><a class="link" href="GSocket.html#GOutputVector" title="struct GOutputVector">GOutputVector</a> *vectors</code>,

1580

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> num_vectors</code>,

1580

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> num_vectors</code>,

1581

<code><a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> **messages</code>,

1582

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> num_messages</code>,

1583

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> flags</code>,

1582

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> num_messages</code>,

1583

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> flags</code>,

1584

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1585

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1585

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1586

Send data to <code>address</code>

1587

on <code>socket</code>

1588

. This is the most complicated and

1589

fully-featured version of this call. For easier use, see

1590

<a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a> and <a class="link" href="GSocket.html#g-socket-send-to" title="g_socket_send_to ()"><code class="function">g_socket_send_to()</code></a>.

1591

If <code>address</code>

1592

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the message is sent to the default receiver

1592

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the message is sent to the default receiver

1593

(set by <a class="link" href="GSocket.html#g-socket-connect" title="g_socket_connect ()"><code class="function">g_socket_connect()</code></a>).

1594

<code>vectors</code>

1595

must point to an array of <a class="link" href="GSocket.html#GOutputVector" title="struct GOutputVector">GOutputVector</a> structs and

1598

is -1,

1599

then <code>vectors</code>

1600

is assumed to be terminated by a <a class="link" href="GSocket.html#GOutputVector" title="struct GOutputVector">GOutputVector</a> with a

1601

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.) The <a class="link" href="GSocket.html#GOutputVector" title="struct GOutputVector">GOutputVector</a> structs describe the buffers

1601

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> buffer pointer.) The <a class="link" href="GSocket.html#GOutputVector" title="struct GOutputVector">GOutputVector</a> structs describe the buffers

1602

that the sent data will be gathered from. Using multiple

1603

<a href="GSocket.html#GOutputVector">GOutputVectors</a> is more memory-efficient than manually copying

1604

data from multiple sources into a single buffer, and more

1605

network-efficient than making multiple calls to <a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a>.

1606

<code>messages</code>

1607

, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, is taken to point to an array of <code>num_messages</code>

1607

, if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, is taken to point to an array of <code>num_messages</code>

1608

1609

<a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a> instances. These correspond to the control

1610

messages to be sent on the socket.

1611

If <code>num_messages</code>

1612

is -1 then <code>messages</code>

1613

is treated as a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated

1613

is treated as a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated

1614

array.

1615

<code>flags</code>

1616

modify how the message is sent. The commonly available arguments

1621

space for the data in the socket queue. If there is no space available

1622

and the socket is in non-blocking mode a <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> error

1623

will be returned. To be notified when space is available, wait for the

1624

<code class="literal">G_IO_OUT</code> condition. Note though that you may still receive

1624

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-OUT:CAPS"><code class="literal">G_IO_OUT</code></a> condition. Note though that you may still receive

1625

<a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a> from <a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a> even if you were previously

1626

notified of a <code class="literal">G_IO_OUT</code> condition. (On Windows in particular, this is

1626

notified of a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-OUT:CAPS"><code class="literal">G_IO_OUT</code></a> condition. (On Windows in particular, this is

1627

very common due to the way the underlying APIs work.)

1628

On error -1 is returned and <code>error</code>

1629

is set accordingly.

1643

</tr>

1644

<tr>

1645

<td class="parameter_name">address</td>

1646

<td class="parameter_description"> a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1646

<td class="parameter_description"> a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1647

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1648

</tr>

1649

<tr>

1660

<tr>

1661

<td class="parameter_name">messages</td>

1662

<td class="parameter_description"> a pointer to an

1663

array of <a href="GSocketControlMessage.html">GSocketControlMessages</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1663

array of <a href="GSocketControlMessage.html">GSocketControlMessages</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1664

<td class="parameter_annotations">[<acronym title="Parameter points to an array of items.">array</acronym> length=num_messages][<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1665

</tr>

1666

<tr>

1676

</tr>

1677

<tr>

1678

<td class="parameter_name">cancellable</td>

1679

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1679

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1680

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1681

</tr>

1682

<tr>

1683

<td class="parameter_name">error</td>

1684

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1684

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1685

1686

</tr>

1687

</tbody>

1699

<hr>

1700

1701

<a name="g-socket-send-with-blocking"></a><h3>g_socket_send_with_blocking ()</h3>

1702

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1702

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1703

g_socket_send_with_blocking (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1704

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1705

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1706

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>,

1704

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *buffer</code>,

1705

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>,

1706

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>,

1707

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1708

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1708

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1709

This behaves exactly the same as <a class="link" href="GSocket.html#g-socket-send" title="g_socket_send ()"><code class="function">g_socket_send()</code></a>, except that

1710

the choice of blocking or non-blocking behavior is determined by

1711

the <code>blocking</code>

1743

</tr>

1744

<tr>

1745

<td class="parameter_name">cancellable</td>

1746

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1746

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1747

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1748

</tr>

1749

<tr>

1750

<td class="parameter_name">error</td>

1751

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1751

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1752

1753

</tr>

1754

</tbody>

1766

<hr>

1767

1768

<a name="g-socket-close"></a><h3>g_socket_close ()</h3>

1769

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1769

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1770

g_socket_close (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1771

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1771

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1772

Closes the socket, shutting down any active connection.

1773

Closing a socket does not wait for all outstanding I/O operations

1774

to finish, so the caller should not rely on them to be guaranteed

1781

resources are released as early as possible.

1782

Beware that due to the way that TCP works, it is possible for

1783

recently-sent data to be lost if either you close a socket while the

1784

<code class="literal">G_IO_IN</code> condition is set, or else if the remote connection tries to

1784

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-IN:CAPS"><code class="literal">G_IO_IN</code></a> condition is set, or else if the remote connection tries to

1785

send something to you after you close the socket but before it has

1786

finished reading all of the data you sent. There is no easy generic

1787

way to avoid this problem; the easiest fix is to design the network

1811

</tr>

1812

<tr>

1813

<td class="parameter_name">error</td>

1814

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1814

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1815

1816

</tr>

1817

</tbody>

1819

</div>

1820

1821

<a name="id-1.4.13.2.10.18.10"></a><h4>Returns</h4>

1822

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

1822

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

1823

1824

</div>

1825

Since 2.22

1827

<hr>

1828

1829

<a name="g-socket-is-closed"></a><h3>g_socket_is_closed ()</h3>

1830

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1830

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1831

g_socket_is_closed (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

1832

Checks whether a socket is closed.

1833

1847

</div>

1848

1849

<a name="id-1.4.13.2.10.19.6"></a><h4>Returns</h4>

1850

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if socket is closed, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

1850

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if socket is closed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

1851

1852

</div>

1853

Since 2.22

1855

<hr>

1856

1857

<a name="g-socket-shutdown"></a><h3>g_socket_shutdown ()</h3>

1858

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1858

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1859

g_socket_shutdown (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1860

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> shutdown_read</code>,

1861

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> shutdown_write</code>,

1862

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1860

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> shutdown_read</code>,

1861

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> shutdown_write</code>,

1862

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1863

Shut down part of a full-duplex connection.

1864

If <code>shutdown_read</code>

1865

is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then the receiving side of the connection

1865

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then the receiving side of the connection

1866

is shut down, and further reading is disallowed.

1867

If <code>shutdown_write</code>

1868

is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then the sending side of the connection

1868

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then the sending side of the connection

1869

is shut down, and further writing is disallowed.

1870

It is allowed for both <code>shutdown_read</code>

1871

and <code>shutdown_write</code>

1872

to be <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.

1872

to be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.

1873

One example where this is used is graceful disconnect for TCP connections

1874

where you close the sending side, then wait for the other side to close

1875

the connection, thus ensuring that the other side saw all sent data.

1899

</tr>

1900

<tr>

1901

<td class="parameter_name">error</td>

1902

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1902

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

1903

1904

</tr>

1905

</tbody>

1907

</div>

1908

1909

<a name="id-1.4.13.2.10.20.10"></a><h4>Returns</h4>

1910

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

1910

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

1911

1912

</div>

1913

Since 2.22

1915

<hr>

1916

1917

<a name="g-socket-is-connected"></a><h3>g_socket_is_connected ()</h3>

1918

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1918

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1919

g_socket_is_connected (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

1920

Check whether the socket is connected. This is only useful for

1921

connection-oriented sockets.

1936

</div>

1937

1938

<a name="id-1.4.13.2.10.21.6"></a><h4>Returns</h4>

1939

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if socket is connected, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1939

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if socket is connected, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1940

1941

</div>

1942

Since 2.22

1944

<hr>

1945

1946

<a name="g-socket-create-source"></a><h3>g_socket_create_source ()</h3>

1947

<pre class="programlisting"><a href="../glib/glib-The-Main-Event-Loop.html#GSource">GSource</a> *

1947

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource">GSource</a> *

1948

g_socket_create_source (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

1949

<code><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

1949

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

1950

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>);</pre>

1951

Creates a <a href="../glib/glib-The-Main-Event-Loop.html#GSource"><code class="literal">GSource</code></a> that can be attached to a <a href="../glib/glib-The-Main-Event-Loop.html#GMainContext"><code class="literal">GMainContext</code></a> to monitor

1951

Creates a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><code class="literal">GSource</code></a> that can be attached to a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><code class="literal">GMainContext</code></a> to monitor

1952

for the availability of the specified <code>condition</code>

1953

on the socket.

1954

The callback on the source is of the <a class="link" href="GSocket.html#GSocketSourceFunc" title="GSocketSourceFunc ()">GSocketSourceFunc</a> type.

1955

It is meaningless to specify <code class="literal">G_IO_ERR</code> or <code class="literal">G_IO_HUP</code> in <code>condition</code>

1955

It is meaningless to specify <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-ERR:CAPS"><code class="literal">G_IO_ERR</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-HUP:CAPS"><code class="literal">G_IO_HUP</code></a> in <code>condition</code>

1956

;

1957

these conditions will always be reported output if they are true.

1958

<code>cancellable</code>

1959

if not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> can be used to cancel the source, which will

1959

if not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> can be used to cancel the source, which will

1960

cause the source to trigger, reporting the current condition (which

1961

is likely 0 unless cancellation happened at the same time as a

1962

condition change). You can check for this in the callback using

1964

If <code>socket</code>

1965

has a timeout set, and it is reached before <code>condition</code>

1966

1967

occurs, the source will then trigger anyway, reporting <code class="literal">G_IO_IN</code> or

1968

<code class="literal">G_IO_OUT</code> depending on <code>condition</code>

1967

occurs, the source will then trigger anyway, reporting <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-IN:CAPS"><code class="literal">G_IO_IN</code></a> or

1968

<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-OUT:CAPS"><code class="literal">G_IO_OUT</code></a> depending on <code>condition</code>

1969

. However, <code>socket</code>

1970

will have been

1971

marked as having had a timeout, and so the next <a class="link" href="GSocket.html" title="GSocket">GSocket</a> I/O method

1986

</tr>

1987

<tr>

1988

<td class="parameter_name">condition</td>

1989

<td class="parameter_description">a <a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to monitor</td>

1989

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to monitor</td>

1990

1991

</tr>

1992

<tr>

1993

<td class="parameter_name">cancellable</td>

1994

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1994

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable"><code class="literal">GCancellable</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

1995

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1996

</tr>

1997

</tbody>

1999

</div>

2000

2001

<a name="id-1.4.13.2.10.22.10"></a><h4>Returns</h4>

2002

a newly allocated <a href="../glib/glib-The-Main-Event-Loop.html#GSource"><code class="literal">GSource</code></a>, free with <a href="../glib/glib-The-Main-Event-Loop.html#g-source-unref"><code class="function">g_source_unref()</code></a>.

2002

a newly allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><code class="literal">GSource</code></a>, free with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-unref"><code class="function">g_source_unref()</code></a>.

2003

[<acronym title="Free data after the code is done.">transfer full</acronym>]

2004

</div>

2005

Since 2.22

2007

<hr>

2008

2009

<a name="g-socket-condition-check"></a><h3>g_socket_condition_check ()</h3>

2010

<pre class="programlisting"><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a>

2010

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a>

2011

g_socket_condition_check (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2012

<code><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>);</pre>

2012

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>);</pre>

2013

Checks on the readiness of <code>socket</code>

2014

to perform operations.

2015

The operations specified in <code>condition</code>

2024

writing to the socket if it succeeds, it is generally better to

2025

simply try writing to the socket right away, and try again later if

2026

the initial attempt returns <a class="link" href="gio-GIOError.html#G-IO-ERROR-WOULD-BLOCK:CAPS"><code class="literal">G_IO_ERROR_WOULD_BLOCK</code></a>.

2027

It is meaningless to specify <code class="literal">G_IO_ERR</code> or <code class="literal">G_IO_HUP</code> in condition;

2027

It is meaningless to specify <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-ERR:CAPS"><code class="literal">G_IO_ERR</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-IO-HUP:CAPS"><code class="literal">G_IO_HUP</code></a> in condition;

2028

these conditions will always be set in the output if they are true.

2029

This call never blocks.

2030

2043

</tr>

2044

<tr>

2045

<td class="parameter_name">condition</td>

2046

<td class="parameter_description">a <a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to check</td>

2046

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to check</td>

2047

2048

</tr>

2049

</tbody>

2060

<hr>

2061

2062

<a name="g-socket-condition-wait"></a><h3>g_socket_condition_wait ()</h3>

2063

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2063

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2064

g_socket_condition_wait (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2065

<code><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

2065

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

2066

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

2067

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2067

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2068

Waits for <code>condition</code>

2069

to become true on <code>socket</code>

2070

. When the condition

2071

is met, <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

2071

is met, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

2072

If <code>cancellable</code>

2073

is cancelled before the condition is met, or if the

2074

socket has a timeout set and it is reached before the condition is

2075

met, then <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

2076

, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, is set to

2075

met, then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

2076

, if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, is set to

2077

the appropriate value (<a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> or

2078

<a class="link" href="gio-GIOError.html#G-IO-ERROR-TIMED-OUT:CAPS"><code class="literal">G_IO_ERROR_TIMED_OUT</code></a>).

2079

See also <a class="link" href="GSocket.html#g-socket-condition-timed-wait" title="g_socket_condition_timed_wait ()"><code class="function">g_socket_condition_timed_wait()</code></a>.

2093

</tr>

2094

<tr>

2095

<td class="parameter_name">condition</td>

2096

<td class="parameter_description">a <a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to wait for</td>

2096

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to wait for</td>

2097

2098

</tr>

2099

<tr>

2100

<td class="parameter_name">cancellable</td>

2101

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2101

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2102

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

2103

</tr>

2104

<tr>

2105

<td class="parameter_name">error</td>

2106

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2106

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2107

2108

</tr>

2109

</tbody>

2111

</div>

2112

2113

<a name="id-1.4.13.2.10.24.8"></a><h4>Returns</h4>

2114

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the condition was met, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

2114

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the condition was met, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

2115

2116

</div>

2117

Since 2.22

2119

<hr>

2120

2121

<a name="g-socket-condition-timed-wait"></a><h3>g_socket_condition_timed_wait ()</h3>

2122

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2122

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2123

g_socket_condition_timed_wait (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2124

<code><a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

2125

<code><a href="../glib/glib-Basic-Types.html#gint64">gint64</a> timeout</code>,

2124

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> condition</code>,

2125

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64">gint64</a> timeout</code>,

2126

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

2127

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2127

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2128

Waits for up to <code>timeout</code>

2129

microseconds for <code>condition</code>

2130

to become true

2131

on <code>socket</code>

2132

. If the condition is met, <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

2132

. If the condition is met, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

2133

If <code>cancellable</code>

2134

is cancelled before the condition is met, or if

2135

<code>timeout</code>

2136

(or the socket's <a class="link" href="GSocket.html#GSocket--timeout" title="The “timeout” property">“timeout”</a>) is reached before the

2137

condition is met, then <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

2138

, if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

2137

condition is met, then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

2138

, if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

2139

is set to the appropriate value (<a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> or

2140

<a class="link" href="gio-GIOError.html#G-IO-ERROR-TIMED-OUT:CAPS"><code class="literal">G_IO_ERROR_TIMED_OUT</code></a>).

2141

If you don't want a timeout, use <a class="link" href="GSocket.html#g-socket-condition-wait" title="g_socket_condition_wait ()"><code class="function">g_socket_condition_wait()</code></a>.

2163

</tr>

2164

<tr>

2165

<td class="parameter_name">condition</td>

2166

<td class="parameter_description">a <a href="../glib/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to wait for</td>

2166

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition">GIOCondition</a> mask to wait for</td>

2167

2168

</tr>

2169

<tr>

2173

</tr>

2174

<tr>

2175

<td class="parameter_name">cancellable</td>

2176

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2176

<td class="parameter_description"> a <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2177

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

2178

</tr>

2179

<tr>

2180

<td class="parameter_name">error</td>

2181

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2181

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2182

2183

</tr>

2184

</tbody>

2186

</div>

2187

2188

<a name="id-1.4.13.2.10.25.9"></a><h4>Returns</h4>

2189

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the condition was met, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

2189

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the condition was met, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise

2190

2191

</div>

2192

Since 2.32

2194

<hr>

2195

2196

<a name="g-socket-get-available-bytes"></a><h3>g_socket_get_available_bytes ()</h3>

2197

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

2197

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

2198

g_socket_get_available_bytes (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2199

Get the amount of data pending in the OS input buffer.

2200

If <code>socket</code>

2235

<a name="g-socket-set-listen-backlog"></a><h3>g_socket_set_listen_backlog ()</h3>

2236

<pre class="programlisting">void

2237

g_socket_set_listen_backlog (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2238

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> backlog</code>);</pre>

2238

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> backlog</code>);</pre>

2239

Sets the maximum number of outstanding connections allowed

2240

when listening on this socket. If more clients than this are

2241

connecting to the socket and the application is not handling them

2269

<hr>

2270

2271

<a name="g-socket-get-listen-backlog"></a><h3>g_socket_get_listen_backlog ()</h3>

2272

2272

2273

g_socket_get_listen_backlog (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2274

Gets the listen backlog setting of the socket. For details on this,

2275

see <a class="link" href="GSocket.html#g-socket-set-listen-backlog" title="g_socket_set_listen_backlog ()"><code class="function">g_socket_set_listen_backlog()</code></a>.

2298

<hr>

2299

2300

<a name="g-socket-get-blocking"></a><h3>g_socket_get_blocking ()</h3>

2301

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2301

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2302

g_socket_get_blocking (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2303

Gets the blocking mode of the socket. For details on blocking I/O,

2304

see <a class="link" href="GSocket.html#g-socket-set-blocking" title="g_socket_set_blocking ()"><code class="function">g_socket_set_blocking()</code></a>.

2319

</div>

2320

2321

<a name="id-1.4.13.2.10.29.6"></a><h4>Returns</h4>

2322

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if blocking I/O is used, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

2322

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if blocking I/O is used, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

2323

2324

</div>

2325

Since 2.22

2329

<a name="g-socket-set-blocking"></a><h3>g_socket_set_blocking ()</h3>

2330

<pre class="programlisting">void

2331

g_socket_set_blocking (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2332

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>);</pre>

2332

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> blocking</code>);</pre>

2333

Sets the blocking mode of the socket. In blocking mode

2334

all operations block until they succeed or there is an error. In

2335

non-blocking mode all functions return results immediately or

2364

<hr>

2365

2366

<a name="g-socket-get-keepalive"></a><h3>g_socket_get_keepalive ()</h3>

2367

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2367

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2368

g_socket_get_keepalive (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2369

Gets the keepalive mode of the socket. For details on this,

2370

see <a class="link" href="GSocket.html#g-socket-set-keepalive" title="g_socket_set_keepalive ()"><code class="function">g_socket_set_keepalive()</code></a>.

2385

</div>

2386

2387

<a name="id-1.4.13.2.10.31.6"></a><h4>Returns</h4>

2388

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if keepalive is active, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

2388

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if keepalive is active, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

2389

2390

</div>

2391

Since 2.22

2395

<a name="g-socket-set-keepalive"></a><h3>g_socket_set_keepalive ()</h3>

2396

<pre class="programlisting">void

2397

g_socket_set_keepalive (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2398

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> keepalive</code>);</pre>

2398

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> keepalive</code>);</pre>

2399

Sets or unsets the <code class="literal">SO_KEEPALIVE</code> flag on the underlying socket. When

2400

this flag is set on a socket, the system will attempt to verify that the

2401

remote socket endpoint is still present if a sufficiently long period of

2436

<hr>

2437

2438

<a name="g-socket-get-timeout"></a><h3>g_socket_get_timeout ()</h3>

2439

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

2439

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

2440

g_socket_get_timeout (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2441

Gets the timeout setting of the socket. For details on this, see

2442

<a class="link" href="GSocket.html#g-socket-set-timeout" title="g_socket_set_timeout ()"><code class="function">g_socket_set_timeout()</code></a>.

2467

<a name="g-socket-set-timeout"></a><h3>g_socket_set_timeout ()</h3>

2468

<pre class="programlisting">void

2469

g_socket_set_timeout (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2470

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> timeout</code>);</pre>

2470

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> timeout</code>);</pre>

2471

Sets the time in seconds after which I/O operations on <code>socket</code>

2472

will

2473

time out if they have not yet completed.

2518

<a name="g-socket-set-ttl"></a><h3>g_socket_set_ttl ()</h3>

2519

<pre class="programlisting">void

2520

g_socket_set_ttl (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2521

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> ttl</code>);</pre>

2521

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> ttl</code>);</pre>

2522

Sets the time-to-live for outgoing unicast packets on <code>socket</code>

2523

.

2524

By default the platform-specific default value is used.

2550

<hr>

2551

2552

<a name="g-socket-get-ttl"></a><h3>g_socket_get_ttl ()</h3>

2553

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

2553

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

2554

g_socket_get_ttl (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2555

Gets the unicast time-to-live setting on <code>socket</code>

2556

; see

2581

<hr>

2582

2583

<a name="g-socket-get-broadcast"></a><h3>g_socket_get_broadcast ()</h3>

2584

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2584

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2585

g_socket_get_broadcast (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2586

Gets the broadcast setting on <code>socket</code>

2587

; if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,

2587

; if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,

2588

it is possible to send packets to broadcast

2589

addresses.

2590

2615

<a name="g-socket-set-broadcast"></a><h3>g_socket_set_broadcast ()</h3>

2616

<pre class="programlisting">void

2617

g_socket_set_broadcast (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2618

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> broadcast</code>);</pre>

2618

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> broadcast</code>);</pre>

2619

Sets whether <code>socket</code>

2620

should allow sending to broadcast addresses.

2621

This is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> by default.

2621

This is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> by default.

2622

2623

<a name="id-1.4.13.2.10.38.5"></a><h4>Parameters</h4>

2624

2648

<hr>

2649

2650

<a name="g-socket-get-option"></a><h3>g_socket_get_option ()</h3>

2651

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2651

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2652

g_socket_get_option (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2653

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> level</code>,

2654

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> optname</code>,

2655

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> *value</code>,

2656

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2653

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> level</code>,

2654

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> optname</code>,

2655

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *value</code>,

2656

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2657

Gets the value of an integer-valued option on <code>socket</code>

2658

, as with

2659

<code class="function">getsockopt()</code>. (If you need to fetch a non-integer-valued option,

2665

headers.

2666

Note that even for socket options that are a single byte in size,

2667

<code>value</code>

2668

is still a pointer to a <a href="../glib/glib-Basic-Types.html#gint">gint</a> variable, not a <a href="../glib/glib-Basic-Types.html#guchar">guchar</a>;

2668

is still a pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> variable, not a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar">guchar</a>;

2669

<a class="link" href="GSocket.html#g-socket-get-option" title="g_socket_get_option ()"><code class="function">g_socket_get_option()</code></a> will handle the conversion internally.

2670

2671

<a name="id-1.4.13.2.10.39.7"></a><h4>Parameters</h4>

2698

</tr>

2699

<tr>

2700

<td class="parameter_name">error</td>

2701

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2701

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2702

2703

</tr>

2704

</tbody>

2717

<hr>

2718

2719

<a name="g-socket-set-option"></a><h3>g_socket_set_option ()</h3>

2720

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2720

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2721

g_socket_set_option (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2722

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> level</code>,

2723

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> optname</code>,

2724

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> value</code>,

2725

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2722

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> level</code>,

2723

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> optname</code>,

2724

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> value</code>,

2725

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2726

Sets the value of an integer-valued option on <code>socket</code>

2727

, as with

2728

<code class="function">setsockopt()</code>. (If you need to set a non-integer-valued option,

2763

</tr>

2764

<tr>

2765

<td class="parameter_name">error</td>

2766

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2766

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2767

2768

</tr>

2769

</tbody>

2844

<a name="g-socket-get-local-address"></a><h3>g_socket_get_local_address ()</h3>

2845

<pre class="programlisting"><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *

2846

g_socket_get_local_address (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2847

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2847

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2848

Try to get the local address of a bound socket. This is only

2849

useful if the socket has been bound to a local address,

2850

either explicitly or implicitly when connecting.

2864

</tr>

2865

<tr>

2866

<td class="parameter_name">error</td>

2867

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2867

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2868

2869

</tr>

2870

</tbody>

2872

</div>

2873

2874

<a name="id-1.4.13.2.10.43.6"></a><h4>Returns</h4>

2875

a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

2876

Free the returned object with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

2875

a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

2876

Free the returned object with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

2877

[<acronym title="Free data after the code is done.">transfer full</acronym>]

2878

</div>

2879

Since 2.22

2912

<a name="g-socket-get-remote-address"></a><h3>g_socket_get_remote_address ()</h3>

2913

<pre class="programlisting"><a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> *

2914

g_socket_get_remote_address (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

2915

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2915

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

2916

Try to get the remove address of a connected socket. This is only

2917

useful for connection oriented sockets that have been connected.

2918

2931

</tr>

2932

<tr>

2933

<td class="parameter_name">error</td>

2934

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2934

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

2935

2936

</tr>

2937

</tbody>

2939

</div>

2940

2941

<a name="id-1.4.13.2.10.45.6"></a><h4>Returns</h4>

2942

a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

2943

Free the returned object with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

2942

a <a class="link" href="GSocketAddress.html" title="GSocketAddress">GSocketAddress</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.

2943

Free the returned object with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

2944

[<acronym title="Free data after the code is done.">transfer full</acronym>]

2945

</div>

2946

Since 2.22

2976

<hr>

2977

2978

<a name="g-socket-speaks-ipv4"></a><h3>g_socket_speaks_ipv4 ()</h3>

2979

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2979

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

2980

g_socket_speaks_ipv4 (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

2981

Checks if a socket is capable of speaking IPv4.

2982

IPv4 sockets are capable of speaking IPv4. On some operating systems

3002

</div>

3003

3004

<a name="id-1.4.13.2.10.47.8"></a><h4>Returns</h4>

3005

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this socket can be used with IPv4.

3005

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this socket can be used with IPv4.

3006

3007

</div>

3008

Since 2.22

3012

<a name="g-socket-get-credentials"></a><h3>g_socket_get_credentials ()</h3>

3013

<pre class="programlisting"><a class="link" href="GCredentials.html" title="GCredentials">GCredentials</a> *

3014

g_socket_get_credentials (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

3015

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3015

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3016

Returns the credentials of the foreign process connected to this

3017

socket, if any (e.g. it is only supported for <a class="link" href="GSocketAddress.html#G-SOCKET-FAMILY-UNIX:CAPS"><code class="literal">G_SOCKET_FAMILY_UNIX</code></a>

3018

sockets).

3039

</tr>

3040

<tr>

3041

<td class="parameter_name">error</td>

3042

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3042

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3043

3044

</tr>

3045

</tbody>

3047

</div>

3048

3049

<a name="id-1.4.13.2.10.48.8"></a><h4>Returns</h4>

3050

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>error</code>

3050

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>error</code>

3051

is set, otherwise a <a class="link" href="GCredentials.html" title="GCredentials">GCredentials</a> object

3052

that must be freed with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

3052

that must be freed with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.

3053

[<acronym title="Free data after the code is done.">transfer full</acronym>]

3054

</div>

3055

Since 2.26

3057

<hr>

3058

3059

<a name="g-socket-join-multicast-group"></a><h3>g_socket_join_multicast_group ()</h3>

3060

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3060

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

3061

g_socket_join_multicast_group (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

3062

<code><a class="link" href="GInetAddress.html" title="GInetAddress">GInetAddress</a> *group</code>,

3063

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> source_specific</code>,

3064

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *iface</code>,

3065

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3063

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> source_specific</code>,

3064

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *iface</code>,

3065

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3066

Registers <code>socket</code>

3067

to receive multicast messages sent to <code>group</code>

3068

.

3071

been bound to an appropriate interface and port with

3072

<a class="link" href="GSocket.html#g-socket-bind" title="g_socket_bind ()"><code class="function">g_socket_bind()</code></a>.

3073

If <code>iface</code>

3074

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the system will automatically pick an interface

3074

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the system will automatically pick an interface

3075

to bind to based on <code>group</code>

3076

.

3077

If <code>source_specific</code>

3078

is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, source-specific multicast as defined

3078

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, source-specific multicast as defined

3079

in RFC 4604 is used. Note that on older platforms this may fail

3080

with a <a class="link" href="gio-GIOError.html#G-IO-ERROR-NOT-SUPPORTED:CAPS"><code class="literal">G_IO_ERROR_NOT_SUPPORTED</code></a> error.

3081

3099

</tr>

3100

<tr>

3101

<td class="parameter_name">iface</td>

3102

<td class="parameter_description"> Name of the interface to use, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

3102

<td class="parameter_description"> Name of the interface to use, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

3103

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

3104

</tr>

3105

<tr>

3106

<td class="parameter_name">source_specific</td>

3107

<td class="parameter_description"><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if source-specific multicast should be used</td>

3107

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if source-specific multicast should be used</td>

3108

3109

</tr>

3110

<tr>

3111

<td class="parameter_name">error</td>

3112

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3112

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3113

3114

</tr>

3115

</tbody>

3117

</div>

3118

3119

<a name="id-1.4.13.2.10.49.8"></a><h4>Returns</h4>

3120

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

3120

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

3121

3122

</div>

3123

Since 2.32

3125

<hr>

3126

3127

<a name="g-socket-leave-multicast-group"></a><h3>g_socket_leave_multicast_group ()</h3>

3128

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3128

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

3129

g_socket_leave_multicast_group (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

3130

<code><a class="link" href="GInetAddress.html" title="GInetAddress">GInetAddress</a> *group</code>,

3131

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> source_specific</code>,

3132

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *iface</code>,

3133

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3131

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> source_specific</code>,

3132

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *iface</code>,

3133

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

3134

Removes <code>socket</code>

3135

from the multicast group defined by <code>group</code>

3136

, <code>iface</code>

3167

</tr>

3168

<tr>

3169

<td class="parameter_name">source_specific</td>

3170

<td class="parameter_description"><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if source-specific multicast was used</td>

3170

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if source-specific multicast was used</td>

3171

3172

</tr>

3173

<tr>

3174

<td class="parameter_name">error</td>

3175

<td class="parameter_description"><a href="../glib/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3175

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> for error reporting, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore.</td>

3176

3177

</tr>

3178

</tbody>

3180

</div>

3181

3182

<a name="id-1.4.13.2.10.50.7"></a><h4>Returns</h4>

3183

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

3183

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.

3184

3185

</div>

3186

Since 2.32

3188

<hr>

3189

3190

<a name="g-socket-get-multicast-loopback"></a><h3>g_socket_get_multicast_loopback ()</h3>

3191

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3191

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

3192

g_socket_get_multicast_loopback (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

3193

Gets the multicast loopback setting on <code>socket</code>

3194

; if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (the

3194

; if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (the

3195

default), outgoing multicast packets will be looped back to

3196

multicast listeners on the same host.

3197

3222

<a name="g-socket-set-multicast-loopback"></a><h3>g_socket_set_multicast_loopback ()</h3>

3223

<pre class="programlisting">void

3224

g_socket_set_multicast_loopback (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

3225

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> loopback</code>);</pre>

3225

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> loopback</code>);</pre>

3226

Sets whether outgoing multicast packets will be received by sockets

3227

listening on that multicast address on the same host. This is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>

3227

listening on that multicast address on the same host. This is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>

3228

by default.

3229

3230

<a name="id-1.4.13.2.10.52.5"></a><h4>Parameters</h4>

3255

<hr>

3256

3257

<a name="g-socket-get-multicast-ttl"></a><h3>g_socket_get_multicast_ttl ()</h3>

3258

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

3258

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

3259

g_socket_get_multicast_ttl (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>);</pre>

3260

Gets the multicast time-to-live setting on <code>socket</code>

3261

; see

3288

<a name="g-socket-set-multicast-ttl"></a><h3>g_socket_set_multicast_ttl ()</h3>

3289

<pre class="programlisting">void

3290

g_socket_set_multicast_ttl (<code><a class="link" href="GSocket.html" title="GSocket">GSocket</a> *socket</code>,

3291

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> ttl</code>);</pre>

3291

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> ttl</code>);</pre>

3292

Sets the time-to-live for outgoing multicast datagrams on <code>socket</code>

3293

.

3294

By default, this is 1, meaning that multicast packets will not leave

3508

</colgroup>

3509

<tbody>

3510

<tr>

3511

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="GInputVector.buffer"></a>buffer</code>;</td>

3511

<td class="struct_member_name"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="GInputVector.buffer"></a>buffer</code>;</td>

3512

<td class="struct_member_description">Pointer to a buffer where data will be written.</td>

3513

3514

</tr>

3515

<tr>

3516

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GInputVector.size"></a>size</code>;</td>

3516

<td class="struct_member_name"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GInputVector.size"></a>size</code>;</td>

3517

<td class="struct_member_description">the available size in <code>buffer</code>

3518

.</td>

3519

3545

</colgroup>

3546

<tbody>

3547

<tr>

3548

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gconstpointer">gconstpointer</a> <code><a name="GOutputVector.buffer"></a>buffer</code>;</td>

3548

<td class="struct_member_name"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer">gconstpointer</a> <code><a name="GOutputVector.buffer"></a>buffer</code>;</td>

3549

<td class="struct_member_description">Pointer to a buffer of data to read.</td>

3550

3551

</tr>

3552

<tr>

3553

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GOutputVector.size"></a>size</code>;</td>

3553

<td class="struct_member_name"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GOutputVector.size"></a>size</code>;</td>

3554

<td class="struct_member_description">the size of <code>buffer</code>

3555

.</td>

3556

3565

<a name="GSocket.property-details"></a><h2>Property Details</h2>

3566

3567

<a name="GSocket--blocking"></a><h3>The <code class="literal">“blocking”</code> property</h3>

3568

<pre class="programlisting"> “blocking” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3568

<pre class="programlisting"> “blocking” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3569

Whether or not I/O on this socket is blocking.

3570

Flags: Read / Write

3571

Default value: TRUE

3573

<hr>

3574

3575

<a name="GSocket--broadcast"></a><h3>The <code class="literal">“broadcast”</code> property</h3>

3576

<pre class="programlisting"> “broadcast” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3576

<pre class="programlisting"> “broadcast” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3577

Whether the socket should allow sending to broadcast addresses.

3578

Flags: Read / Write

3579

Default value: FALSE

3590

<hr>

3591

3592

<a name="GSocket--fd"></a><h3>The <code class="literal">“fd”</code> property</h3>

3593

3593

3594

The sockets file descriptor.

3595

Flags: Read / Write / Construct Only

3596

Default value: -1

3598

<hr>

3599

3600

<a name="GSocket--keepalive"></a><h3>The <code class="literal">“keepalive”</code> property</h3>

3601

<pre class="programlisting"> “keepalive” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3601

<pre class="programlisting"> “keepalive” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3602

Keep connection alive by sending periodic pings.

3603

Flags: Read / Write

3604

Default value: FALSE

3606

<hr>

3607

3608

<a name="GSocket--listen-backlog"></a><h3>The <code class="literal">“listen-backlog”</code> property</h3>

3609

<pre class="programlisting"> “listen-backlog” <a href="../glib/glib-Basic-Types.html#gint">gint</a></pre>

3609

<pre class="programlisting"> “listen-backlog” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a></pre>

3610

Outstanding connections in the listen queue.

3611

Flags: Read / Write

3612

Allowed values: [0,128]

3622

<hr>

3623

3624

<a name="GSocket--multicast-loopback"></a><h3>The <code class="literal">“multicast-loopback”</code> property</h3>

3625

<pre class="programlisting"> “multicast-loopback” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3625

<pre class="programlisting"> “multicast-loopback” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3626

Whether outgoing multicast packets loop back to the local host.

3627

Flags: Read / Write

3628

Default value: TRUE

3631

<hr>

3632

3633

<a name="GSocket--multicast-ttl"></a><h3>The <code class="literal">“multicast-ttl”</code> property</h3>

3634

<pre class="programlisting"> “multicast-ttl” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3634

<pre class="programlisting"> “multicast-ttl” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></pre>

3635

Time-to-live out outgoing multicast packets

3636

Flags: Read / Write

3637

Default value: 1

3655

<hr>

3656

3657

<a name="GSocket--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3>

3658

<pre class="programlisting"> “timeout” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3658

<pre class="programlisting"> “timeout” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></pre>

3659

The timeout in seconds on socket I/O

3660

Flags: Read / Write

3661

Default value: 0

3664

<hr>

3665

3666

<a name="GSocket--ttl"></a><h3>The <code class="literal">“ttl”</code> property</h3>

3667

<pre class="programlisting"> “ttl” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3667

<pre class="programlisting"> “ttl” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></pre>

3668

Time-to-live for outgoing unicast packets

3669

Flags: Read / Write

3670

Default value: 0