← Back to branch summary

~ubuntu-branches/ubuntu/saucy/glib2.0/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/tmpl/gsocket.sgml

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2013-09-18 11:49:30 UTC
  • mfrom: (1.63.26) (172.1.16 experimental)
  • Revision ID: package-import@ubuntu.com-20130918114930-25x6p3ytts9nnlvd
Tags: 2.37.93-1ubuntu1
* Rebase on Debian experimental, remaining changes:
  + Build-Depend on python:any for cross-building.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/tmpl/gsocket.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
GSocket
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
 
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
 
10
 
</para>
11
 
 
12
 
 
13
 
<!-- ##### SECTION See_Also ##### -->
14
 
<para>
15
 
 
16
 
</para>
17
 
 
18
 
 
19
 
<!-- ##### SECTION Stability_Level ##### -->
20
 
 
21
 
 
22
 
<!-- ##### SECTION Image ##### -->
23
 
 
24
 
 
25
 
<!-- ##### STRUCT GSocket ##### -->
26
 
<para>
27
 
 
28
 
</para>
29
 
 
30
 
 
31
 
<!-- ##### ARG GSocket:blocking ##### -->
32
 
<para>
33
 
 
34
 
</para>
35
 
 
36
 
<!-- ##### ARG GSocket:broadcast ##### -->
37
 
<para>
38
 
 
39
 
</para>
40
 
 
41
 
<!-- ##### ARG GSocket:family ##### -->
42
 
<para>
43
 
 
44
 
</para>
45
 
 
46
 
<!-- ##### ARG GSocket:fd ##### -->
47
 
<para>
48
 
 
49
 
</para>
50
 
 
51
 
<!-- ##### ARG GSocket:keepalive ##### -->
52
 
<para>
53
 
 
54
 
</para>
55
 
 
56
 
<!-- ##### ARG GSocket:listen-backlog ##### -->
57
 
<para>
58
 
 
59
 
</para>
60
 
 
61
 
<!-- ##### ARG GSocket:local-address ##### -->
62
 
<para>
63
 
 
64
 
</para>
65
 
 
66
 
<!-- ##### ARG GSocket:multicast-loopback ##### -->
67
 
<para>
68
 
 
69
 
</para>
70
 
 
71
 
<!-- ##### ARG GSocket:multicast-ttl ##### -->
72
 
<para>
73
 
 
74
 
</para>
75
 
 
76
 
<!-- ##### ARG GSocket:protocol ##### -->
77
 
<para>
78
 
 
79
 
</para>
80
 
 
81
 
<!-- ##### ARG GSocket:remote-address ##### -->
82
 
<para>
83
 
 
84
 
</para>
85
 
 
86
 
<!-- ##### ARG GSocket:timeout ##### -->
87
 
<para>
88
 
 
89
 
</para>
90
 
 
91
 
<!-- ##### ARG GSocket:ttl ##### -->
92
 
<para>
93
 
 
94
 
</para>
95
 
 
96
 
<!-- ##### ARG GSocket:type ##### -->
97
 
<para>
98
 
 
99
 
</para>
100
 
 
101
 
<!-- ##### USER_FUNCTION GSocketSourceFunc ##### -->
102
 
<para>
103
 
 
104
 
</para>
105
 
 
106
 
@socket: 
107
 
@condition: 
108
 
@user_data: 
109
 
@Returns: 
110
 
 
111
 
 
112
 
<!-- ##### ENUM GSocketType ##### -->
113
 
<para>
114
 
 
115
 
</para>
116
 
 
117
 
@G_SOCKET_TYPE_INVALID: 
118
 
@G_SOCKET_TYPE_STREAM: 
119
 
@G_SOCKET_TYPE_DATAGRAM: 
120
 
@G_SOCKET_TYPE_SEQPACKET: 
121
 
 
122
 
<!-- ##### ENUM GSocketProtocol ##### -->
123
 
<para>
124
 
 
125
 
</para>
126
 
 
127
 
