← Back to branch summary

~bregma/geis/lp-785321

« back to all changes in this revision

Viewing changes to libutouch-geis/geis_backend_token.h

  • Committer: Stephen M. Webb
  • Date: 2011-10-18 20:30:02 UTC
  • mfrom: (158.1.42 client-arch)
  • Revision ID: stephen.webb@canonical.com-20111018203002-ne8h3n25fbey3fqr
Merged client-arch branch.

Provided a new DBus-client back end and a dbus-server facility.  Included a test driver for the server.  Made the DBus client the default back-end with an automatic fall back to the XCB back end for seamless support of existing client software.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libutouch-geis/geis_backend_token.h
37
37
  GEIS_BACKEND_TOKEN_INIT_ALL
38
38
} GeisBackendTokenInitState;
39
39
 
 
40
 
40
41
/**
41
42
 * Creates a new backend token.
 
43
 *
42
44
 * @param[in] geis       The API instance for which the token is created.
43
45
 * @param[in] init_state The initial state the token should be in.
 
46
 *
 
47
 * @returns a new %GeisBackendToken initialized according to @p init_state or
 
48
 * NULL on failure.
44
49
 */
45
 
GeisBackendToken geis_backend_token_new(Geis                      geis,
46
 
                                        GeisBackendTokenInitState init_state);
 
50
GeisBackendToken
 
51
geis_backend_token_new(Geis geis, GeisBackendTokenInitState init_state);
47
52
 
48
53
/**
49
54
 * Clones a new backend token from an existing one.
50
55
 * @param[in] token  The orignal backend token.
 
56
 *
 
57
 * @returns a new %GeisBackendToken that is an identical copy of @p token or
 
58
 * NULL on failure.  Failure is not really an option.
51
59
 */
52
 
GeisBackendToken geis_backend_token_clone(GeisBackendToken token);
 
60
GeisBackendToken
 
61
geis_backend_token_clone(GeisBackendToken token);
53
62
 
54
63
/**
55
64
 * Destroys a backend token.
 
65
 *
56
66
 * @param[in] token  The backend token.
57
67
 */
58
 
void geis_backend_token_delete(GeisBackendToken token);
 
68
void
 
69
geis_backend_token_delete(GeisBackendToken token);
59
70
 
60
71
/**
61
72
 * Composes two backend tokens into a new backend token.
 
73
 *
62
74
 * @param[in] lhs  A backend token.
63
75
 * @param[in] rhs  Another backend token.
64
76
 *
65
77
 * Composed tokens are effectively ANDed.
66
78
 */
67
 
void geis_backend_token_compose(GeisBackendToken lhs, GeisBackendToken rhs);
 
79
void
 
80
geis_backend_token_compose(GeisBackendToken lhs, GeisBackendToken rhs);
68
81
 
69
82
/**
70
83
 * Activates a token in the back end.
71
 
 * @param[in] token  The backend token.
 
84
 *
 
85
 * @param[in] token         A backend token.
 
86
 * @param[in] subscription  The subscription under which the token will be
 
87
 *                          activated.
72
88
 */
73
 
GeisStatus geis_backend_token_activate(GeisBackendToken token);
 
89
GeisStatus
 
90
geis_backend_token_activate(GeisBackendToken token,
 
91
                            GeisSubscription subscription);
74
92
 
75
93
/**
76
94
 * Deactivates a token in the back end.
77
 
 * @param[in] token  The backend token.
 
95
 *
 
96
 * @param[in] token          The backend token.
 
97
 * @param[in] subscription  The subscription for which the token will be
 
98
 *                          deactivated.
78
99
 */
79
 
GeisStatus geis_backend_token_deactivate(GeisBackendToken token);
 
100
GeisStatus
 
101
geis_backend_token_deactivate(GeisBackendToken token,
 
102
                              GeisSubscription subscription);
80
103
 
81
104
#endif /* GEIS_BACKEND_TOKEN_H_ */