From c64602b39797e4d1ffdc23766b2caaf5a0be000b Mon Sep 17 00:00:00 2001 From: Matthew Barnes Date: Tue, 23 Apr 2013 15:06:01 -0400 Subject: Add EDataCapture. EDataCapture is a GConverter that captures data until the end of the input data is seen, then emits a "finished" signal with the captured data in a GBytes instance. When used with GConverterInputStream or GConverterOutputStream, an EDataCapture can discreetly capture stream content for the purpose of caching. --- e-util/e-data-capture.h | 79 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 e-util/e-data-capture.h (limited to 'e-util/e-data-capture.h') diff --git a/e-util/e-data-capture.h b/e-util/e-data-capture.h new file mode 100644 index 0000000000..8949e67fcf --- /dev/null +++ b/e-util/e-data-capture.h @@ -0,0 +1,79 @@ +/* + * e-data-capture.h + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with the program; if not, see + * + */ + +#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION) +#error "Only should be included directly." +#endif + +#ifndef E_DATA_CAPTURE_H +#define E_DATA_CAPTURE_H + +#include + +/* Standard GObject macros */ +#define E_TYPE_DATA_CAPTURE \ + (e_data_capture_get_type ()) +#define E_DATA_CAPTURE(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_DATA_CAPTURE, EDataCapture)) +#define E_DATA_CAPTURE_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_DATA_CAPTURE, EDataCaptureClass)) +#define E_IS_DATA_CAPTURE(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_DATA_CAPTURE)) +#define E_IS_DATA_CAPTURE_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_DATA_CAPTURE)) +#define E_DATA_CAPTURE_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_DATA_CAPTURE, EDataCaptureClass)) + +G_BEGIN_DECLS + +typedef struct _EDataCapture EDataCapture; +typedef struct _EDataCaptureClass EDataCaptureClass; +typedef struct _EDataCapturePrivate EDataCapturePrivate; + +/** + * EDataCapture: + * + * Contains only private data that should be read and manipulated using the + * functions below. + **/ +struct _EDataCapture { + GObject parent; + EDataCapturePrivate *priv; +}; + +struct _EDataCaptureClass { + GObjectClass parent_class; + + /* Signals */ + void (*finished) (EDataCapture *capture, + GBytes *data); +}; + +GType e_data_capture_get_type (void) G_GNUC_CONST; +EDataCapture * e_data_capture_new (GMainContext *main_context); +GMainContext * e_data_capture_ref_main_context (EDataCapture *data_capture); + +G_END_DECLS + +#endif /* E_DATA_CAPTURE_H */ + -- cgit v1.2.3