IOChannel

Object Hierarchy:

Description:

public static int main (string[] args) {
	MainLoop loop = new MainLoop (null, false);
	IOChannel channel = null;

	try {
		channel = new IOChannel.file ("my-io-channel-test-file.txt", "r");
	} catch (FileError e) {
		print ("FileError: %s\n", e.message);
		return 0;
	}

	uint stat = channel.add_watch (IOCondition.IN, (source, condition) => {
		size_t terminator_pos = -1;
		string str_return = null;
		size_t length = -1;

		if (condition == IOCondition.HUP) {
			print ("The connection has been broken.\n");
			return false;
		}

		try {
			IOStatus status = channel.read_line (out str_return, out length, out terminator_pos);
			if (status == IOStatus.EOF) {
				// Quit the program:
				loop.quit ();
				return false;
			}

			print ("watch: %s", str_return);
			return true;
		} catch (IOChannelError e) {
			print ("IOChannelError: %s\n", e.message);
			return false;
		} catch (ConvertError e) {
			print ("ConvertError: %s\n", e.message);
			return false;
		}
	});

	if(stat == 0) {
		print ("Cannot add watch on IOChannel.\n");
		return 0;
	}

	loop.run ();
	return 0;
}

valac --pkg glib-2.0 GLib.IOChannel.vala

Content:

Static methods:

• public static int win32_poll (PollFD[] fds, int timeout)

Creation methods:

• public IOChannel.file (string filename, string mode) throws FileError
  Open a file filename as a IOChannel using mode mode.
• public IOChannel.unix_new (int fd)
  Creates a new IOChannel given a file descriptor.
• public IOChannel.win32_messages (size_t hwnd)
• public IOChannel.win32_new_fd (int fd)
• public IOChannel.win32_socket (int socket)

Methods:

• public uint add_watch (IOCondition condition, IOFunc func)
  Adds the IOChannel into the default main loop context with the default priority.
• public uint add_watch_full (int priority, IOCondition condition, owned IOFunc func)
  Adds the IOChannel into the default main loop context with the given priority.
• public IOSource create_watch (IOCondition condition)
• public IOStatus flush () throws IOChannelError
  Flushes the write buffer for the GIOChannel.
• public IOCondition get_buffer_condition ()
  This function returns a IOCondition depending on whether there is data to be read/space to write data in the internal buffers in the IOChannel.
• public size_t get_buffer_size ()
  Gets the buffer size.
• public bool get_buffered ()
  Returns whether this is buffered.
• public bool get_close_on_unref ()
  Returns whether the file/socket/whatever associated with this will be closed when this receives its final unref and is destroyed.
• public unowned string get_encoding ()
  Gets the encoding for the input/output of the channel.
• public IOFlags get_flags ()
  Gets the current flags for a IOChannel, including read-only flags such as g_io_flag_is_readable.
• public unowned string get_line_term (out int length)
  This returns the string that IOChannel uses to determine where in the file a line break occurs.
• public void init ()
  Initializes a IOChannel struct.
• public IOStatus read_chars (char[] buf, out size_t bytes_read) throws ConvertError, IOChannelError
  Replacement for g_io_channel_read with the new API.
• public IOStatus read_line (out string str_return, out size_t length, out size_t terminator_pos) throws ConvertError, IOChannelError
  Reads a line, including the terminating character(s), from a IOChannel into a newly-allocated string.
• public IOStatus read_line_string (StringBuilder buffer, out size_t terminator_pos) throws ConvertError, IOChannelError
  Reads a line from a IOChannel, using a StringBuilder as a buffer.
• public IOStatus read_to_end (out string str_return, out size_t length) throws ConvertError, IOChannelError
  Reads all the remaining data from the file.
• public IOStatus read_unichar (out unichar thechar) throws ConvertError, IOChannelError
  Reads a Unicode character from this.
• public IOStatus seek_position (int64 offset, SeekType type) throws IOChannelError
  Replacement for g_io_channel_seek with the new API.
• public void set_buffer_size (size_t size)
  Sets the buffer size.
• public void set_buffered (bool buffered)
  The buffering state can only be set if the channel's encoding is null.
• public void set_close_on_unref (bool do_close)
  Whether to close the channel on the final unref of the IOChannel data structure.
• public IOStatus set_encoding (string? encoding) throws IOChannelError
  Sets the encoding for the input/output of the channel.
• public IOStatus set_flags (IOFlags flags) throws IOChannelError
  Sets the (writeable) flags in this to ( flags & g_io_flag_set_mask).
• public void set_line_term (string line_term, int length)
  This sets the string that IOChannel uses to determine where in the file a line break occurs.
• public IOStatus shutdown (bool flush) throws IOChannelError
  Close an IO channel.
• public int unix_get_fd ()
  Returns the file descriptor of the IOChannel.
• public int win32_get_fd ()
• public void win32_make_pollfd (IOCondition condition, ref PollFD fd)
• public void win32_set_debug (bool flag)
• public IOStatus write_chars (char[] buf, out size_t bytes_written) throws ConvertError, IOChannelError
  Replacement for g_io_channel_write with the new API.
• public IOStatus write_unichar (unichar thechar) throws ConvertError, IOChannelError
  Writes a Unicode character to this.