MPD: neighbor/Explorer.hxx Source File

MPD 0.20.18

Explorer.hxx
Go to the documentation of this file.
1 /*
2 * Copyright 2003-2017 The Music Player Daemon Project
3 * http://www.musicpd.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifndef MPD_NEIGHBOR_EXPLORER_HXX
21 #define MPD_NEIGHBOR_EXPLORER_HXX
22
23 #include <forward_list>
24
25 class NeighborListener;
26 struct NeighborInfo;
27
39 class NeighborExplorer {
40 protected:
41 NeighborListener &listener;
42
43 explicit NeighborExplorer(NeighborListener &_listener)
44 :listener(_listener) {}
45
46 public:
47 typedef std::forward_list<NeighborInfo> List;
48
52 virtual ~NeighborExplorer() {}
53
59 virtual void Open() = 0;
60
64 virtual void Close() = 0;
65
69 virtual List GetList() const = 0;
70 };
71
72 #endif
NeighborExplorer
An object that explores the neighborhood for music servers.
Definition: Explorer.hxx:39
NeighborExplorer::listener
NeighborListener & listener
Definition: Explorer.hxx:41
NeighborInfo
Definition: Info.hxx:25
NeighborExplorer::~NeighborExplorer
virtual ~NeighborExplorer()
Free instance data.
Definition: Explorer.hxx:52
NeighborExplorer::GetList
virtual List GetList() const =0
Obtain a list of currently known neighbors.
NeighborListener
An interface that listens on events from neighbor plugins.
Definition: Listener.hxx:30
NeighborExplorer::Close
virtual void Close()=0
Stop exploring.
NeighborExplorer::Open
virtual void Open()=0
Start exploring the neighborhood.
NeighborExplorer::NeighborExplorer
NeighborExplorer(NeighborListener &_listener)
Definition: Explorer.hxx:43
NeighborExplorer::List
std::forward_list< NeighborInfo > List
Definition: Explorer.hxx:47