Stream

Stream

Object Hierarchy:

Description:

[ CCode ( type_id = "camel_stream_get_type ()" ) ]
public class Stream : Object, Seekable

Abstract base class for I/O streams.

Stream is an abstract base class that implements a simple read/write stream interface. It is used throughout Camel for I/O abstraction, allowing the same message handling code to work with files, sockets, memory buffers, and more.

The stream hierarchy includes:

**StreamBuffer** — provides line-buffering on top of another stream, including a convenient read_line function.
**StreamFilter** — a sophisticated stream that runs data through a chain of MimeFilter instances for efficient pipelined processing.
**StreamFs** — a file-descriptor-backed stream.
**StreamMem** — a memory-backed stream backed by a ByteArray.
**StreamNull** — a null stream that discards all output; useful for measuring encoded output size.
**StreamProcess** — a stream backed by a child process.

Utility functions such as write_string and write_to_stream are provided for common operations.

All known sub-classes:

Namespace: Camel

Package: camel-1.2

Content:

Properties:

public IOStream base_stream { owned get; set; }
The base IOStream

Creation methods:

public Stream (IOStream base_stream)
Creates a Stream as a thin wrapper for base_stream.

Methods:

public virtual int close (Cancellable? cancellable = null) throws Error
Closes the stream.
public virtual bool eos ()
Tests if there are bytes left to read on the this object.
public virtual int flush (Cancellable? cancellable = null) throws Error
Flushes any buffered data to the stream's backing store.
public virtual ssize_t read (char[] buffer, Cancellable? cancellable = null) throws Error
Attempts to read up to buffer.length bytes from this into buffer.
public IOStream? ref_base_stream ()
Returns the IOStream for this.
public void set_base_stream (IOStream base_stream)
Replaces the IOStream passed to Stream with base_stream.
public virtual ssize_t write (char[] buffer, Cancellable? cancellable = null) throws Error
Attempts to write up to buffer.length bytes of buffer into this.
public ssize_t write_string (string string, Cancellable? cancellable = null) throws Error
Writes the string to the stream.
public ssize_t write_to_stream (Stream output_stream, Cancellable? cancellable = null) throws Error
Write all of a stream (until eos) into another stream, in a blocking fashion.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface GLib.Seekable

seek
tell

truncate