GMimeStreamFilter

GMimeStreamFilter — A filtering stream

Synopsis




                    GMimeStreamFilter;
GMimeStream*        g_mime_stream_filter_new_with_stream
                                                        (GMimeStream *stream);
int                 g_mime_stream_filter_add            (GMimeStreamFilter *fstream,
                                                         GMimeFilter *filter);
void                g_mime_stream_filter_remove         (GMimeStreamFilter *fstream,
                                                         int id);


Object Hierarchy


  GObject
   +----GMimeStream
         +----GMimeStreamFilter

Description

A GMimeStream meant for filtering data passing through it.

This stream class is useful for converting data of one type to another using GMimeFilter objects.

When data passes through a GMimeStreamFilter, it will pass through GMimeFilter filters in the order they were added.

Details

GMimeStreamFilter

typedef struct _GMimeStreamFilter GMimeStreamFilter;


g_mime_stream_filter_new_with_stream ()

GMimeStream*        g_mime_stream_filter_new_with_stream
                                                        (GMimeStream *stream);

Creates a new GMimeStreamFilter object using stream as the source stream.

stream :

source stream

Returns :

a new filter stream with stream as its source.

g_mime_stream_filter_add ()

int                 g_mime_stream_filter_add            (GMimeStreamFilter *fstream,
                                                         GMimeFilter *filter);

Adds a filter to fstream.

fstream :

filter stream

filter :

filter

Returns :

an id for the filter.

g_mime_stream_filter_remove ()

void                g_mime_stream_filter_remove         (GMimeStreamFilter *fstream,
                                                         int id);

Removed a filter from the stream based on the id (as returned from filter_add).

fstream :

filter stream

id :

filter id

See Also

Filters