/*
* Copyright (C) 2011-2013 Karlsruhe Institute of Technology
*
* This file is part of Ufo.
*
* This library 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 3 of the License, or (at your option) any later version.
*
* This library 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 this library. If not, see .
*/
#ifndef __UFO_GROUP_H
#define __UFO_GROUP_H
#if !defined (__UFO_H_INSIDE__) && !defined (UFO_COMPILATION)
#error "Only can be included directly."
#endif
#include
#include
G_BEGIN_DECLS
#define UFO_TYPE_GROUP (ufo_group_get_type())
#define UFO_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), UFO_TYPE_GROUP, UfoGroup))
#define UFO_IS_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), UFO_TYPE_GROUP))
#define UFO_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), UFO_TYPE_GROUP, UfoGroupClass))
#define UFO_IS_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), UFO_TYPE_GROUP))
#define UFO_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), UFO_TYPE_GROUP, UfoGroupClass))
typedef struct _UfoGroup UfoGroup;
typedef struct _UfoGroupClass UfoGroupClass;
typedef struct _UfoGroupPrivate UfoGroupPrivate;
#define UFO_END_OF_STREAM (GINT_TO_POINTER(1))
/**
* UfoSendPattern:
* @UFO_SEND_BROADCAST: Broadcast data to all connected nodes
* @UFO_SEND_SCATTER: Scatter data among connected nodes.
* @UFO_SEND_SEQUENTIAL: Break up a linear input stream and transfer sub streams
* one by one to connected nodes.
*
* The send pattern describes how results are passed to connected nodes.
*/
typedef enum {
UFO_SEND_BROADCAST,
UFO_SEND_SCATTER,
UFO_SEND_SEQUENTIAL
} UfoSendPattern;
/**
* UfoGroup:
*
* Main object for organizing filters. The contents of the #UfoGroup structure
* are private and should only be accessed via the provided API.
*/
struct _UfoGroup {
/*< private >*/
GObject parent_instance;
UfoGroupPrivate *priv;
};
/**
* UfoGroupClass:
*
* #UfoGroup class
*/
struct _UfoGroupClass {
/*< private >*/
GObjectClass parent_class;
};
UfoGroup * ufo_group_new (GList *targets,
gpointer context,
UfoSendPattern pattern);
guint ufo_group_get_num_targets (UfoGroup *group);
void ufo_group_set_num_expected (UfoGroup *group,
UfoTask *target,
gint n_expected);
UfoBuffer * ufo_group_pop_output_buffer (UfoGroup *group,
UfoRequisition *requisition);
void ufo_group_push_output_buffer (UfoGroup *group,
UfoBuffer *buffer);
UfoBuffer * ufo_group_pop_input_buffer (UfoGroup *group,
UfoTask *target);
void ufo_group_push_input_buffer (UfoGroup *group,
UfoTask *target,
UfoBuffer *input);
void ufo_group_finish (UfoGroup *group);
GType ufo_group_get_type (void);
G_END_DECLS
#endif