8c6d97f85f442167b91e31e0d9c7c3bb3fea7387
[ncmpc-debian.git] / src / gidle.hxx
1 /* ncmpc (Ncurses MPD Client)
2    (c) 2004-2018 The Music Player Daemon Project
3    Project homepage: http://musicpd.org
4
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15
16    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
20    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #ifndef MPD_GLIB_SOURCE_H
30 #define MPD_GLIB_SOURCE_H
31
32 #include "AsioServiceFwd.hxx"
33
34 #include <mpd/client.h>
35
36 #include <boost/asio/posix/stream_descriptor.hpp>
37
38 class MpdIdleHandler {
39 public:
40         virtual void OnIdle(unsigned events) noexcept = 0;
41         virtual void OnIdleError(enum mpd_error error,
42                                  enum mpd_server_error server_error,
43                                  const char *message) noexcept = 0;
44 };
45
46 class MpdIdleSource {
47         struct mpd_connection *connection;
48         struct mpd_async *async;
49         struct mpd_parser *parser;
50
51         MpdIdleHandler &handler;
52
53         boost::asio::posix::stream_descriptor socket;
54
55         unsigned io_events = 0;
56
57         unsigned idle_events;
58
59 public:
60         MpdIdleSource(boost::asio::io_service &io_service,
61                       struct mpd_connection &_connection,
62                       MpdIdleHandler &_handler) noexcept;
63         ~MpdIdleSource() noexcept;
64
65         /**
66          * Enters idle mode.
67          *
68          * @return true if idle mode has been entered, false if not
69          * (e.g. I/O error)
70          */
71         bool Enter() noexcept;
72
73         /**
74          * Leaves idle mode and invokes the callback if there were events.
75          */
76         void Leave() noexcept;
77
78 private:
79         void InvokeCallback() noexcept {
80                 if (idle_events != 0)
81                         handler.OnIdle(idle_events);
82         }
83
84         void InvokeError(enum mpd_error error,
85                          enum mpd_server_error server_error,
86                          const char *message) noexcept {
87                 handler.OnIdleError(error, server_error, message);
88         }
89
90         void InvokeAsyncError() noexcept;
91
92         /**
93          * Parses a response line from MPD.
94          *
95          * @return true on success, false on error
96          */
97         bool Feed(char *line) noexcept;
98
99         /**
100          * Receives and evaluates a portion of the MPD response.
101          *
102          * @return true on success, false on error
103          */
104         bool Receive() noexcept;
105
106         void OnReadable(const boost::system::error_code &error) noexcept;
107         void OnWritable(const boost::system::error_code &error) noexcept;
108
109         void AsyncRead() noexcept;
110         void AsyncWrite() noexcept;
111         void UpdateSocket() noexcept;
112 };
113
114 #endif