summaryrefslogtreecommitdiff
path: root/ufo/ufo-remote-node.h
blob: 8fa7b656e5b0f6665b48b6ef3bd41b4144079925 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 * 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 <http://www.gnu.org/licenses/>.
 */

#ifndef __UFO_REMOTE_NODE_H
#define __UFO_REMOTE_NODE_H

#if !defined (__UFO_H_INSIDE__) && !defined (UFO_COMPILATION)
#error "Only <ufo/ufo.h> can be included directly."
#endif

#include <ufo/ufo-node.h>
#include <ufo/ufo-buffer.h>
#include <ufo/ufo-task-iface.h>
#include <ufo/ufo-messenger-iface.h>

G_BEGIN_DECLS

#define UFO_TYPE_REMOTE_NODE             (ufo_remote_node_get_type())
#define UFO_REMOTE_NODE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), UFO_TYPE_REMOTE_NODE, UfoRemoteNode))
#define UFO_IS_REMOTE_NODE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), UFO_TYPE_REMOTE_NODE))
#define UFO_REMOTE_NODE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), UFO_TYPE_REMOTE_NODE, UfoRemoteNodeClass))
#define UFO_IS_REMOTE_NODE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), UFO_TYPE_REMOTE_NODE))
#define UFO_REMOTE_NODE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), UFO_TYPE_REMOTE_NODE, UfoRemoteNodeClass))

typedef struct _UfoRemoteNode           UfoRemoteNode;
typedef struct _UfoRemoteNodeClass      UfoRemoteNodeClass;
typedef struct _UfoRemoteNodePrivate    UfoRemoteNodePrivate;

/**
 * UfoRemoteNode:
 *
 * Main object for organizing filters. The contents of the #UfoRemoteNode structure
 * are private and should only be accessed via the provided API.
 */
struct _UfoRemoteNode {
    /*< private >*/
    UfoNode parent_instance;

    UfoRemoteNodePrivate *priv;
};

/**
 * UfoRemoteNodeClass:
 *
 * #UfoRemoteNode class
 */
struct _UfoRemoteNodeClass {
    /*< private >*/
    UfoNodeClass parent_class;
};

/**
 * UfoRemoteMode:
 * @UFO_REMOTE_MODE_STREAM: Expand task graph and execute only sub-branches
 *  remotely.
 * @UFO_REMOTE_MODE_REPLICATE: Replicate the entire task graph and execute it
 *  remotely.
 */
typedef enum {
    UFO_REMOTE_MODE_STREAM,
    UFO_REMOTE_MODE_REPLICATE
} UfoRemoteMode;



UfoNode    *ufo_remote_node_new                 (const gchar    *address);
guint       ufo_remote_node_get_num_gpus        (UfoRemoteNode  *node);
void        ufo_remote_node_send_json           (UfoRemoteNode  *node,
                                                 UfoRemoteMode   mode,
                                                 const gchar    *json);
guint       ufo_remote_node_get_num_inputs      (UfoRemoteNode  *node);
void	    ufo_remote_node_set_num_inputs	(UfoRemoteNode  *node,
						 guint		n_inputs);
guint       ufo_remote_node_get_num_dimensions  (UfoRemoteNode  *node,
                                                 guint           input);
UfoTaskMode ufo_remote_node_get_mode            (UfoRemoteNode  *node);
void        ufo_remote_node_send_inputs         (UfoRemoteNode  *node,
                                                 UfoBuffer     **inputs);
void        ufo_remote_node_get_result          (UfoRemoteNode  *node,
                                                 UfoBuffer      *result);
void        ufo_remote_node_get_requisition     (UfoRemoteNode  *node,
                                                 UfoRequisition *requisition);
void        ufo_remote_node_cleanup             (UfoRemoteNode  *node);
void        ufo_remote_node_terminate           (UfoRemoteNode  *node);
GType       ufo_remote_node_get_type            (void);

G_END_DECLS

#endif