@G_SOCKET_PROTOCOL_UNKNOWN: 
128
 
@G_SOCKET_PROTOCOL_DEFAULT: 
129
 
@G_SOCKET_PROTOCOL_TCP: 
130
 
@G_SOCKET_PROTOCOL_UDP: 
131
 
@G_SOCKET_PROTOCOL_SCTP: 
132
 
 
133
 
<!-- ##### ENUM GSocketMsgFlags ##### -->
134
 
<para>
135
 
 
136
 
</para>
137
 
 
138
 
@G_SOCKET_MSG_NONE: 
139
 
@G_SOCKET_MSG_OOB: 
140
 
@G_SOCKET_MSG_PEEK: 
141
 
@G_SOCKET_MSG_DONTROUTE: 
142
 
 
143
 
<!-- ##### STRUCT GInputVector ##### -->
144
 
<para>
145
 
 
146
 
</para>
147
 
 
148
 
@buffer: 
149
 
@size: 
150
 
 
151
 
<!-- ##### STRUCT GOutputVector ##### -->
152
 
<para>
153
 
 
154
 
</para>
155
 
 
156
 
@buffer: 
157
 
@size: 
158
 
 
159
 
<!-- ##### FUNCTION g_socket_new ##### -->
160
 
<para>
161
 
 
162
 
</para>
163
 
 
164
 
@family: 
165
 
@type: 
166
 
@protocol: 
167
 
@error: 
168
 
@Returns: 
169
 
 
170
 
 
171
 
<!-- ##### FUNCTION g_socket_new_from_fd ##### -->
172
 
<para>
173
 
 
174
 
</para>
175
 
 
176
 
@fd: 
177
 
@error: 
178
 
@Returns: 
179
 
 
180
 
 
181
 
<!-- ##### FUNCTION g_socket_bind ##### -->
182
 
<para>
183
 
 
184
 
</para>
185
 
 
186
 
@socket: 
187
 
@address: 
188
 
@allow_reuse: 
189
 
@error: 
190
 
@Returns: 
191
 
 
192
 
 
193
 
<!-- ##### FUNCTION g_socket_listen ##### -->
194
 
<para>
195
 
 
196
 
</para>
197
 
 
198
 
@socket: 
199
 
@error: 
200
 
@Returns: 
201
 
 
202
 
 
203
 
<!-- ##### FUNCTION g_socket_accept ##### -->
204
 
<para>
205
 
 
206
 
</para>
207
 
 
208
 
@socket: 
209
 
@cancellable: 
210
 
@error: 
211
 
@Returns: 
212
 
 
213
 
 
214
 
<!-- ##### FUNCTION g_socket_connect ##### -->
215
 
<para>
216
 
 
217
 
</para>
218
 
 
219
 
@socket: 
220
 
@address: 
221
 
@cancellable: 
222
 
@error: 
223
 
@Returns: 
224
 
 
225
 
 
226
 
<!-- ##### FUNCTION g_socket_check_connect_result ##### -->
227
 
<para>
228
 
 
229
 
</para>
230
 
 
231
 
@socket: 
232
 
@error: 
233
 
@Returns: 
234
 
 
235
 
 
236
 
<!-- ##### FUNCTION g_socket_receive ##### -->
237
 
<para>
238
 
 
239
 
</para>
240
 
 
241
 
@socket: 
242
 
@buffer: 
243
 
@size: 
244
 
@cancellable: 
245
 
@error: 
246
 
@Returns: 
247
 
 
248
 
 
249
 
<!-- ##### FUNCTION g_socket_receive_from ##### -->
250
 
<para>
251
 
 
252
 
</para>
253
 
 
254
 
@socket: 
255
 
@address: 
256
 
@buffer: 
257
 
@size: 
258
 
@cancellable: 
259
 
@error: 
260
 
@Returns: 
261
 
 
262
 
 
263
 
<!-- ##### FUNCTION g_socket_receive_message ##### -->
264
 
<para>
265
 
 
266
 
