Xfce Foundation Classes

iochannel.hh File Reference

A GIOChannel C++ interface. More...

#include <xfc/trackable.hh>
#include <xfc/utfstring.hh>
#include <glib/giochannel.h>
#include <xfc/glib/inline/iochannel.inl>

Namespaces

namespace Xfc
namespace Xfc::G

Classes

class Xfc::G::IOChannel
A GIOChannel C++ wrapper class. More...

Typedefs

typedef unsigned int IOConditionField
IOConditionField holds one or more conditions from the G::IOCondition enumeration OR'd together.
typedef unsigned int IOFlagsField
IOFlags holds one or more flags form the G::IOFlags enumeration OR'd together.

Enumerations

enum IOChannelError {
  IO_CHANNEL_ERROR_FBIG = G_IO_CHANNEL_ERROR_FBIG,
  IO_CHANNEL_ERROR_INVAL = G_IO_CHANNEL_ERROR_INVAL,
  IO_CHANNEL_ERROR_IO = G_IO_CHANNEL_ERROR_IO,
  IO_CHANNEL_ERROR_ISDIR = G_IO_CHANNEL_ERROR_ISDIR,
  IO_CHANNEL_ERROR_NOSPC = G_IO_CHANNEL_ERROR_NOSPC,
  IO_CHANNEL_ERROR_NXIO = G_IO_CHANNEL_ERROR_NXIO,
  IO_CHANNEL_ERROR_OVERFLOW = G_IO_CHANNEL_ERROR_OVERFLOW,
  IO_CHANNEL_ERROR_PIPE = G_IO_CHANNEL_ERROR_PIPE,
  IO_CHANNEL_ERROR_FAILED = G_IO_CHANNEL_ERROR_FAILED
}
enum IOChannelError The error codes returned by IOChannel operations. More...
enum IOStatus {
  IO_STATUS_ERROR = G_IO_STATUS_ERROR,
  IO_STATUS_NORMAL = G_IO_STATUS_NORMAL,
  IO_STATUS_EOF = G_IO_STATUS_EOF,
  IO_STATUS_AGAIN = G_IO_STATUS_AGAIN
}
enum IOStatus Describes the status of an IO operation. More...
enum SeekType {
  IO_SEEK_CUR = G_SEEK_CUR,
  IO_SEEK_SET = G_SEEK_SET,
  IO_SEEK_END = G_SEEK_END
}
Specifies the base position for a IOChannel::seek() operation. More...
enum IOCondition {
  IO_IN = G_IO_IN,
  IO_OUT = G_IO_OUT,
  IO_PRI = G_IO_PRI,
  IO_ERR = G_IO_ERR,
  IO_HUP = G_IO_HUP,
  IO_NVAL = G_IO_NVAL
}
enum IOCondition A bitwise combination representing a condition to watch for on an event source. More...
enum IOFlags {
  IO_FLAG_APPEND = G_IO_FLAG_APPEND,
  IO_FLAG_NONBLOCK = G_IO_FLAG_NONBLOCK ,
  IO_FLAG_IS_WRITEABLE = G_IO_FLAG_IS_WRITEABLE,
  IO_FLAG_IS_SEEKABLE = G_IO_FLAG_IS_SEEKABLE,
  IO_FLAG_MASK = G_IO_FLAG_MASK,
  IO_FLAG_GET_MASK = G_IO_FLAG_GET_MASK,
  IO_FLAG_SET_MASK = G_IO_FLAG_SET_MASK
}
enum IOFlags Specifies the properties of an IOChannel. More...

Detailed Description

A GIOChannel C++ interface.

Provides IO Channels for portable support for using files, pipes and sockets.

Enumeration Type Documentation

enum IOChannelError

enum IOChannelError The error codes returned by IOChannel operations.

Enumeration values:

IO_CHANNEL_ERROR_FBIG File too large.

IO_CHANNEL_ERROR_INVAL Invalid argument.

IO_CHANNEL_ERROR_IO IO error.

IO_CHANNEL_ERROR_ISDIR File is a directory.

IO_CHANNEL_ERROR_NOSPC No space left on device.

IO_CHANNEL_ERROR_NXIO No such device or address.

IO_CHANNEL_ERROR_OVERFLOW Value too large for defined datatype.

IO_CHANNEL_ERROR_PIPE Broken pipe.

IO_CHANNEL_ERROR_FAILED Some other error.

enum IOCondition

enum IOCondition A bitwise combination representing a condition to watch for on an event source.

Enumeration values:

IO_IN There is data to read.

IO_OUT Data can be written (without blocking).

IO_PRI There is urgent data to read.

IO_ERR Error condition.

IO_HUP Hung up (the connection has been broken, usually for pipes and sockets).

IO_NVAL Invalid request. The file descriptor is not open.

enum IOFlags

enum IOFlags Specifies the properties of an IOChannel.
Some of the flags can only be read with G::IOChannel::get_flags(), but not changed with G::IOChannel::set_flags().
Enumeration values:

IO_FLAG_APPEND Turns on append mode, corresponds to O_APPEND (see the documentation of the UNIX open() syscall).

IO_FLAG_NONBLOCK Turns on nonblocking mode, corresponds to O_NONBLOCK/O_NDELAY (see the documentation of the UNIX open() syscall).

IO_FLAG_IS_WRITEABLE Read only flag; Indicates that the io channel is readable.

IO_FLAG_IS_SEEKABLE Read only flag; Indicates that the io channel is writable..

IO_FLAG_MASK Mask flag (I dont know what this means).

IO_FLAG_GET_MASK Same as mask flag.

IO_FLAG_SET_MASK Turns on append mode and nonblocking mode.

enum IOStatus

enum IOStatus Describes the status of an IO operation.

Enumeration values:

IO_STATUS_ERROR An error occurred.

IO_STATUS_NORMAL Success.

IO_STATUS_EOF End of file.

IO_STATUS_AGAIN Resource temporarily unavailable.

enum SeekType

Specifies the base position for a IOChannel::seek() operation.

Enumeration values:

IO_SEEK_CUR The current position in the file.

IO_SEEK_SET The start of the file.

IO_SEEK_END The end of the file.

Xfce Foundation Classes

XFC 4.3