openshot-audio  0.1.2
Classes | Public Member Functions | List of all members
NamedPipe Class Reference

#include <juce_NamedPipe.h>

Classes

class  Pimpl
 

Public Member Functions

 NamedPipe ()
 
 ~NamedPipe ()
 
bool openExisting (const String &pipeName)
 
bool createNewPipe (const String &pipeName)
 
void close ()
 
bool isOpen () const
 
String getName () const
 
int read (void *destBuffer, int maxBytesToRead, int timeOutMilliseconds)
 
int write (const void *sourceBuffer, int numBytesToWrite, int timeOutMilliseconds)
 

Detailed Description

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 also
InterprocessConnection

Constructor & Destructor Documentation

◆ NamedPipe()

NamedPipe::NamedPipe ( )

Creates a NamedPipe.

◆ ~NamedPipe()

NamedPipe::~NamedPipe ( )

Destructor.

Member Function Documentation

◆ close()

void NamedPipe::close ( )

Closes the pipe, if it's open.

◆ createNewPipe()

bool NamedPipe::createNewPipe ( const String pipeName)

Tries to create a new pipe. Returns true if it succeeds.

◆ getName()

String NamedPipe::getName ( ) const

Returns the last name that was used to try to open this pipe.

◆ isOpen()

bool NamedPipe::isOpen ( ) const

True if the pipe is currently open.

◆ openExisting()

bool NamedPipe::openExisting ( const String pipeName)

Tries to open a pipe that already exists. Returns true if it succeeds.

◆ read()

int 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.

◆ write()

int NamedPipe::write ( const void *  sourceBuffer,
int  numBytesToWrite,
int  timeOutMilliseconds 
)

Writes some data to the pipe.

Returns
the number of bytes written, or -1 on failure.

The documentation for this class was generated from the following files: