base/file_descriptor_posix.h

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