← Back to branch summary

~ubuntu-branches/ubuntu/trusty/geis/trusty

« back to all changes in this revision

Viewing changes to libgeis/backend/dbus/geis_dbus_locator.h

  • Committer: Package Import Robot
  • Author(s): Chase Douglas
  • Date: 2012-07-30 08:51:42 UTC
  • Revision ID: package-import@ubuntu.com-20120730085142-jrc33ygjvt0ob1wl
Tags: upstream-2.2.11
Import upstream version 2.2.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgeis/backend/dbus/geis_dbus_locator.h
 
1
/**
 
2
 * @file geis_dbus_locator.h
 
3
 * @brief Interface for the GEIS DBus locator.
 
4
 *
 
5
 * The GEIS DBus locator makes the location of the GEIS DBus server available
 
6
 * over the DBus session bus.
 
7
 *
 
8
 * This header is for internal GEIS use only and contains no client
 
9
 * (externally-visible) symbols.
 
10
 */
 
11
 
 
12
/*
 
13
 * Copyright 2011 Canonical Ltd.
 
14
 *
 
15
 * This library is free software; you can redistribute it and/or modify it under
 
16
 * the terms of the GNU Lesser General Public License as published by the Free
 
17
 * Software Foundation; either version 3 of the License, or (at your option) any
 
18
 * later version.
 
19
 *
 
20
 * This library is distributed in the hope that it will be useful, but WITHOUT
 
21
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
22
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 
23
 * details.
 
24
 *
 
25
 * You should have received a copy of the GNU General Public License
 
26
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
27
 */
 
28
#ifndef GEIS_DBUS_LOCATOR_H_
 
29
#define GEIS_DBUS_LOCATOR_H_
 
30
 
 
31
#include "geis/geis.h"
 
32
#include "geis_dbus_client.h"
 
33
 
 
34
 
 
35
typedef struct GeisDBusLocator *GeisDBusLocator;
 
36
 
 
37
 
 
38
/**
 
39
 * Creates a new GeisDBusLocator object.
 
40
 *
 
41
 * @param[in]  client A GEIS DBus CLient.
 
42
 */
 
43
GeisDBusLocator
 
44
geis_dbus_locator_new(GeisDBusClient client);
 
45
 
 
46
/**
 
47
 * Destroys a %GeisDBusLocator object.
 
48
 *
 
49
 * @param[in]  locator  A GeisDBusLocator.
 
50
 */
 
51
void
 
52
geis_dbus_locator_delete(GeisDBusLocator locator);
 
53
 
 
54
/**
 
55
 * Gets the currently located server address.
 
56
 *
 
57
 * @param[in]  locator  A GeisDBusLocator.
 
58
 */
 
59
char *
 
60
geis_dbus_locator_server_address(GeisDBusLocator locator);
 
61
 
 
62
#endif /* GEIS_DBUS_LOCATOR_H_ */