mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
97 lines
3.5 KiB
C++
97 lines
3.5 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Portions of this file are from JUCE.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
Please visit http://www.juce.com
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_NAMEDPIPE_H_INCLUDED
|
|
#define BEAST_NAMEDPIPE_H_INCLUDED
|
|
|
|
//==============================================================================
|
|
/**
|
|
A cross-process pipe that can have data written to and read from it.
|
|
|
|
Two processes can use NamedPipe objects to exchange blocks of data.
|
|
|
|
@see InterprocessConnection
|
|
*/
|
|
class BEAST_API NamedPipe : LeakChecked <NamedPipe>, public Uncopyable
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a NamedPipe. */
|
|
NamedPipe();
|
|
|
|
/** Destructor. */
|
|
~NamedPipe();
|
|
|
|
//==============================================================================
|
|
/** Tries to open a pipe that already exists.
|
|
Returns true if it succeeds.
|
|
*/
|
|
bool openExisting (const String& pipeName);
|
|
|
|
/** Tries to create a new pipe.
|
|
Returns true if it succeeds.
|
|
*/
|
|
bool createNewPipe (const String& pipeName);
|
|
|
|
/** Closes the pipe, if it's open. */
|
|
void close();
|
|
|
|
/** True if the pipe is currently open. */
|
|
bool isOpen() const;
|
|
|
|
/** Returns the last name that was used to try to open this pipe. */
|
|
String getName() const;
|
|
|
|
//==============================================================================
|
|
/** Reads data from the pipe.
|
|
|
|
This will block until another thread has written enough data into the pipe to fill
|
|
the number of bytes specified, or until another thread calls the cancelPendingReads()
|
|
method.
|
|
|
|
If the operation fails, it returns -1, otherwise, it will return the number of
|
|
bytes read.
|
|
|
|
If timeOutMilliseconds is less than zero, it will wait indefinitely, otherwise
|
|
this is a maximum timeout for reading from the pipe.
|
|
*/
|
|
int read (void* destBuffer, int maxBytesToRead, int timeOutMilliseconds);
|
|
|
|
/** Writes some data to the pipe.
|
|
@returns the number of bytes written, or -1 on failure.
|
|
*/
|
|
int write (const void* sourceBuffer, int numBytesToWrite, int timeOutMilliseconds);
|
|
|
|
private:
|
|
//==============================================================================
|
|
BEAST_PUBLIC_IN_DLL_BUILD (class Pimpl)
|
|
ScopedPointer<Pimpl> pimpl;
|
|
String currentPipeName;
|
|
ReadWriteLock lock;
|
|
|
|
bool openInternal (const String& pipeName, const bool createPipe);
|
|
};
|
|
|
|
|
|
#endif // BEAST_NAMEDPIPE_H_INCLUDED
|