docs/reference/glib/tmpl/iochannels.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 IO Channels
   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 <!-- ##### STRUCT GIOChannel ##### -->
  23 <para>
  24
  25 </para>
  26
  27
  28 <!-- ##### FUNCTION g_io_channel_unix_new ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @fd:
  34 @Returns:
  35
  36
  37 <!-- ##### FUNCTION g_io_channel_unix_get_fd ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @channel:
  43 @Returns:
  44
  45
  46 <!-- ##### FUNCTION g_io_channel_win32_new_fd ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @fd:
  52 @Returns:
  53
  54
  55 <!-- ##### FUNCTION g_io_channel_win32_new_socket ##### -->
  56 <para>
  57
  58 </para>
  59
  60 @socket:
  61 @Returns:
  62
  63
  64 <!-- ##### FUNCTION g_io_channel_win32_new_messages ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @hwnd:
  70 @Returns:
  71
  72
  73 <!-- ##### FUNCTION g_io_channel_init ##### -->
  74 <para>
  75
  76 </para>
  77
  78 @channel:
  79
  80
  81 <!-- ##### FUNCTION g_io_channel_new_file ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @filename:
  87 @mode:
  88 @error:
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION g_io_channel_read_chars ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @channel:
  98 @buf:
  99 @count:
 100 @bytes_read:
 101 @error:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION g_io_channel_read_unichar ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @channel:
 111 @thechar:
 112 @error:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION g_io_channel_read_line ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @channel:
 122 @str_return:
 123 @length:
 124 @terminator_pos:
 125 @error:
 126 @Returns:
 127
 128
 129 <!-- ##### FUNCTION g_io_channel_read_line_string ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @channel:
 135 @buffer:
 136 @terminator_pos:
 137 @error:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION g_io_channel_read_to_end ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @channel:
 147 @str_return:
 148 @length:
 149 @error:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION g_io_channel_write_chars ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @channel:
 159 @buf:
 160 @count:
 161 @bytes_written:
 162 @error:
 163 @Returns:
 164
 165
 166 <!-- ##### FUNCTION g_io_channel_write_unichar ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @channel:
 172 @thechar:
 173 @error:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION g_io_channel_flush ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @channel:
 183 @error:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION g_io_channel_seek_position ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @channel:
 193 @offset:
 194 @type:
 195 @error:
 196 @Returns:
 197
 198
 199 <!-- ##### ENUM GSeekType ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @G_SEEK_CUR:
 205 @G_SEEK_SET:
 206 @G_SEEK_END:
 207
 208 <!-- ##### FUNCTION g_io_channel_shutdown ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @channel:
 214 @flush:
 215 @err:
 216 @Returns:
 217
 218
 219 <!-- ##### ENUM GIOStatus ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @G_IO_STATUS_ERROR:
 225 @G_IO_STATUS_NORMAL:
 226 @G_IO_STATUS_EOF:
 227 @G_IO_STATUS_AGAIN:
 228
 229 <!-- ##### ENUM GIOChannelError ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @G_IO_CHANNEL_ERROR_FBIG:
 235 @G_IO_CHANNEL_ERROR_INVAL:
 236 @G_IO_CHANNEL_ERROR_IO:
 237 @G_IO_CHANNEL_ERROR_ISDIR:
 238 @G_IO_CHANNEL_ERROR_NOSPC:
 239 @G_IO_CHANNEL_ERROR_NXIO:
 240 @G_IO_CHANNEL_ERROR_OVERFLOW:
 241 @G_IO_CHANNEL_ERROR_PIPE:
 242 @G_IO_CHANNEL_ERROR_FAILED:
 243
 244 <!-- ##### MACRO G_IO_CHANNEL_ERROR ##### -->
 245 <para>
 246
 247 </para>
 248
 249
 250
 251 <!-- ##### FUNCTION g_io_channel_error_from_errno ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @en:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION g_io_channel_ref ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @channel:
 266 @Returns:
 267
 268
 269 <!-- ##### FUNCTION g_io_channel_unref ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @channel:
 275
 276
 277 <!-- ##### FUNCTION g_io_create_watch ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @channel:
 283 @condition:
 284 @Returns:
 285
 286
 287 <!-- ##### FUNCTION g_io_add_watch ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @channel:
 293 @condition:
 294 @func:
 295 @user_data:
 296 @Returns:
 297
 298
 299 <!-- ##### FUNCTION g_io_add_watch_full ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @channel:
 305 @priority:
 306 @condition:
 307 @func:
 308 @user_data:
 309 @notify:
 310 @Returns:
 311
 312
 313 <!-- ##### ENUM GIOCondition ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @G_IO_IN:
 319 @G_IO_OUT:
 320 @G_IO_PRI:
 321 @G_IO_ERR:
 322 @G_IO_HUP:
 323 @G_IO_NVAL:
 324
 325 <!-- ##### USER_FUNCTION GIOFunc ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @source:
 331 @condition:
 332 @data:
 333 @Returns:
 334
 335
 336 <!-- ##### STRUCT GIOFuncs ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @io_read:
 342 @io_write:
 343 @io_seek:
 344 @io_close:
 345 @io_create_watch:
 346 @io_free:
 347 @io_set_flags:
 348 @io_get_flags:
 349
 350 <!-- ##### FUNCTION g_io_channel_get_buffer_size ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @channel:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION g_io_channel_set_buffer_size ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @channel:
 365 @size:
 366
 367
 368 <!-- ##### FUNCTION g_io_channel_get_buffer_condition ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @channel:
 374 @Returns:
 375
 376
 377 <!-- ##### FUNCTION g_io_channel_get_flags ##### -->
 378 <para>
 379
 380 </para>
 381
 382 @channel:
 383 @Returns:
 384
 385
 386 <!-- ##### FUNCTION g_io_channel_set_flags ##### -->
 387 <para>
 388
 389 </para>
 390
 391 @channel:
 392 @flags:
 393 @error:
 394 @Returns:
 395
 396
 397 <!-- ##### ENUM GIOFlags ##### -->
 398 <para>
 399
 400 </para>
 401
 402 @G_IO_FLAG_APPEND:
 403 @G_IO_FLAG_NONBLOCK:
 404 @G_IO_FLAG_IS_READABLE:
 405 @G_IO_FLAG_IS_WRITEABLE:
 406 @G_IO_FLAG_IS_SEEKABLE:
 407 @G_IO_FLAG_MASK:
 408 @G_IO_FLAG_GET_MASK:
 409 @G_IO_FLAG_SET_MASK:
 410
 411 <!-- ##### FUNCTION g_io_channel_get_line_term ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @channel:
 417 @length:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION g_io_channel_set_line_term ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @channel:
 427 @line_term:
 428 @length:
 429
 430
 431 <!-- ##### FUNCTION g_io_channel_get_buffered ##### -->
 432 <para>
 433
 434 </para>
 435
 436 @channel:
 437 @Returns:
 438
 439
 440 <!-- ##### FUNCTION g_io_channel_set_buffered ##### -->
 441 <para>
 442
 443 </para>
 444
 445 @channel:
 446 @buffered:
 447
 448
 449 <!-- ##### FUNCTION g_io_channel_get_encoding ##### -->
 450 <para>
 451
 452 </para>
 453
 454 @channel:
 455 @Returns:
 456
 457
 458 <!-- ##### FUNCTION g_io_channel_set_encoding ##### -->
 459 <para>
 460
 461 </para>
 462
 463 @channel:
 464 @encoding:
 465 @error:
 466 @Returns:
 467
 468
 469 <!-- ##### FUNCTION g_io_channel_get_close_on_unref ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @channel:
 475 @Returns:
 476
 477
 478 <!-- ##### FUNCTION g_io_channel_set_close_on_unref ##### -->
 479 <para>
 480
 481 </para>
 482
 483 @channel:
 484 @do_close:
 485
 486
 487 <!-- ##### FUNCTION g_io_channel_read ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @channel:
 493 @buf:
 494 @count:
 495 @bytes_read:
 496 @Returns:
 497
 498
 499 <!-- ##### ENUM GIOError ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @G_IO_ERROR_NONE:
 505 @G_IO_ERROR_AGAIN:
 506 @G_IO_ERROR_INVAL:
 507 @G_IO_ERROR_UNKNOWN:
 508
 509 <!-- ##### FUNCTION g_io_channel_write ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @channel:
 515 @buf:
 516 @count:
 517 @bytes_written:
 518 @Returns:
 519
 520
 521 <!-- ##### FUNCTION g_io_channel_seek ##### -->
 522 <para>
 523
 524 </para>
 525
 526 @channel:
 527 @offset:
 528 @type:
 529 @Returns:
 530
 531
 532 <!-- ##### FUNCTION g_io_channel_close ##### -->
 533 <para>
 534
 535 </para>
 536
 537 @channel:
 538
 539