~ubuntu-branches/ubuntu/utopic/glib2.0/utopic : revision 1.63.43

44

<tbody>

45

<tr>

46

47

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

47

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

71

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

79

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

95

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

103

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

111

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

119

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

127

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

135

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

143

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

151

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

159

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

167

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

175

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

183

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

191

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

199

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

207

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

215

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

223

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

231

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

239

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

263

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

279

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

295

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

319

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

327

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

343

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

351

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

407

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

423

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

431

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

439

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

455

<a href="../glib/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

482

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

487

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

502

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

518

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

523

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

539

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

544

<td class="property_type"><a href="../glib/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="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

593

<pre class="screen"> <a href="../gobject/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="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

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

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

622

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

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.

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

654

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

655

656

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

657

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

657

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

658

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

659

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

660

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

661

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

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

660

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

661

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

662

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>.

663

664

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

689

</div>

690

691

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

692

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.

692

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

693

694

</div>

695

Since 2.22

701

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

702

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

703

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

704

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

704

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

705

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

706

If <code>protocol</code>

707

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

741

</tr>

742

<tr>

743

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

744

<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>

744

<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>

745

746

</tr>

747

</tbody>

749

</div>

750

751

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

752

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.

753

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>.

752

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.

753

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>.

754

755

</div>

756

Since 2.22

759

760

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

761

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

762

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

763

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

762

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

763

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

764

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

765

or winsock SOCKET handle.

766

This reads all the settings from the file descriptor so that

783

</tr>

784

<tr>

785

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

786

<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>

786

<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>

787

788

</tr>

789

</tbody>

791

</div>

792

793

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

794

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.

795

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>.

794

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.

795

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>.

796

797

</div>

798

Since 2.22

800

<hr>

801

802

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

803

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

803

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

804

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

805

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

806

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

807

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

806

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

807

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

808

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

809

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

810

address (sometimes called name) of the socket.

815

If <code>socket</code>

816

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

817

controls the setting

818

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

818

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

819

server sockets (sockets that you will eventually call

820

<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

820

<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

821

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

822

<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

823

immediately restarted.)

855

</tr>

856

<tr>

857

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

858

<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>

858

<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>

859

860

</tr>

861

</tbody>

863

</div>

864

865

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

866

<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.

866

<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.

867

868

</div>

869

Since 2.22

871

<hr>

872

873

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

874

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

874

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

875

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

876

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

876

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

877

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

878

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>.

879

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

896

</tr>

897

<tr>

898

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

899

<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>

899

<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>

900

901

</tr>

902

</tbody>

904

</div>

905

906

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

907

<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.

907

<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.

908

909

</div>

910

Since 2.22

915

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

916

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

917

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

918

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

918

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

919

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

920

the first outstanding connection request from the listening socket and

921

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

941

</tr>

942

<tr>

943

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

944

<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>

944

<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>

945

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

946

</tr>

947

<tr>

948

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

949

<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>

949

<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>

950

951

</tr>

952

</tbody>

954

</div>

955

956

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

957

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.

958

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>.

957

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.

958

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>.

959

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

960

</div>

961

Since 2.22

963

<hr>

964

965

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

966

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

966

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

967

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

968

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

969

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

970

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

970

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

971

Connect the socket to the specified remote address.

972

For connection oriented socket this generally means we attempt to make

973

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

1003

</tr>

1004

<tr>

1005

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

1006

<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>

1006

<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>

1007

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

1008

</tr>

1009

<tr>

1010

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

1011

<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>

1011

<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>

1012

1013

</tr>

1014

</tbody>

1016

</div>

1017

1018

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

1019

<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.

1019

<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.

1020

1021

</div>

1022

Since 2.22

1024

<hr>

1025

1026

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

1027

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

1027

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

1028

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

1029

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

1029

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

1030

Checks and resets the pending connect error for the socket.

1031

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

1032

used in non-blocking mode.

1046

</tr>

1047

<tr>

1048

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

1049

<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>

1049

<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>

1050

1051

</tr>

1052

</tbody>

1054

</div>

1055

1056

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

1057

<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>

1057

<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>

1058

to the error

1059

1060

</div>

1063

<hr>

1064

1065

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

1066

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

1066

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

1067

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

1068

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

1069

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

1068

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

1069

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

1070

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

1071

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

1071

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

1072

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

1073

bytes) from a socket. This is mainly used by

