summaryrefslogtreecommitdiffstats
path: root/src/lib/util/io/fd.h
blob: 9e8a742106f0fec8a56f9138e5d3e2fa9e3f5dcf (plain)
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
// Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef UTIL_IO_FD_H
#define UTIL_IO_FD_H 1

#include <unistd.h>

/**
 * @file fd.h
 * @short Wrappers around common unix fd manipulation functions.
 */

namespace isc {
namespace util {
namespace io {

/*
 * \short write() that writes everything.
 * Wrapper around write(). The difference is, it never writes less data
 * and looks successful (eg. it blocks until all data are written).
 * Retries on signals.
 *
 * \return True if successful, false otherwise. The errno variable is left
 *     intact.
 * \param fd Where to write.
 * \param data The buffer to write.
 * \param length How much data is there to write.
 */
bool
write_data(const int fd, const void *data, const size_t length);

/*
 * \short read() that reads everything.
 * Wrapper around read(). It does not do short reads, if it returns less,
 * it means there was EOF. It retries on signals.
 *
 * \return Number of bytes read or -1 on error.
 * \param fd Where to read data from.
 * \param data Where to put the data.
 * \param length How many of them.
 */
ssize_t
read_data(const int fd, void *buffer, const size_t length);

}
}
}

#endif // UTIL_IO_FD_H