</para>
267
 
 
268
 
@socket: 
269
 
@address: 
270
 
@vectors: 
271
 
@num_vectors: 
272
 
@messages: 
273
 
@num_messages: 
274
 
@flags: 
275
 
@cancellable: 
276
 
@error: 
277
 
@Returns: 
278
 
 
279
 
 
280
 
<!-- ##### FUNCTION g_socket_receive_with_blocking ##### -->
281
 
<para>
282
 
 
283
 
</para>
284
 
 
285
 
@socket: 
286
 
@buffer: 
287
 
@size: 
288
 
@blocking: 
289
 
@cancellable: 
290
 
@error: 
291
 
@Returns: 
292
 
 
293
 
 
294
 
<!-- ##### FUNCTION g_socket_send ##### -->
295
 
<para>
296
 
 
297
 
</para>
298
 
 
299
 
@socket: 
300
 
@buffer: 
301
 
@size: 
302
 
@cancellable: 
303
 
@error: 
304
 
@Returns: 
305
 
 
306
 
 
307
 
<!-- ##### FUNCTION g_socket_send_to ##### -->
308
 
<para>
309
 
 
310
 
</para>
311
 
 
312
 
@socket: 
313
 
@address: 
314
 
@buffer: 
315
 
@size: 
316
 
@cancellable: 
317
 
@error: 
318
 
@Returns: 
319
 
 
320
 
 
321
 
<!-- ##### FUNCTION g_socket_send_message ##### -->
322
 
<para>
323
 
 
324
 
</para>
325
 
 
326
 
@socket: 
327
 
@address: 
328
 
@vectors: 
329
 
@num_vectors: 
330
 
@messages: 
331
 
@num_messages: 
332
 
@flags: 
333
 
@cancellable: 
334
 
@error: 
335
 
@Returns: 
336
 
 
337
 
 
338
 
<!-- ##### FUNCTION g_socket_send_with_blocking ##### -->
339
 
<para>
340
 
 
341
 
</para>
342
 
 
343
 
@socket: 
344
 
@buffer: 
345
 
@size: 
346
 
@blocking: 
347
 
@cancellable: 
348
 
@error: 
349
 
@Returns: 
350
 
 
351
 
 
352
 
<!-- ##### FUNCTION g_socket_close ##### -->
353
 
<para>
354
 
 
355
 
</para>
356
 
 
357
 
@socket: 
358
 
@error: 
359
 
@Returns: 
360
 
 
361
 
 
362
 
<!-- ##### FUNCTION g_socket_is_closed ##### -->
363
 
<para>
364
 
 
365
 
</para>
366
 
 
367
 
@socket: 
368
 
@Returns: 
369
 
 
370
 
 
371
 
<!-- ##### FUNCTION g_socket_shutdown ##### -->
372
 
<para>
373
 
 
374
 
</para>
375
 
 
376
 
@socket: 
377
 
@shutdown_read: 
378
 
@shutdown_write: 
379
 
@error: 
380
 
@Returns: 
381
 
 
382
 
 
383
 
<!-- ##### FUNCTION g_socket_is_connected ##### -->
384
 
<para>
385
 
 
386
 
</para>
387
 
 
388
 
@socket: 
389
 
@Returns: 
390
 
 
391
 
 
392
 
<!-- ##### FUNCTION g_socket_create_source ##### -->
393
 
<para>
394
 
 
395
 
</para>
396
 
 
397
 
@socket: 
398
 
@condition: 
399
 
@cancellable: 
400
 
@Returns: 
401
 
 
402
 
 
403
 
<!-- ##### FUNCTION g_socket_condition_check ##### -->
404
 
<para>
405
 
 
406
 
</para>
407
 
 
408
 
@socket: 
409
 
@condition: 
410
 
@Returns: 
411
 
 
412
 
 
413
 
<!-- ##### FUNCTION g_socket_condition_wait ##### -->
414
 
<para>
415
 
 
416
 
