diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2010-12-07 02:44:13 +0100 |
|---|---|---|
| committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2010-12-09 10:58:47 +0100 |
| commit | e8e84574952132f8e94ed97b6fdf69646e32488b (patch) | |
| tree | a491a5b482b2297b44a459c022cf7e01180855f0 /gtk/spice-channel.h | |
| parent | 027fb69593e471510701ae4f556f84b4c5d7ccc0 (diff) | |
gtk: continue API documentation
Diffstat (limited to 'gtk/spice-channel.h')
| -rw-r--r-- | gtk/spice-channel.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/gtk/spice-channel.h b/gtk/spice-channel.h index 6d42810..1198e83 100644 --- a/gtk/spice-channel.h +++ b/gtk/spice-channel.h @@ -34,6 +34,20 @@ G_BEGIN_DECLS typedef struct spice_msg_in spice_msg_in; typedef struct spice_msg_out spice_msg_out; +/** + * SpiceChannelEvent: + * + * @SPICE_CHANNEL_NONE: no event, or ignored event + * @SPICE_CHANNEL_OPENED: connection is authentified and ready + * @SPICE_CHANNEL_CLOSED: connection is closed normally + * @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, @@ -57,16 +71,19 @@ struct _SpiceChannelClass { GObjectClass parent_class; + /*< private >*/ /* virtual methods, coroutine context */ void (*handle_msg)(SpiceChannel *channel, spice_msg_in *msg); void (*channel_up)(SpiceChannel *channel); void (*iterate_write)(SpiceChannel *channel); void (*iterate_read)(SpiceChannel *channel); + /*< public >*/ /* signals, system context */ void (*channel_event)(SpiceChannel *channel, SpiceChannelEvent event); void (*open_fd)(SpiceChannel *channel, int with_tls); + /*< private >*/ /* * If adding fields to this struct, remove corresponding * amount of padding to avoid changing overall struct size |