OpenShot Library | OpenShotAudio
0.2.2
|
A cross-process pipe that can have data written to and read from it. More...
#include <juce_NamedPipe.h>
Public Member Functions | |
NamedPipe () | |
Creates a NamedPipe. | |
~NamedPipe () | |
Destructor. | |
bool | openExisting (const String &pipeName) |
Tries to open a pipe that already exists. More... | |
bool | createNewPipe (const String &pipeName, bool mustNotExist=false) |
Tries to create a new pipe. More... | |
void | close () |
Closes the pipe, if it's open. | |
bool | isOpen () const |
True if the pipe is currently open. | |
String | getName () const |
Returns the last name that was used to try to open this pipe. | |
int | read (void *destBuffer, int maxBytesToRead, int timeOutMilliseconds) |
Reads data from the pipe. More... | |
int | write (const void *sourceBuffer, int numBytesToWrite, int timeOutMilliseconds) |
Writes some data to the pipe. More... | |
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.
Definition at line 40 of file juce_NamedPipe.h.
bool juce::NamedPipe::openExisting | ( | const String & | pipeName | ) |
Tries to open a pipe that already exists.
Returns true if it succeeds.
Definition at line 33 of file juce_NamedPipe.cpp.
References close().
bool juce::NamedPipe::createNewPipe | ( | const String & | pipeName, |
bool | mustNotExist = false |
||
) |
Tries to create a new pipe.
Returns true if it succeeds. If mustNotExist is true then it will fail if a pipe is already open with the same name.
Definition at line 47 of file juce_NamedPipe.cpp.
References close().
int juce::NamedPipe::read | ( | void * | destBuffer, |
int | maxBytesToRead, | ||
int | timeOutMilliseconds | ||
) |
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 juce::NamedPipe::write | ( | const void * | sourceBuffer, |
int | numBytesToWrite, | ||
int | timeOutMilliseconds | ||
) |
Writes some data to the pipe.