1074

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>

1075

with <code>address</code>

1076

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

1076

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

1077

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,

1078

<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

1079

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

1123

</tr>

1124

<tr>

1125

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

1126

<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>

1126

<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>

1127

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

1128

</tr>

1129

<tr>

1130

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

1131

<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>

1131

<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>

1132

1133

</tr>

1134

</tbody>

1145

<hr>

1146

1147

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

1148

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

1148

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

1149

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

1150

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

1151

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

1152

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

1151

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

1152

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

1153

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

1154

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

1154

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

1155

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

1156

bytes) from a socket.

1157

If <code>address</code>

1158

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>

1158

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

1159

will be set equal to the

1160

source address of the received packet.

1161

<code>address</code>

1178

<tr>

1179

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

1180

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

1181

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

1181

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

1182

<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>

1183

</tr>

1184

<tr>

1195

</tr>

1196

<tr>

1197

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

1198

<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>

1198

<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>

1199

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

1200

</tr>

1201

<tr>

1202

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

1203

<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>

1203

<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>

1204

1205

</tr>

1206

</tbody>

1217

<hr>

1218

1219

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

1220

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

1220

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

1221

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

1222

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

1223

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

1224

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

1224

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

1225

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

1226

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

1227

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

1226

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

1227

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

1228

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

1229

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

1229

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

1230

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

1231

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

1232

<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>.

1233

If <code>address</code>

1234

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>

1234

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

1235

will be set equal to the

1236

source address of the received packet.

1237

<code>address</code>

1244

If <code>num_vectors</code>

1245

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

1246

is assumed to be terminated

1247

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.

1247

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.

1248

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

1249

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

1250

1251

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

1251

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

1252

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

1253

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

1254

<code>messages</code>

1255

, 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

1256

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

1255

, 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

1256

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

1257

messages was received. These correspond to the control messages

1258

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

1259

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

1260

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

1259

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

1260

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

1261

element. If <code>messages</code>

1262

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

1262

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

1263

be discarded.

1264

<code>num_messages</code>

1265

, 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

1265

, 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

1266

messages received.

1267

If both <code>messages</code>

1268

and <code>num_messages</code>

1269

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

1269

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

1270

<code>num_messages</code>

1271

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

1272

in <code>messages</code>

1273

(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).

1273

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

1274

<code>flags</code>

1275

is an in/out parameter. The commonly available arguments

1276

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

1311

<tr>

1312

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

1313

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

1314

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

1314

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

1315

<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>

1316

</tr>

1317

<tr>

1328

<tr>

1329

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

1330

<td class="parameter_description"> a pointer which

1331

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>

1331

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>

1332

<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>

1333

</tr>

1334

<tr>

1335

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

1336

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

1337

elements in <code>messages</code>

1338

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

1338

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

1339

1340

</tr>

1341

<tr>

1345

</tr>

1346

<tr>

1347

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

1348

<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>

1348

<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>

1349

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

1350

</tr>

1351

<tr>

1352

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

1353

<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>

1353

<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>

1354

1355

</tr>

1356

</tbody>

1367

<hr>

1368

1369

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

1370

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

1370

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

1371

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

1372

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

1373

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

1374

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

1372

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

1373

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

1374

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

1375

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

1376

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

1376

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

1377

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

1378

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

1379

the <code>blocking</code>

1412

</tr>

1413

<tr>

1414

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

1415

<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>

1415

<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>

1416

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

1417

</tr>

1418

<tr>

1419

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

1420

<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>

1420

<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>

1421

1422

</tr>

1423

</tbody>

1434

<hr>

1435

1436

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

1437

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

1437

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

1438

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

1439

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

1440

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

1439

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

1440

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

1441

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

1442

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

1442

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

1443

Tries to send <code>size</code>

1444

bytes from <code>buffer</code>

1445

on the socket. This is

1446

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

1447

<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>

1448

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

1448

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

1449

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

1450

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

1451

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

1483

</tr>

1484

<tr>

1485

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

1486

<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>

1486

<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>

1487

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

1488

</tr>

1489

<tr>

1490

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

1491

<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>

1491

<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>

1492

1493

</tr>

1494

</tbody>

1506

<hr>

1507

1508

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

1509

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

1509

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

1510

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

1511

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

1512

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

1513

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

1512

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

1513

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

1514

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

1515

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

1515

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

1516

Tries to send <code>size</code>

