File: recv.h

package info (click to toggle)
libmpdclient 2.22-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 896 kB
  • sloc: ansic: 9,923; makefile: 9
file content (79 lines) | stat: -rw-r--r-- 1,826 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// SPDX-License-Identifier: BSD-2-Clause
// Copyright The Music Player Daemon Project

/*! \file
 * \brief MPD client library
 *
 * Receiving response lines from MPD.
 *
 * Do not include this header directly.  Use mpd/client.h instead.
 */

#ifndef MPD_RECV_H
#define MPD_RECV_H

#include "compiler.h"

#include <stdbool.h>
#include <stddef.h>

struct mpd_pair;
struct mpd_connection;

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Reads the binary data response from the server.
 * The size and binary pair must be already read from the input buffer.
 *
 * The caller must allocate length bytes of memory for data.
 *
 * @return true on success
 *
 * @since libmpdclient 2.17
 */
bool
mpd_recv_binary(struct mpd_connection *connection, void *data, size_t length);

/**
 * Reads the next #mpd_pair from the server.  Returns NULL if there
 * are no more pairs.
 *
 * The caller must dispose the pair with either mpd_return_pair() or
 * mpd_enqueue_pair().
 */
mpd_malloc
struct mpd_pair *
mpd_recv_pair(struct mpd_connection *connection);

/**
 * Same as mpd_recv_pair(), but discards all pairs not matching the
 * specified name.
 */
mpd_malloc
struct mpd_pair *
mpd_recv_pair_named(struct mpd_connection *connection, const char *name);

/**
 * Indicates that the pair object is not needed anymore, and can be
 * freed.  You must free the previous #mpd_pair object before calling
 * mpd_recv_pair() again.
 */
void
mpd_return_pair(struct mpd_connection *connection, struct mpd_pair *pair);

/**
 * Unreads a #mpd_pair.  You may unread only the one pair you just got
 * from mpd_recv_pair().  Unreading the "NULL" pair is allowed, to
 * allow you to call mpd_recv_pair() again at the end of a response.
 */
void
mpd_enqueue_pair(struct mpd_connection *connection, struct mpd_pair *pair);

#ifdef __cplusplus
}
#endif

#endif