Class

SoupMultipartInputStream

Description [src]

final class Soup.MultipartInputStream : Gio.FilterInputStream {
  /* No available fields */
}

Handles streams of multipart messages.

This adds support for the multipart responses. For handling the multiple parts the user needs to wrap the GInputStream obtained by sending the request with a SoupMultipartInputStream and use soup_multipart_input_stream_next_part() before reading. Responses which are not wrapped will be treated like non-multipart responses.

Note that although SoupMultipartInputStream is a GInputStream, you should not read directly from it, and the results are undefined if you do.

Constructors

soup_multipart_input_stream_new

Creates a new SoupMultipartInputStream that wraps the GInputStream obtained by sending the SoupMessage.

Instance methods

soup_multipart_input_stream_get_headers

Obtains the headers for the part currently being processed.

soup_multipart_input_stream_next_part

Obtains an input stream for the next part.

soup_multipart_input_stream_next_part_async

Obtains a GInputStream for the next request.

soup_multipart_input_stream_next_part_finish

Finishes an asynchronous request for the next part.

Methods inherited from GFilterInputStream (3)
g_filter_input_stream_get_base_stream

Gets the base stream for the filter stream.

g_filter_input_stream_get_close_base_stream

Returns whether the base stream will be closed when stream is closed.

g_filter_input_stream_set_close_base_stream

Sets whether the base stream will be closed when stream is closed.

Methods inherited from GInputStream (19)
g_input_stream_clear_pending

Clears the pending flag on stream.

g_input_stream_close

Closes the stream, releasing resources related to it.

g_input_stream_close_async

Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation.

g_input_stream_close_finish

Finishes closing a stream asynchronously, started from g_input_stream_close_async().

g_input_stream_has_pending

Checks if an input stream has pending actions.

g_input_stream_is_closed

Checks if an input stream is closed.

g_input_stream_read

Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.

g_input_stream_read_all

Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.

g_input_stream_read_all_async

Request an asynchronous read of count bytes from the stream into the buffer starting at buffer.

Available since: 2.44

g_input_stream_read_all_finish

Finishes an asynchronous stream read operation started with g_input_stream_read_all_async().

Available since: 2.44

g_input_stream_read_async

Request an asynchronous read of count bytes from the stream into the buffer starting at buffer. When the operation is finished callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation.

g_input_stream_read_bytes

Like g_input_stream_read(), this tries to read count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new GBytes containing the data that was read. This may be easier to use from language bindings.

Available since: 2.34

g_input_stream_read_bytes_async

Request an asynchronous read of count bytes from the stream into a new GBytes. When the operation is finished callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation.

Available since: 2.34

g_input_stream_read_bytes_finish

Finishes an asynchronous stream read-into-GBytes operation.

Available since: 2.34

g_input_stream_read_finish

Finishes an asynchronous stream read operation.

g_input_stream_set_pending

Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set error.

g_input_stream_skip

Tries to skip count bytes from the stream. Will block during the operation.

g_input_stream_skip_async

Request an asynchronous skip of count bytes from the stream. When the operation is finished callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation.

g_input_stream_skip_finish

Finishes a stream skip operation.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GPollableInputStream (4)
g_pollable_input_stream_can_poll

Checks if stream is actually pollable. Some classes may implement GPollableInputStream but have only certain instances of that class be pollable. If this method returns FALSE, then the behavior of other GPollableInputStream methods is undefined.

Available since: 2.28

g_pollable_input_stream_create_source

Creates a GSource that triggers when stream can be read, or cancellable is triggered or an error occurs. The callback on the source is of the GPollableSourceFunc type.

Available since: 2.28

g_pollable_input_stream_is_readable

Checks if stream can be read.

Available since: 2.28

g_pollable_input_stream_read_nonblocking

Attempts to read up to count bytes from stream into buffer, as with g_input_stream_read(). If stream is not currently readable, this will immediately return G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a GSource that will be triggered when stream is readable.

Properties

Properties inherited from GFilterInputStream (2)
Gio.FilterInputStream:base-stream
No description available.
Gio.FilterInputStream:close-base-stream
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct SoupMultipartInputStreamClass {
  GFilterInputStreamClass parent_class;
  
}
Class members
parent_class
GFilterInputStreamClass
  No description available.