1517

bytes from <code>buffer</code>

1518

to <code>address</code>

1519

. If <code>address</code>

1520

is

1521

<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

1521

<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

1522

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

1523

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.

1524

1537

</tr>

1538

<tr>

1539

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

1540

<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>

1540

<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>

1541

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

1542

</tr>

1543

<tr>

1553

</tr>

1554

<tr>

1555

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

1556

<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>

1556

<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>

1557

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

1558

</tr>

1559

<tr>

1560

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

1561

<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>

1561

<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>

1562

1563

</tr>

1564

</tbody>

1576

<hr>

1577

1578

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

1579

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

1579

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

1580

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

1581

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

1582

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

1583

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

1583

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

1584

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

1585

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

1586

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

1585

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

1586

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

1587

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

1588

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

1588

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

1589

Send data to <code>address</code>

1590

on <code>socket</code>

1591

. This is the most complicated and

1592

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

1593

<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>.

1594

If <code>address</code>

1595

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

1595

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

1596

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

1597

<code>vectors</code>

1598

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

1601

is -1,

1602

then <code>vectors</code>

1603

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

1604

<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

1604

<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

1605

that the sent data will be gathered from. Using multiple

1606

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

1607

data from multiple sources into a single buffer, and more

1608

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>.

1609

<code>messages</code>

1610

, 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>

1610

, 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>

1611

1612

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

1613

messages to be sent on the socket.

1614

If <code>num_messages</code>

1615

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

1616

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

1616

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

1617

array.

1618

<code>flags</code>

1619

modify how the message is sent. The commonly available arguments

1646

</tr>

1647

<tr>

1648

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

1649

<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>

1649

<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>

1650

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

1651

</tr>

1652

<tr>

1663

<tr>

1664

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

1665

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

1666

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>

1666

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>

1667

<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>

1668

</tr>

1669

<tr>

1679

</tr>

1680

<tr>

1681

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

1682

<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>

1682

<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>

1683

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

1684

</tr>

1685

<tr>

1686

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

1687

<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>

1687

<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>

1688

1689

</tr>

1690

</tbody>

1702

<hr>

1703

1704

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

1705

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

1705

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

1706

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

1707

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

1708

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

1709

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

1707

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

1708

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

1709

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

1710

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

1711

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

1711

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

1712

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

1713

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

1714

the <code>blocking</code>

1746

</tr>

1747

<tr>

1748

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

1749

<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>

1749

<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>

1750

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

1751

</tr>

1752

<tr>

1753

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

1754

<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>

1754

<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>

1755

1756

</tr>

1757

</tbody>

1769

<hr>

1770

1771

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

1772

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

1772

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

1773

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

1774

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

1774

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

1775

Closes the socket, shutting down any active connection.

1776

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

1777

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

1814

</tr>

1815

<tr>

1816

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

1817

<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>

1817

<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>

1818

1819

</tr>

1820

</tbody>

1822

</div>

1823

1824

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

1825

<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

1825

<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

1826

1827

</div>

1828

Since 2.22

1830

<hr>

1831

1832

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

1833

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

1833

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

1834

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

1835

Checks whether a socket is closed.

1836

1850

</div>

1851

1852

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

1853

<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

1853

<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

1854

1855

</div>

1856

Since 2.22

1858

<hr>

1859

1860

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

1861

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

1861

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

1862

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

1863

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

1864

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

1865

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

1863

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

1864

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

1865

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

1866

Shut down part of a full-duplex connection.

1867

If <code>shutdown_read</code>

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 receiving side of the connection

1868

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

1869

is shut down, and further reading is disallowed.

1870

If <code>shutdown_write</code>

1871

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

1871

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

1872

is shut down, and further writing is disallowed.

1873

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

1874

and <code>shutdown_write</code>

1875

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

1875

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

1876

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

1877

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

1878

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

1902

</tr>

1903

<tr>

1904

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

1905

<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>

1905

<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>

1906

1907

</tr>

1908

</tbody>

1910

</div>

1911

1912

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

1913

<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

1913

<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

1914

1915

</div>

1916

Since 2.22

1918

<hr>

1919

1920

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

1921

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

1921

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

1922

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

1923

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

1924

connection-oriented sockets.

1939

</div>

1940

1941

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

1942

<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.

1942

<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.

1943

1944

</div>

1945

Since 2.22

1947

<hr>

