source/modules/juce_core/network/juce_NamedPipe.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    The code included in this file is provided under the terms of the ISC license
  11    http://www.isc.org/downloads/software-support-policy/isc-license. Permission
  12    To use, copy, modify, and/or distribute this software for any purpose with or
  13    without fee is hereby granted provided that the above copyright notice and
  14    this permission notice appear in all copies.
  15
  16    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  17    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  18    DISCLAIMED.
  19
  20   ==============================================================================
  21 */
  22
  23 namespace juce
  24 {
  25
  26 //==============================================================================
  27 /**
  28     A cross-process pipe that can have data written to and read from it.
  29
  30     Two processes can use NamedPipe objects to exchange blocks of data.
  31
  32     @see InterprocessConnection
  33
  34     @tags{Core}
  35 */
  36 class JUCE_API  NamedPipe  final
  37 {
  38 public:
  39     //==============================================================================
  40     /** Creates a NamedPipe. */
  41     NamedPipe();
  42
  43     /** Destructor. */
  44     ~NamedPipe();
  45
  46     //==============================================================================
  47     /** Tries to open a pipe that already exists.
  48         Returns true if it succeeds.
  49     */
  50     bool openExisting (const String& pipeName);
  51
  52     /** Tries to create a new pipe.
  53         Returns true if it succeeds.
  54         If mustNotExist is true then it will fail if a pipe is already
  55         open with the same name.
  56     */
  57     bool createNewPipe (const String& pipeName, bool mustNotExist = false);
  58
  59     /** Closes the pipe, if it's open. */
  60     void close();
  61
  62     /** True if the pipe is currently open. */
  63     bool isOpen() const;
  64
  65     /** Returns the last name that was used to try to open this pipe. */
  66     String getName() const;
  67
  68     //==============================================================================
  69     /** Reads data from the pipe.
  70
  71         This will block until another thread has written enough data into the pipe to fill
  72         the number of bytes specified, or until another thread calls the cancelPendingReads()
  73         method.
  74
  75         If the operation fails, it returns -1, otherwise, it will return the number of
  76         bytes read.
  77
  78         If timeOutMilliseconds is less than zero, it will wait indefinitely, otherwise
  79         this is a maximum timeout for reading from the pipe.
  80     */
  81     int read (void* destBuffer, int maxBytesToRead, int timeOutMilliseconds);
  82
  83     /** Writes some data to the pipe.
  84         @returns the number of bytes written, or -1 on failure.
  85     */
  86     int write (const void* sourceBuffer, int numBytesToWrite, int timeOutMilliseconds);
  87
  88 private:
  89     //==============================================================================
  90     JUCE_PUBLIC_IN_DLL_BUILD (class Pimpl)
  91     std::unique_ptr<Pimpl> pimpl;
  92     String currentPipeName;
  93     ReadWriteLock lock;
  94
  95     bool openInternal (const String& pipeName, bool createPipe, bool mustNotExist);
  96
  97     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (NamedPipe)
  98 };
  99
 100 } // namespace juce