1// 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
8#include "base/files/file.h"
9
10namespace base {
11
12// -----------------------------------------------------------------------------
13// We introduct a special structure for file descriptors in order that we are
14// able to use template specialisation to special-case their handling.
15//
16// WARNING: (Chromium only) There are subtleties to consider if serialising
17// these objects over IPC. See comments in ipc/ipc_message_utils.h
18// above the template specialisation for this structure.
19// -----------------------------------------------------------------------------
20struct FileDescriptor {
21  FileDescriptor() : fd(-1), auto_close(false) {}
22
23  FileDescriptor(int ifd, bool iauto_close) : fd(ifd), auto_close(iauto_close) {
24  }
25
26  FileDescriptor(File file) : fd(file.TakePlatformFile()), auto_close(true) {}
27
28  bool operator==(const FileDescriptor& other) const {
29    return (fd == other.fd && auto_close == other.auto_close);
30  }
31
32  bool operator!=(const FileDescriptor& other) const {
33    return !operator==(other);
34  }
35
36  // A comparison operator so that we can use these as keys in a std::map.
37  bool operator<(const FileDescriptor& other) const {
38    return other.fd < fd;
39  }
40
41  int fd;
42  // If true, this file descriptor should be closed after it has been used. For
43  // example an IPC system might interpret this flag as indicating that the
44  // file descriptor it has been given should be closed after use.
45  bool auto_close;
46};
47
48}  // namespace base
49
50#endif  // BASE_FILE_DESCRIPTOR_POSIX_H_
51