1948

1949

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

1950

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

1950

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

1951

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

1952

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

1952

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

1953

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

1954

Creates a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource">GSource</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

1954

Creates a <a href="../glib/glib-The-Main-Event-Loop.html#GSource">GSource</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

1955

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

1956

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

1956

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

1957

keeps a reference to the <code>socket</code>

1958

.

1959

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

1961

;

1962

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

1963

<code>cancellable</code>

1964

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

1964

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

1965

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

1966

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

1967

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

1991

</tr>

1992

<tr>

1993

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

1994

<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>

1994

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

1995

1996

</tr>

1997

<tr>

1998

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

1999

<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>

1999

<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>

2000

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

2001

</tr>

2002

</tbody>

2004

</div>

2005

2006

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

2007

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>.

2007

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>.

2008

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

2009

</div>

2010

Since 2.22

2012

<hr>

2013

2014

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

2015

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

2015

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

2016

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

2017

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

2017

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

2018

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

2019

to perform operations.

2020

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

2048

</tr>

2049

<tr>

2050

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

2051

<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>

2051

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

2052

2053

</tr>

2054

</tbody>

2065

<hr>

2066

2067

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

2068

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

2068

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

2069

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

2070

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

2070

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

2071

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

2072

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

2072

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

2073

Waits for <code>condition</code>

2074

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

2075

. When the condition

2076

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.

2076

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

2077

If <code>cancellable</code>

2078

is cancelled before the condition is met, or if the

2079

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

2080

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>

2081

, 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

2080

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

2081

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

2082

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

2083

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

2084

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>.

2098

</tr>

2099

<tr>

2100

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

2101

<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>

2101

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

2102

2103

</tr>

2104

<tr>

2105

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

2106

<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>

2106

<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>

2107

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

2108

</tr>

2109

<tr>

2110

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

2111

<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>

2111

<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>

2112

2113

</tr>

2114

</tbody>

2116

</div>

2117

2118

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

2119

<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

2119

<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

2120

2121

</div>

2122

Since 2.22

2124

<hr>

2125

2126

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

2127

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

2127

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

2128

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

2129

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

2130

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

2129

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

2130

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

2131

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

2132

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

2132

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

2133

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

2134

microseconds for <code>condition</code>

2135

to become true

2136

on <code>socket</code>

2137

. 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.

2137

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

2138

If <code>cancellable</code>

2139

is cancelled before the condition is met, or if

2140

<code>timeout</code>

2141

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

2142

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>

2143

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

2142

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>

2143

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

2144

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

2145

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

2146

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>.

2168

</tr>

2169

<tr>

2170

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

2171

<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>

2171

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

2172

2173

</tr>

2174

<tr>

2178

</tr>

2179

<tr>

2180

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

2181

<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>

2181

<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>

2182

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

2183

</tr>

2184

<tr>

2185

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

2186

<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>

2186

<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>

2187

2188

</tr>

2189

</tbody>

2191

</div>

2192

2193

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

2194

<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

2194

<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

2195

2196

</div>

2197

Since 2.32

2199

<hr>

2200

2201

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

2202

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

2202

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

2203

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

2204

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

2205

If <code>socket</code>

2240

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

2241

<pre class="programlisting">void

2242

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

2243

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

2243

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

2244

Sets the maximum number of outstanding connections allowed

2245

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

2246

connecting to the socket and the application is not handling them

2274

<hr>

2275

2276

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

2277

2277

2278

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

2279

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

2280

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>.

2303

<hr>

2304

2305

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

2306

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

2306

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

2307

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

2308

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

2309

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>.

2324

</div>

2325

2326

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

2327

<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.

2327

<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.

2328

2329

</div>

2330

Since 2.22

2334

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

2335

<pre class="programlisting">void

2336

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

2337

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

2337

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

2338

Sets the blocking mode of the socket. In blocking mode

2339

all operations block until they succeed or there is an error. In

2340

non-blocking mode all functions return results immediately or

2369

<hr>

2370

2371

<a name="g-socket-get-keepalive"></a><h3>g_socket_get_keepalive ()</h3>

2372

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

2372

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

2373

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

2374

Gets the keepalive mode of the socket. For details on this,

2375

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>.

2390

</div>

2391

2392

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

2393

<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.

2393

<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.

2394

2395

</div>

2396

Since 2.22

2400

