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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/* -*- Mode: C; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
Copyright (C) 2010 Red Hat, Inc.
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 2.1 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 __SPICE_CLIENT_CHANNEL_H__
#define __SPICE_CLIENT_CHANNEL_H__
G_BEGIN_DECLS
#include <gio/gio.h>
#include "spice-types.h"
#include "spice-glib-enums.h"
#include "spice-util.h"
#define SPICE_TYPE_CHANNEL (spice_channel_get_type ())
#define SPICE_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), SPICE_TYPE_CHANNEL, SpiceChannel))
#define SPICE_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), SPICE_TYPE_CHANNEL, SpiceChannelClass))
#define SPICE_IS_CHANNEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SPICE_TYPE_CHANNEL))
#define SPICE_IS_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_CHANNEL))
#define SPICE_CHANNEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_CHANNEL, SpiceChannelClass))
typedef struct _SpiceMsgIn SpiceMsgIn;
typedef struct _SpiceMsgOut SpiceMsgOut;
/**
* SpiceChannelEvent:
* @SPICE_CHANNEL_NONE: no event, or ignored event
* @SPICE_CHANNEL_OPENED: connection is authentified and ready
* @SPICE_CHANNEL_CLOSED: connection is closed normally (sent if channel was ready)
* @SPICE_CHANNEL_ERROR_CONNECT: connection error
* @SPICE_CHANNEL_ERROR_TLS: SSL error
* @SPICE_CHANNEL_ERROR_LINK: error during link process
* @SPICE_CHANNEL_ERROR_AUTH: authentication error
* @SPICE_CHANNEL_ERROR_IO: IO error
*
* An event, emitted by #SpiceChannel::channel-event signal.
**/
typedef enum
{
SPICE_CHANNEL_NONE = 0,
SPICE_CHANNEL_OPENED = 10,
SPICE_CHANNEL_SWITCHING,
SPICE_CHANNEL_CLOSED,
SPICE_CHANNEL_ERROR_CONNECT = 20,
SPICE_CHANNEL_ERROR_TLS,
SPICE_CHANNEL_ERROR_LINK,
SPICE_CHANNEL_ERROR_AUTH,
SPICE_CHANNEL_ERROR_IO,
} SpiceChannelEvent;
struct _SpiceChannel
{
GObject parent;
SpiceChannelPrivate *priv;
/* Do not add fields to this struct */
};
struct _SpiceChannelClass
{
GObjectClass parent_class;
/*< public >*/
/* signals, main context */
void (*channel_event)(SpiceChannel *channel, SpiceChannelEvent event);
void (*open_fd)(SpiceChannel *channel, int with_tls);
/*< private >*/
/* virtual methods, coroutine context */
void (*handle_msg)(SpiceChannel *channel, SpiceMsgIn *msg);
void (*channel_up)(SpiceChannel *channel);
void (*iterate_write)(SpiceChannel *channel);
void (*iterate_read)(SpiceChannel *channel);
/*< private >*/
/* virtual method, any context */
gpointer deprecated;
void (*channel_reset)(SpiceChannel *channel, gboolean migrating);
void (*channel_reset_capabilities)(SpiceChannel *channel);
/*< private >*/
/* virtual methods, coroutine context */
void (*channel_send_migration_handshake)(SpiceChannel *channel);
GArray *handlers;
/*
* If adding fields to this struct, remove corresponding
* amount of padding to avoid changing overall struct size
*/
gchar _spice_reserved[SPICE_RESERVED_PADDING - 2 * sizeof(void *)];
};
GType spice_channel_get_type(void);
typedef void (*spice_msg_handler)(SpiceChannel *channel, SpiceMsgIn *in);
SpiceChannel *spice_channel_new(SpiceSession *s, int type, int id);
gboolean spice_channel_connect(SpiceChannel *channel);
gboolean spice_channel_open_fd(SpiceChannel *channel, int fd);
void spice_channel_disconnect(SpiceChannel *channel, SpiceChannelEvent reason);
gboolean spice_channel_test_capability(SpiceChannel *channel, guint32 cap);
gboolean spice_channel_test_common_capability(SpiceChannel *channel, guint32 cap);
void spice_channel_flush_async(SpiceChannel *channel, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
gboolean spice_channel_flush_finish(SpiceChannel *channel, GAsyncResult *result, GError **error);
#ifndef SPICE_DISABLE_DEPRECATED
SPICE_DEPRECATED
void spice_channel_set_capability(SpiceChannel *channel, guint32 cap);
SPICE_DEPRECATED
void spice_channel_destroy(SpiceChannel *channel);
#endif
const gchar* spice_channel_type_to_string(gint type);
gint spice_channel_string_to_type(const gchar *str);
const GError* spice_channel_get_error(SpiceChannel *channel);
G_END_DECLS
#endif /* __SPICE_CLIENT_CHANNEL_H__ */
|
