~thomas-voss/location-service/add-snapcraft-setup-next

« back to all changes in this revision

Viewing changes to src/location/bus.h

Merge lp:~thomas-voss/location-service/simplify-provider-interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Copyright © 2016 Canonical Ltd.
 
3
 *
 
4
 * This program is free software: you can redistribute it and/or modify it
 
5
 * under the terms of the GNU Lesser General Public License version 3,
 
6
 * as published by the Free Software Foundation.
 
7
 *
 
8
 * This program is distributed in the hope that it will be useful,
 
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 * GNU Lesser General Public License for more details.
 
12
 *
 
13
 * You should have received a copy of the GNU Lesser General Public License
 
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
15
 *
 
16
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 
17
 */
 
18
#ifndef LOCATION_BUS_H_
 
19
#define LOCATION_BUS_H_
 
20
 
 
21
#include <location/event.h>
 
22
 
 
23
#include <memory>
 
24
 
 
25
namespace location
 
26
{
 
27
/// @brief Bus provides a simple way for distributing events to multiple listeners.
 
28
class Bus
 
29
{
 
30
public:
 
31
    // Safe us some typing
 
32
    typedef std::shared_ptr<Bus> Ptr;
 
33
 
 
34
    /// @brief subscribe makes receiver known to the bus.
 
35
    virtual void subscribe(const Event::Receiver::Ptr& receiver) = 0;
 
36
 
 
37
    /// @brief unsubscribe removes receiver from the bus.
 
38
    virtual void unsubscribe(const Event::Receiver::Ptr& receiver) = 0;
 
39
 
 
40
    /// @brief dispatch takes eventand hands it to all subscribed receivers.
 
41
    virtual void dispatch(const Event::Ptr& event) = 0;
 
42
};
 
43
}
 
44
 
 
45
#endif // LOCATION_BUS_H_