<a name="g-socket-set-keepalive"></a><h3>g_socket_set_keepalive ()</h3>

2401

<pre class="programlisting">void

2402

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

2403

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

2403

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

2404

Sets or unsets the <code class="literal">SO_KEEPALIVE</code> flag on the underlying socket. When

2405

this flag is set on a socket, the system will attempt to verify that the

2406

remote socket endpoint is still present if a sufficiently long period of

2441

<hr>

2442

2443

<a name="g-socket-get-timeout"></a><h3>g_socket_get_timeout ()</h3>

2444

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

2444

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

2445

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

2446

Gets the timeout setting of the socket. For details on this, see

2447

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

2472

<a name="g-socket-set-timeout"></a><h3>g_socket_set_timeout ()</h3>

2473

<pre class="programlisting">void

2474

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

2475

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

2475

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

2476

Sets the time in seconds after which I/O operations on <code>socket</code>

2477

will

2478

time out if they have not yet completed.

2523

<a name="g-socket-set-ttl"></a><h3>g_socket_set_ttl ()</h3>

2524

<pre class="programlisting">void

2525

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

2526

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

2526

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

2527

Sets the time-to-live for outgoing unicast packets on <code>socket</code>

2528

.

2529

By default the platform-specific default value is used.

2555

<hr>

2556

2557

<a name="g-socket-get-ttl"></a><h3>g_socket_get_ttl ()</h3>

2558

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

2558

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

2559

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

2560

Gets the unicast time-to-live setting on <code>socket</code>

2561

; see

2586

<hr>

2587

2588

<a name="g-socket-get-broadcast"></a><h3>g_socket_get_broadcast ()</h3>

2589

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

2589

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

2590

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

2591

Gets the broadcast setting on <code>socket</code>

2592

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

2592

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

2593

it is possible to send packets to broadcast

2594

addresses.

2595

2620

<a name="g-socket-set-broadcast"></a><h3>g_socket_set_broadcast ()</h3>

2621

<pre class="programlisting">void

2622

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

2623

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

2623

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

2624

Sets whether <code>socket</code>

2625

should allow sending to broadcast addresses.

2626

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.

2626

This is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> by default.

2627

2628

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

2629

2653

<hr>

2654

2655

<a name="g-socket-get-option"></a><h3>g_socket_get_option ()</h3>

2656

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

2656

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

2657

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

2658

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

2659

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

2660

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

2661

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

2658

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

2659

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

2660

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

2661

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

2662

Gets the value of an integer-valued option on <code>socket</code>

2663

, as with

2664