</para>
417
 
 
418
 
@socket: 
419
 
@condition: 
420
 
@cancellable: 
421
 
@error: 
422
 
@Returns: 
423
 
 
424
 
 
425
 
<!-- ##### FUNCTION g_socket_condition_timed_wait ##### -->
426
 
<para>
427
 
 
428
 
</para>
429
 
 
430
 
@socket: 
431
 
@condition: 
432
 
@timeout: 
433
 
@cancellable: 
434
 
@error: 
435
 
@Returns: 
436
 
 
437
 
 
438
 
<!-- ##### FUNCTION g_socket_get_available_bytes ##### -->
439
 
<para>
440
 
 
441
 
</para>
442
 
 
443
 
@socket: 
444
 
@Returns: 
445
 
 
446
 
 
447
 
<!-- ##### FUNCTION g_socket_set_listen_backlog ##### -->
448
 
<para>
449
 
 
450
 
</para>
451
 
 
452
 
@socket: 
453
 
@backlog: 
454
 
 
455
 
 
456
 
<!-- ##### FUNCTION g_socket_get_listen_backlog ##### -->
457
 
<para>
458
 
 
459
 
</para>
460
 
 
461
 
@socket: 
462
 
@Returns: 
463
 
 
464
 
 
465
 
<!-- ##### FUNCTION g_socket_get_blocking ##### -->
466
 
<para>
467
 
 
468
 
</para>
469
 
 
470
 
@socket: 
471
 
@Returns: 
472
 
 
473
 
 
474
 
<!-- ##### FUNCTION g_socket_set_blocking ##### -->
475
 
<para>
476
 
 
477
 
</para>
478
 
 
479
 
@socket: 
480
 
@blocking: 
481
 
 
482
 
 
483
 
<!-- ##### FUNCTION g_socket_get_keepalive ##### -->
484
 
<para>
485
 
 
486
 
</para>
487
 
 
488
 
@socket: 
489
 
@Returns: 
490
 
 
491
 
 
492
 
<!-- ##### FUNCTION g_socket_set_keepalive ##### -->
493
 
<para>
494
 
 
495
 
</para>
496
 
 
497
 
@socket: 
498
 
@keepalive: 
499
 
 
500
 
 
501
 
<!-- ##### FUNCTION g_socket_get_timeout ##### -->
502
 
<para>
503
 
 
504
 
</para>
505
 
 
506
 
@socket: 
507
 
@Returns: 
508
 
 
509
 
 
510
 
<!-- ##### FUNCTION g_socket_set_timeout ##### -->
511
 
<para>
512
 
 
513
 
</para>
514
 
 
515
 
@socket: 
516
 
@timeout: 
517
 
 
518
 
 
519
 
<!-- ##### FUNCTION g_socket_set_ttl ##### -->
520
 
<para>
521
 
 
522
 
</para>
523
 
 
524
 
@socket: 
525
 
@ttl: 
526
 
 
527
 
 
528
 
<!-- ##### FUNCTION g_socket_get_ttl ##### -->
529
 
<para>
530
 
 
531
 
</para>
532
 
 
533
 
@socket: 
534
 
@Returns: 
535
 
 
536
 
 
537
 
<!-- ##### FUNCTION g_socket_get_broadcast ##### -->
538
 
<para>
539
 
 
540
 
</para>
541
 
 
542
 
@socket: 
543
 
@Returns: 
544
 
 
545
 
 
546
 
<!-- ##### FUNCTION g_socket_set_broadcast ##### -->
547
 
<para>
548
 
 
549
 
</para>
550
 
 
551
 
@socket: 
552
 
@broadcast: 
553
 
 
554
 
 
555
 
<!-- ##### FUNCTION g_socket_get_option ##### -->
556
 
<para>
557
 
 
558
 
</para>
559
 
 
560
 
@socket: 
561
 
@level: 
562
 
@optname: 
563
 
@value: 
564
 
@error: 
565
 
@Returns: 
566
 
 
567
 
 
568
 
