Top | ![]() |
![]() |
![]() |
![]() |
GObject ╰── CamelStream ├── CamelNNTPStream ├── CamelPOP3Stream ├── CamelStreamBuffer ├── CamelStreamFilter ├── CamelStreamFs ├── CamelStreamMem ├── CamelStreamNull ╰── CamelStreamProcess
CamelStream *
camel_stream_new (GIOStream *base_stream
);
Creates a CamelStream as a thin wrapper for base_stream
.
Since: 3.12
GIOStream *
camel_stream_ref_base_stream (CamelStream *stream
);
Returns the GIOStream for stream
. This is only valid if stream
was
created with camel_stream_new()
. For all other CamelStream subclasses
this function returns NULL
.
The returned GIOStream is referenced for thread-safety and should be
unreferenced with g_object_unref()
when finished with it.
Since: 3.12
void camel_stream_set_base_stream (CamelStream *stream
,GIOStream *base_stream
);
Replaces the GIOStream passed to camel_stream_new()
with base_stream
.
The new base_stream
should wrap the original GIOStream, such as when
adding Transport Layer Security after issuing a STARTTLS command.
Since: 3.12
gssize camel_stream_read (CamelStream *stream
,gchar *buffer
,gsize n
,GCancellable *cancellable
,GError **error
);
Attempts to read up to n
bytes from stream
into buffer
.
stream |
a CamelStream object. |
|
buffer |
output buffer. |
[array length=n][type gchar] |
n |
max number of bytes to read. |
|
cancellable |
optional GCancellable object, or |
|
error |
gssize camel_stream_write (CamelStream *stream
,const gchar *buffer
,gsize n
,GCancellable *cancellable
,GError **error
);
Attempts to write up to n
bytes of buffer
into stream
.
stream |
a CamelStream object |
|
buffer |
buffer to write. |
[array length=n][type gchar] |
n |
number of bytes to write |
|
cancellable |
optional GCancellable object, or |
|
error |
gint camel_stream_flush (CamelStream *stream
,GCancellable *cancellable
,GError **error
);
Flushes any buffered data to the stream's backing store. Only meaningful for writable streams.
gint camel_stream_close (CamelStream *stream
,GCancellable *cancellable
,GError **error
);
Closes the stream.
gboolean
camel_stream_eos (CamelStream *stream
);
Tests if there are bytes left to read on the stream
object.
gssize camel_stream_write_string (CamelStream *stream
,const gchar *string
,GCancellable *cancellable
,GError **error
);
Writes the string to the stream.
stream |
a CamelStream object |
|
string |
a string |
|
cancellable |
optional GCancellable object, or |
|
error |
gssize camel_stream_write_to_stream (CamelStream *stream
,CamelStream *output_stream
,GCancellable *cancellable
,GError **error
);
Write all of a stream (until eos) into another stream, in a blocking fashion.
stream |
source CamelStream object |
|
output_stream |
destination CamelStream object |
|
cancellable |
optional GCancellable object, or |
|
error |
“base-stream”
property“base-stream” GIOStream *
The base GIOStream.
Owner: CamelStream
Flags: Read / Write