<code class="function">getsockopt()</code>. (If you need to fetch a non-integer-valued option,

2670

headers.

2671

Note that even for socket options that are a single byte in size,

2672

<code>value</code>

2673

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>;

2673

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>;

2674

<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.

2675

2676

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

2703

</tr>

2704

<tr>

2705

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

2706

<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>

2706

<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>

2707

2708

</tr>

2709

</tbody>

2722

<hr>

2723

2724

<a name="g-socket-set-option"></a><h3>g_socket_set_option ()</h3>

2725

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

2725

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

2726

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

2727

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

2728

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

2729

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

2730

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

2727

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

2728

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

2729

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

2730

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

2731

Sets the value of an integer-valued option on <code>socket</code>

2732

, as with

2733

<code class="function">setsockopt()</code>. (If you need to set a non-integer-valued option,

2768

</tr>

2769

<tr>

2770

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

2771

<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>

2771

<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>

2772

2773

</tr>

2774

</tbody>

2849

<a name="g-socket-get-local-address"></a><h3>g_socket_get_local_address ()</h3>

2850

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

2851

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

2852

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

2852

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

2853

Try to get the local address of a bound socket. This is only

2854

useful if the socket has been bound to a local address,

2855

either explicitly or implicitly when connecting.

2869

</tr>

2870

<tr>

2871

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

2872

<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>

2872

<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>

2873

2874

</tr>

2875

</tbody>

2877

</div>

2878

2879

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

2880

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.

2881

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>.

2880

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.

2881

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>.

2882

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

2883

</div>

2884

Since 2.22

2917

<a name="g-socket-get-remote-address"></a><h3>g_socket_get_remote_address ()</h3>

2918

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

2919

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

2920

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

2920

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

2921

Try to get the remove address of a connected socket. This is only

2922

useful for connection oriented sockets that have been connected.

2923

2936

</tr>

2937

<tr>

2938

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

2939

<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>

2939

<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>

2940

2941

</tr>

2942

</tbody>

2944

</div>

2945

2946

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

2947

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.

2948

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>.

2947

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.

2948

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>.

2949

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

2950

</div>

2951

Since 2.22

2981

<hr>

2982

2983

<a name="g-socket-speaks-ipv4"></a><h3>g_socket_speaks_ipv4 ()</h3>

2984

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

2984

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

2985

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

2986

Checks if a socket is capable of speaking IPv4.

2987

IPv4 sockets are capable of speaking IPv4. On some operating systems

3007

</div>

3008

3009

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

3010

<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.

3010

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if this socket can be used with IPv4.

3011

3012

</div>

3013

Since 2.22

3017

<a name="g-socket-get-credentials"></a><h3>g_socket_get_credentials ()</h3>

3018

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

3019

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

3020

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

3020

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

3021

Returns the credentials of the foreign process connected to this

3022

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>

3023

sockets).

3044

</tr>

3045

<tr>

3046

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

3047

<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>

3047

<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>

3048

3049

</tr>

3050

</tbody>

3052

</div>

3053

3054

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

3055

<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>

3055

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

3056

is set, otherwise a <a class="link" href="GCredentials.html" title="GCredentials">GCredentials</a> object

3057

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>.

3057

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>.

3058

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

3059

</div>

3060

Since 2.26

3062

<hr>

3063

3064

<a name="g-socket-join-multicast-group"></a><h3>g_socket_join_multicast_group ()</h3>

3065

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

3065

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

3066

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

3067

<code><a class="link" href="GInetAddress.html" title="GInetAddress">GInetAddress</a> *group</code>,

3068

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

3069

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

3070

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

3068

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

3069

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

3070

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

3071

Registers <code>socket</code>

3072

to receive multicast messages sent to <code>group</code>

3073

.

3076

been bound to an appropriate interface and port with

3077

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

3078

If <code>iface</code>

3079

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

3079

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the system will automatically pick an interface

3080

to bind to based on <code>group</code>

3081

.

3082

If <code>source_specific</code>

3083

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

3083

is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, source-specific multicast as defined

3084

in RFC 4604 is used. Note that on older platforms this may fail

3085

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.

3086

3104

</tr>

3105

<tr>

3106

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

3107

<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>

3107

<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>

3108

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

3109

</tr>

3110

<tr>

3111

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

3112

<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>

3112

<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>

3113

3114

</tr>

3115

<tr>

3116

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

3117

<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>

3117

<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>

3118

3119

</tr>

3120

</tbody>

3122

</div>

3123

3124

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

3125

<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.

3125

<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.

3126

3127

</div>

3128

Since 2.32

3130

<hr>

3131

3132

<a name="g-socket-leave-multicast-group"></a><h3>g_socket_leave_multicast_group ()</h3>

3133

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

3133

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

3134

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

3135

<code><a class="link" href="GInetAddress.html" title="GInetAddress">GInetAddress</a> *group</code>,

3136

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

3137

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

3138

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

3136

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

3137

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

3138

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

3139

Removes <code>socket</code>

3140

from the multicast group defined by <code>group</code>

3141

, <code>iface</code>

3172

</tr>

3173

<tr>

3174

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

3175

<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>

3175

<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>

3176

3177

</tr>

3178

<tr>

3179

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

3180

<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>

3180

<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>

3181

3182

</tr>

3183

</tbody>

3185

</div>

3186

3187

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

3188

<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.

3188

<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.

3189

3190

</div>

3191

Since 2.32

3193

<hr>

3194

3195

<a name="g-socket-get-multicast-loopback"></a><h3>g_socket_get_multicast_loopback ()</h3>

3196

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

3196

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

3197

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

3198

Gets the multicast loopback setting on <code>socket</code>

3199

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

3199

; if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (the

3200

default), outgoing multicast packets will be looped back to

3201

multicast listeners on the same host.

3202

3227

<a name="g-socket-set-multicast-loopback"></a><h3>g_socket_set_multicast_loopback ()</h3>

3228

<pre class="programlisting">void

3229

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

3230

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

3230

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

3231

Sets whether outgoing multicast packets will be received by sockets

3232

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>

3232

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>

3233

by default.

3234

3235

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

3260

<hr>

3261

3262

<a name="g-socket-get-multicast-ttl"></a><h3>g_socket_get_multicast_ttl ()</h3>

3263

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

3263

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

3264

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

3265

Gets the multicast time-to-live setting on <code>socket</code>

3266

; see

3293

<a name="g-socket-set-multicast-ttl"></a><h3>g_socket_set_multicast_ttl ()</h3>

3294

<pre class="programlisting">void

3295

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

3296

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

3296

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

3297

Sets the time-to-live for outgoing multicast datagrams on <code>socket</code>

3298

.

3299

By default, this is 1, meaning that multicast packets will not leave

3513

</colgroup>

3514

<tbody>

3515

<tr>

3516

<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>

3516

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="GInputVector.buffer"></a>buffer</code>;</td>

3517

<td class="struct_member_description">Pointer to a buffer where data will be written.</td>

3518

3519

</tr>

3520

<tr>

3521

<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>

3521

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GInputVector.size"></a>size</code>;</td>

3522

<td class="struct_member_description">the available size in <code>buffer</code>

3523

.</td>

3524

3550

</colgroup>

3551

<tbody>

3552

<tr>

3553

<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>

3553

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gconstpointer">gconstpointer</a> <code><a name="GOutputVector.buffer"></a>buffer</code>;</td>

3554

<td class="struct_member_description">Pointer to a buffer of data to read.</td>

3555

3556

</tr>

3557

<tr>

3558

<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>

3558

<td class="struct_member_name"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> <code><a name="GOutputVector.size"></a>size</code>;</td>

3559

<td class="struct_member_description">the size of <code>buffer</code>

3560

.</td>

3561

3570

<a name="GSocket.property-details"></a><h2>Property Details</h2>

3571

3572

<a name="GSocket--blocking"></a><h3>The <code class="literal">“blocking”</code> property</h3>

3573

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

3573

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

3574

Whether or not I/O on this socket is blocking.

3575

Flags: Read / Write

3576

Default value: TRUE

3578

<hr>

3579

3580

<a name="GSocket--broadcast"></a><h3>The <code class="literal">“broadcast”</code> property</h3>

3581

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

3581

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

3582

Whether the socket should allow sending to broadcast addresses.

3583

Flags: Read / Write

3584

Default value: FALSE

3595

<hr>

3596

3597

<a name="GSocket--fd"></a><h3>The <code class="literal">“fd”</code> property</h3>

3598

3598

3599

The sockets file descriptor.

3600

Flags: Read / Write / Construct Only

3601

Default value: -1

3603

<hr>

3604

3605

<a name="GSocket--keepalive"></a><h3>The <code class="literal">“keepalive”</code> property</h3>

3606

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

3606

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

3607

Keep connection alive by sending periodic pings.

3608

Flags: Read / Write

3609

Default value: FALSE

3611

<hr>

3612

3613

<a name="GSocket--listen-backlog"></a><h3>The <code class="literal">“listen-backlog”</code> property</h3>

3614

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

3614

<pre class="programlisting"> “listen-backlog” <a href="../glib/glib-Basic-Types.html#gint">gint</a></pre>

3615

Outstanding connections in the listen queue.

3616

Flags: Read / Write

3617

Allowed values: [0,128]

3627

<hr>

3628

3629

<a name="GSocket--multicast-loopback"></a><h3>The <code class="literal">“multicast-loopback”</code> property</h3>

3630

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

3630

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

3631

Whether outgoing multicast packets loop back to the local host.

3632

Flags: Read / Write

3633

Default value: TRUE

3636

<hr>

3637

3638

<a name="GSocket--multicast-ttl"></a><h3>The <code class="literal">“multicast-ttl”</code> property</h3>

3639

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

3639

<pre class="programlisting"> “multicast-ttl” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3640

Time-to-live out outgoing multicast packets

3641

Flags: Read / Write

3642

Default value: 1

3660

<hr>

3661

3662

<a name="GSocket--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3>

3663

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

3663

<pre class="programlisting"> “timeout” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3664

The timeout in seconds on socket I/O

3665

Flags: Read / Write

3666

Default value: 0

3669

<hr>

3670

3671

<a name="GSocket--ttl"></a><h3>The <code class="literal">“ttl”</code> property</h3>

3672

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

3672

<pre class="programlisting"> “ttl” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

3673

Time-to-live for outgoing unicast packets

3674

Flags: Read / Write

3675

Default value: 0