doxygen: clean up function documentation.
[disorder] / lib / speaker-protocol.c
1 /*
2 * This file is part of DisOrder.
3 * Copyright (C) 2005, 2007 Richard Kettlewell
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 3 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
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18 /** @file lib/speaker-protocol.c
19 * @brief Speaker/server protocol support
20 */
21
22 #include "common.h"
23
24 #include <sys/socket.h>
25 #include <errno.h>
26 #include <unistd.h>
27 #include <stddef.h>
28
29 #include "speaker-protocol.h"
30 #include "log.h"
31
32 /** @brief Send a speaker message
33 * @param fd File descriptor to send to
34 * @param sm Pointer to message
35 */
36 void speaker_send(int fd, const struct speaker_message *sm) {
37 int ret;
38
39 do {
40 ret = write(fd, sm, sizeof *sm);
41 } while(ret < 0 && errno == EINTR);
42 if(ret < 0)
43 disorder_fatal(errno, "write");
44 }
45
46 /** @brief Receive a speaker message
47 * @param fd File descriptor to read from
48 * @param sm Where to store received message
49 * @return -ve on @c EAGAIN, 0 at EOF, +ve on success
50 */
51 int speaker_recv(int fd, struct speaker_message *sm) {
52 int ret;
53
54 do {
55 ret = read(fd, sm, sizeof *sm);
56 } while(ret < 0 && errno == EINTR);
57 if(ret < 0) {
58 if(errno != EAGAIN)
59 disorder_fatal(errno, "recvmsg");
60 return -1;
61 }
62 return ret;
63 }
64
65 /*
66 Local Variables:
67 c-basic-offset:2
68 comment-column:40
69 fill-column:79
70 indent-tabs-mode:nil
71 End:
72 */