libmpdclient: /usr/src/extras/libmpdclient/libmpdclient-2.11-1.i686/src/libmpdclient-2.11/include/mpd/async.h Source File

libmpdclient 2.11

async.h
Go to the documentation of this file.
1 /* libmpdclient
2 (c) 2003-2017 The Music Player Daemon Project
3 This project's homepage is: http://www.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
41 #ifndef MPD_ASYNC_H
42 #define MPD_ASYNC_H
43
44 #include <mpd/error.h>
45 #include <mpd/compiler.h>
46
47 #include <stdbool.h>
48 #include <stdarg.h>
49
53 enum mpd_async_event {
55 MPD_ASYNC_EVENT_READ = 1,
56
58 MPD_ASYNC_EVENT_WRITE = 2,
59
61 MPD_ASYNC_EVENT_HUP = 4,
62
64 MPD_ASYNC_EVENT_ERROR = 8,
65 };
66
73 struct mpd_async;
74
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78
86 mpd_malloc
87 struct mpd_async *
88 mpd_async_new(int fd);
89
93 void
94 mpd_async_free(struct mpd_async *async);
95
100 mpd_pure
101 enum mpd_error
102 mpd_async_get_error(const struct mpd_async *async);
103
115 mpd_pure
116 const char *
117 mpd_async_get_error_message(const struct mpd_async *async);
118
126 mpd_pure
127 int
128 mpd_async_get_system_error(const struct mpd_async *async);
129
136 mpd_pure
137 int
138 mpd_async_get_fd(const struct mpd_async *async);
139
154 void
155 mpd_async_set_keepalive(struct mpd_async *async,
156 bool keepalive);
157
161 mpd_pure
162 enum mpd_async_event
163 mpd_async_events(const struct mpd_async *async);
164
172 bool
173 mpd_async_io(struct mpd_async *async, enum mpd_async_event events);
174
184 bool
185 mpd_async_send_command_v(struct mpd_async *async, const char *command,
186 va_list args);
187
196 mpd_sentinel
197 bool
198 mpd_async_send_command(struct mpd_async *async, const char *command, ...);
199
208 mpd_malloc
209 char *
210 mpd_async_recv_line(struct mpd_async *async);
211
212 #ifdef __cplusplus
213 }
214 #endif
215
216 #endif
MPD_ASYNC_EVENT_WRITE
Definition: async.h:58
MPD_ASYNC_EVENT_READ
Definition: async.h:55
MPD_ASYNC_EVENT_ERROR
Definition: async.h:64
mpd_error
mpd_error
Definition: error.h:39
mpd_async_io
bool mpd_async_io(struct mpd_async *async, enum mpd_async_event events)
mpd_async_get_error_message
mpd_pure const char * mpd_async_get_error_message(const struct mpd_async *async)
mpd_async_event
mpd_async_event
Definition: async.h:53
mpd_async_get_fd
mpd_pure int mpd_async_get_fd(const struct mpd_async *async)
mpd_async_send_command
mpd_sentinel bool mpd_async_send_command(struct mpd_async *async, const char *command,...)
error.h
MPD client library.
mpd_async_send_command_v
bool mpd_async_send_command_v(struct mpd_async *async, const char *command, va_list args)
compiler.h
Compiler specific definitions.
mpd_async_free
void mpd_async_free(struct mpd_async *async)
MPD_ASYNC_EVENT_HUP
Definition: async.h:61
mpd_async_events
mpd_pure enum mpd_async_event mpd_async_events(const struct mpd_async *async)
mpd_async_set_keepalive
void mpd_async_set_keepalive(struct mpd_async *async, bool keepalive)
mpd_async_get_system_error
mpd_pure int mpd_async_get_system_error(const struct mpd_async *async)
mpd_async_recv_line
mpd_malloc char * mpd_async_recv_line(struct mpd_async *async)
mpd_async_new
mpd_malloc struct mpd_async * mpd_async_new(int fd)
mpd_async_get_error
mpd_pure enum mpd_error mpd_async_get_error(const struct mpd_async *async)
mpd_async