io.hpp

Go to the documentation of this file.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License

#ifndef __PROCESS_IO_HPP__
#define __PROCESS_IO_HPP__

#include <cstring> // For size_t.
#include <string>

#include <process/future.hpp>

#include <stout/nothing.hpp>
#ifdef __WINDOWS__
#include <stout/windows.hpp>
#endif // __WINDOWS__

namespace process {
namespace io {

const short READ = 0x01;

#ifndef ENABLE_LIBWINIO

const short WRITE = 0x02;
#endif // ENABLE_LIBWINIO

const size_t BUFFERED_READ_SIZE = 16*4096;

Try<Nothing> prepare_async(int_fd fd);


Try<bool> is_async(int_fd fd);


// TODO(benh): Add a version which takes multiple file descriptors.
Future<short> poll(int_fd fd, short events);


Future<size_t> read(int_fd fd, void* data, size_t size);


Future<std::string> read(int_fd fd);


Future<size_t> write(int_fd fd, const void* data, size_t size);


Future<Nothing> write(int_fd fd, const std::string& data);

Future<Nothing> redirect(
    int_fd from,
    Option<int_fd> to,
    size_t chunk = 4096,
    const std::vector<lambda::function<void(const std::string&)>>& hooks = {});

} // namespace io {
} // namespace process {

#endif // __PROCESS_IO_HPP__