ipc/ipc_channel_handle.h

   1 // Copyright (c) 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 IPC_IPC_CHANNEL_HANDLE_H_
   6 #define IPC_IPC_CHANNEL_HANDLE_H_
   7 #pragma once
   8
   9 #include <string>
  10
  11 #include "build/build_config.h"
  12
  13 #if defined(OS_POSIX)
  14 #include "base/file_descriptor_posix.h"
  15 #endif
  16
  17 // On Windows, any process can create an IPC channel and others can fetch
  18 // it by name.  We pass around the channel names over IPC.
  19 // On POSIX, we instead pass around handles to channel endpoints via IPC.
  20 // When it's time to IPC a new channel endpoint around, we send both the
  21 // channel name as well as a base::FileDescriptor, which is itself a special
  22 // type that knows how to copy a socket endpoint over IPC.
  23 //
  24 // In sum, when passing a handle to a channel over IPC, use this data structure
  25 // to work on both Windows and POSIX.
  26
  27 namespace IPC {
  28
  29 struct ChannelHandle {
  30   // Note that serialization for this object is defined in the ParamTraits
  31   // template specialization in ipc_message_utils.h.
  32   ChannelHandle() {}
  33   ChannelHandle(const std::string& n) : name(n) {}
  34   ChannelHandle(const char* n) : name(n) {}
  35 #if defined(OS_POSIX)
  36   ChannelHandle(const std::string& n, const base::FileDescriptor& s)
  37       : name(n), socket(s) {}
  38 #endif  // defined(OS_POSIX)
  39
  40   std::string name;
  41 #if defined(OS_POSIX)
  42   base::FileDescriptor socket;
  43 #endif  // defined(OS_POSIX)
  44
  45 };
  46
  47 }  // namespace IPC
  48
  49 #endif  // IPC_IPC_CHANNEL_HANDLE_H_