blob: 376ad39e307addafe0cd7395d8578c3956a3a621 [file] [log] [blame]
[email protected]5fe733de2009-02-11 18:59:201// Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef BASE_FILE_DESCRIPTOR_POSIX_H_
6#define BASE_FILE_DESCRIPTOR_POSIX_H_
7
[email protected]0daaebfe2014-03-15 00:09:058#include "base/files/file.h"
morritaa409ccc2014-10-20 23:53:259#include "base/files/scoped_file.h"
[email protected]0daaebfe2014-03-15 00:09:0510
[email protected]5fe733de2009-02-11 18:59:2011namespace base {
12
13// -----------------------------------------------------------------------------
14// We introduct a special structure for file descriptors in order that we are
15// able to use template specialisation to special-case their handling.
[email protected]2749885f2009-03-05 21:40:1116//
17// WARNING: (Chromium only) There are subtleties to consider if serialising
[email protected]946d1b22009-07-22 23:57:2118// these objects over IPC. See comments in ipc/ipc_message_utils.h
[email protected]82e5ee82009-04-03 02:29:4519// above the template specialisation for this structure.
[email protected]5fe733de2009-02-11 18:59:2020// -----------------------------------------------------------------------------
21struct FileDescriptor {
[email protected]0daaebfe2014-03-15 00:09:0522 FileDescriptor() : fd(-1), auto_close(false) {}
[email protected]5fe733de2009-02-11 18:59:2023
[email protected]0daaebfe2014-03-15 00:09:0524 FileDescriptor(int ifd, bool iauto_close) : fd(ifd), auto_close(iauto_close) {
25 }
26
27 FileDescriptor(File file) : fd(file.TakePlatformFile()), auto_close(true) {}
morritaa409ccc2014-10-20 23:53:2528 explicit FileDescriptor(ScopedFD fd) : fd(fd.release()), auto_close(true) {}
[email protected]5fe733de2009-02-11 18:59:2029
[email protected]d65adb12010-04-28 17:26:4930 bool operator==(const FileDescriptor& other) const {
31 return (fd == other.fd && auto_close == other.auto_close);
32 }
33
[email protected]af58f482014-03-19 14:50:2134 bool operator!=(const FileDescriptor& other) const {
35 return !operator==(other);
36 }
37
[email protected]d65adb12010-04-28 17:26:4938 // A comparison operator so that we can use these as keys in a std::map.
39 bool operator<(const FileDescriptor& other) const {
40 return other.fd < fd;
41 }
42
[email protected]5fe733de2009-02-11 18:59:2043 int fd;
44 // If true, this file descriptor should be closed after it has been used. For
45 // example an IPC system might interpret this flag as indicating that the
46 // file descriptor it has been given should be closed after use.
47 bool auto_close;
48};
49
50} // namespace base
51
52#endif // BASE_FILE_DESCRIPTOR_POSIX_H_