Close an IO channel. Any pending data to be written will be flushed, ignoring errors. The channel will not be freed until the last reference is dropped using g_io_channel_unref().
Flushes the write buffer for the GIOChannel.
This function returns a #GIOCondition depending on whether there is data to be read/space to write data in the internal buffers in the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
Gets the buffer size.
Returns whether channel is buffered.
Returns whether the file/socket/whatever associated with channel
will be closed when channel receives its final unref and is
destroyed. The default value of this is %TRUE for channels created
by g_io_channel_new_file (), and %FALSE for all other channels.
Gets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The encoding %NULL makes the channel safe for binary data.
Gets the current flags for a #GIOChannel, including read-only flags such as %G_IO_FLAG_IS_READABLE.
The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE are cached for internal use by the channel when it is created. If they should change at some later point (e.g. partial shutdown of a socket with the UNIX shutdown() function), the user should immediately call g_io_channel_get_flags() to update the internal values of these flags.
This returns the string that #GIOChannel uses to determine where in the file a line break occurs. A value of %NULL indicates autodetection.
a location to return the length of the line terminator
Initializes a #GIOChannel struct.
This is called by each of the above functions when creating a #GIOChannel, and so is not often needed by the application programmer (unless you are creating a new type of #GIOChannel).
Reads data from a #GIOChannel.
a buffer to read the data into (which should be at least count bytes long)
the number of bytes to read from the #GIOChannel
returns the number of bytes actually read
Replacement for g_io_channel_read() with the new API.
Reads a line, including the terminating character(s),
from a #GIOChannel into a newly-allocated string.
str_return will contain allocated memory if the return
is %G_IO_STATUS_NORMAL.
Reads a line from a #GIOChannel, using a #GString as a buffer.
a #GString into which the line will be written. If buffer already contains data, the old data will be overwritten.
location to store position of line terminator, or %NULL
Reads all the remaining data from the file.
Reads a Unicode character from channel.
This function cannot be called on a channel with %NULL encoding.
Increments the reference count of a #GIOChannel.
Sets the current position in the #GIOChannel, similar to the standard library function fseek().
an offset, in bytes, which is added to the position specified by type
the position in the file, which can be %G_SEEK_CUR (the current position), %G_SEEK_SET (the start of the file), or %G_SEEK_END (the end of the file)
Replacement for g_io_channel_seek() with the new API.
The offset in bytes from the position specified by type
a #GSeekType. The type %G_SEEK_CUR is only allowed in those cases where a call to g_io_channel_set_encoding () is allowed. See the documentation for g_io_channel_set_encoding () for details.
Sets the buffer size.
the size of the buffer, or 0 to let GLib pick a good size
The buffering state can only be set if the channel's encoding is %NULL. For any other encoding, the channel must be buffered.
A buffered channel can only be set unbuffered if the channel's internal buffers have been flushed. Newly created channels or channels which have returned %G_IO_STATUS_EOF not require such a flush. For write-only channels, a call to g_io_channel_flush () is sufficient. For all other channels, the buffers may be flushed by a call to g_io_channel_seek_position (). This includes the possibility of seeking with seek type %G_SEEK_CUR and an offset of zero. Note that this means that socket-based channels cannot be set unbuffered once they have had data read from them.
On unbuffered channels, it is safe to mix read and write calls from the new and old APIs, if this is necessary for maintaining old code.
The default state of the channel is buffered.
whether to set the channel buffered or unbuffered
Whether to close the channel on the final unref of the #GIOChannel data structure. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels.
Setting this flag to %TRUE for a channel you have already closed can cause problems when the final reference to the #GIOChannel is dropped.
Whether to close the channel on the final unref of the GIOChannel data structure.
Sets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The default encoding for the external file is UTF-8.
The encoding %NULL is safe to use with binary data.
The encoding can only be set if one of the following conditions is true:
The channel was just created, and has not been written to or read from yet.
The channel is write-only.
The channel is a file, and the file pointer was just repositioned by a call to g_io_channel_seek_position(). (This flushes all the internal buffers.)
The current encoding is %NULL or UTF-8.
One of the (new API) read functions has just returned %G_IO_STATUS_EOF (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
One of the functions g_io_channel_read_chars() or g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or %G_IO_STATUS_ERROR. This may be useful in the case of %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. Returning one of these statuses from g_io_channel_read_line(), g_io_channel_read_line_string(), or g_io_channel_read_to_end() does not guarantee that the encoding can be changed.
Channels which do not meet one of the above conditions cannot call g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if they are "seekable", cannot call g_io_channel_write_chars() after calling one of the API "read" functions.
the encoding type
This sets the string that #GIOChannel uses to determine where in the file a line break occurs.
The line termination string. Use %NULL for autodetect. Autodetection breaks on "\n", "\r\n", "\r", "\0", and the Unicode paragraph separator. Autodetection should not be used for anything other than file-based channels.
The length of the termination string. If -1 is passed, the string is assumed to be nul-terminated. This option allows termination strings with embedded nuls.
Close an IO channel. Any pending data to be written will be
flushed if flush is %TRUE. The channel will not be freed until the
last reference is dropped using g_io_channel_unref().
if %TRUE, flush pending
Returns the file descriptor of the #GIOChannel.
On Windows this function returns the file descriptor or socket of the #GIOChannel.
Decrements the reference count of a #GIOChannel.
Writes data to a #GIOChannel.
the buffer containing the data to write
the number of bytes to write
the number of bytes actually written
Replacement for g_io_channel_write() with the new API.
On seekable channels with encodings other than %NULL or UTF-8, generic mixing of reading and writing is not allowed. A call to g_io_channel_write_chars () may only be made on a channel from which data has been read in the cases described in the documentation for g_io_channel_set_encoding ().
a buffer to write data from
the size of the buffer. If -1, the buffer is taken to be a nul-terminated string.
Writes a Unicode character to channel.
This function cannot be called on a channel with %NULL encoding.
a character
Converts an errno error number to a #GIOChannelError.
an errno error number, e.g. EINVAL
Open a file filename as a #GIOChannel using mode mode. This
channel will be closed when the last reference to it is dropped,
so there is no need to call g_io_channel_close() (though doing
so will not cause problems, as long as no attempt is made to
access the channel after it is closed).
A string containing the name of a file
One of "r", "w", "a", "r+", "w+", "a+". These have the same meaning as in fopen()
Creates a new #GIOChannel given a file descriptor. On UNIX systems this works for plain files, pipes, and sockets.
The returned #GIOChannel has a reference count of 1.
The default encoding for #GIOChannel is UTF-8. If your application is reading output from a command using via pipe, you may need to set the encoding to the encoding of the current locale (see g_get_charset()) with the g_io_channel_set_encoding() function. By default, the fd passed will not be closed when the final reference to the #GIOChannel data structure is dropped.
If you want to read raw binary data without interpretation, then call the g_io_channel_set_encoding() function with %NULL for the encoding argument.
This function is available in GLib on Windows, too, but you should avoid using it on Windows. The domain of file descriptors and sockets overlap. There is no way for GLib to know which one you mean in case the argument you pass to this function happens to be both a valid file descriptor and socket. If that happens a warning is issued, and GLib assumes that it is the file descriptor you mean.
a file descriptor.
A data structure representing an IO Channel. The fields should be considered private and should only be accessed with the following functions.