summaryrefslogtreecommitdiff
path: root/mate-dictionary/libgdict/gdict-client-context.h
blob: 2854fed662ff466ab5f2fee5c00bcddcd9d870e0 (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
/* gdict-server-context.h - Implementation of a dictionary protocol client context
 *
 * Copyright (C) 2005  Emmanuele Bassi <ebassi@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 */

#ifndef __GDICT_CLIENT_CONTEXT_H__
#define __GDICT_CLIENT_CONTEXT_H__

#include <glib-object.h>

#define GDICT_TYPE_CLIENT_CONTEXT		(gdict_client_context_get_type ())
#define GDICT_CLIENT_CONTEXT(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GDICT_TYPE_CLIENT_CONTEXT, GdictClientContext))
#define GDICT_IS_CLIENT_CONTEXT(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDICT_TYPE_CLIENT_CONTEXT))
#define GDICT_CLIENT_CONTEXT_CLASS(klass)	(G_TYPE_CHECK_CLASS_CAST ((klass), GDICT_TYPE_CLIENT_CONTEXT, GdictClientContextClass))
#define GDICT_CLIENT_CONTEXT_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS ((obj), GDICT_TYPE_CLIENT_CONTEXT, GdictClientContextClass))

typedef struct _GdictClientContext        GdictClientContext;
typedef struct _GdictClientContextClass   GdictClientContextClass;
typedef struct _GdictClientContextPrivate GdictClientContextPrivate;

#define GDICT_CLIENT_CONTEXT_ERROR	(gdict_client_context_error_quark ())

/**
 * GdictClientContextError:
 * @GDICT_CLIENT_CONTEXT_ERROR_SOCKET:
 * @GDICT_CLIENT_CONTEXT_ERROR_LOOKUP:
 * @GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION:
 * @GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN:
 *
 * #GdictClientContext error enumeration
 */
typedef enum {
  GDICT_CLIENT_CONTEXT_ERROR_SOCKET,
  GDICT_CLIENT_CONTEXT_ERROR_LOOKUP,
  GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION,
  GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN
} GdictClientContextError;

GQuark gdict_client_context_error_quark (void);

struct _GdictClientContext
{
  /*< private >*/
  GObject parent_instance;

  GdictClientContextPrivate *priv;
};

struct _GdictClientContextClass
{
  /*< private >*/
  GObjectClass parent_class;

  /*< public >*/
  /* signals monitoring the lifetime of the connection with
   * the dictionary server
   */
  void (*connected)    (GdictClientContext *context);
  void (*disconnected) (GdictClientContext *context);

  /*< private >*/
  /* padding for future expansion */
  void (*_gdict_client_1) (void);
  void (*_gdict_client_2) (void);
  void (*_gdict_client_3) (void);
  void (*_gdict_client_4) (void);
};

GType                 gdict_client_context_get_type     (void) G_GNUC_CONST;

GdictContext *        gdict_client_context_new          (const gchar        *hostname,
							 gint                port);

void                  gdict_client_context_set_hostname (GdictClientContext *context,
						         const gchar        *hostname);
const gchar *gdict_client_context_get_hostname (GdictClientContext *context);
void                  gdict_client_context_set_port     (GdictClientContext *context,
							 gint                port);
guint                 gdict_client_context_get_port     (GdictClientContext *context);
void                  gdict_client_context_set_client   (GdictClientContext *context,
							 const gchar        *client);
const gchar *gdict_client_context_get_client   (GdictClientContext *context);

#endif /* __GDICT_CLIENT_CONTEXT_H__ */