<!-- ##### FUNCTION g_socket_set_option ##### -->
569
 
<para>
570
 
 
571
 
</para>
572
 
 
573
 
@socket: 
574
 
@level: 
575
 
@optname: 
576
 
@value: 
577
 
@error: 
578
 
@Returns: 
579
 
 
580
 
 
581
 
<!-- ##### FUNCTION g_socket_get_family ##### -->
582
 
<para>
583
 
 
584
 
</para>
585
 
 
586
 
@socket: 
587
 
@Returns: 
588
 
 
589
 
 
590
 
<!-- ##### FUNCTION g_socket_get_fd ##### -->
591
 
<para>
592
 
 
593
 
</para>
594
 
 
595
 
@socket: 
596
 
@Returns: 
597
 
 
598
 
 
599
 
<!-- ##### FUNCTION g_socket_get_local_address ##### -->
600
 
<para>
601
 
 
602
 
</para>
603
 
 
604
 
@socket: 
605
 
@error: 
606
 
@Returns: 
607
 
 
608
 
 
609
 
<!-- ##### FUNCTION g_socket_get_protocol ##### -->
610
 
<para>
611
 
 
612
 
</para>
613
 
 
614
 
@socket: 
615
 
@Returns: 
616
 
 
617
 
 
618
 
<!-- ##### FUNCTION g_socket_get_remote_address ##### -->
619
 
<para>
620
 
 
621
 
</para>
622
 
 
623
 
@socket: 
624
 
@error: 
625
 
@Returns: 
626
 
 
627
 
 
628
 
<!-- ##### FUNCTION g_socket_get_socket_type ##### -->
629
 
<para>
630
 
 
631
 
</para>
632
 
 
633
 
@socket: 
634
 
@Returns: 
635
 
 
636
 
 
637
 
<!-- ##### FUNCTION g_socket_speaks_ipv4 ##### -->
638
 
<para>
639
 
 
640
 
</para>
641
 
 
642
 
@socket: 
643
 
@Returns: 
644
 
 
645
 
 
646
 
<!-- ##### FUNCTION g_socket_get_credentials ##### -->
647
 
<para>
648
 
 
649
 
</para>
650
 
 
651
 
@socket: 
652
 
@error: 
653
 
@Returns: 
654
 
 
655
 
 
656
 
<!-- ##### FUNCTION g_socket_join_multicast_group ##### -->
657
 
<para>
658
 
 
659
 
</para>
660
 
 
661
 
@socket: 
662
 
@group: 
663
 
@source_specific: 
664
 
@iface: 
665
 
@error: 
666
 
@Returns: 
667
 
 
668
 
 
669
 
<!-- ##### FUNCTION g_socket_leave_multicast_group ##### -->
670
 
<para>
671
 
 
672
 
</para>
673
 
 
674
 
@socket: 
675
 
@group: 
676
 
@source_specific: 
677
 
@iface: 
678
 
@error: 
679
 
@Returns: 
680
 
 
681
 
 
682
 
<!-- ##### FUNCTION g_socket_get_multicast_loopback ##### -->
683
 
<para>
684
 
 
685
 
</para>
686
 
 
687
 
@socket: 
688
 
@Returns: 
689
 
 
690
 
 
691
 
<!-- ##### FUNCTION g_socket_set_multicast_loopback ##### -->
692
 
<para>
693
 
 
694
 
</para>
695
 
 
696
 
@socket: 
697
 
@loopback: 
698
 
 
699
 
 
700
 
<!-- ##### FUNCTION g_socket_get_multicast_ttl ##### -->
701
 
<para>
702
 
 
703
 
</para>
704
 
 
705
 
@socket: 
706
 
@Returns: 
707
 
 
708
 
 
709
 
<!-- ##### FUNCTION g_socket_set_multicast_ttl ##### -->
710
 
<para>
711
 
 
712
 
</para>
713
 
 
714
 
@socket: 
715
 
@ttl: 
716
 
 
717