Inheritance diagram for cello::IpcClient:

Public Types
enum	UpdateType { send = 0x01 , receive = 0x02 , fullUpdateOnConnect = 0x04 }

enum	ConnectOptions { noOptions , createOrFail , mustExist , createIfNeeded }

Public Member Functions
	IpcClient (Object &objectToWatch, const juce::String &hostName, int portNum, int msTimeout, UpdateType updateType, Object *state=nullptr)
	Construct a new Ipc Client object that connects using sockets.

	IpcClient (Object &objectToWatch, const juce::String &pipeName, int msTimeout, UpdateType updateType, Object *state=nullptr)
	Construct a new Ipc Client object using a named pipe.

bool	connect (ConnectOptions option=ConnectOptions::noOptions)
	Attempt to make a connection to another IpcClient running in another process.

Public Member Functions inherited from cello::UpdateQueue
	UpdateQueue (Object &consumer, juce::Thread *thread)

	UpdateQueue (const UpdateQueue &)=delete

UpdateQueue &	operator= (const UpdateQueue &)=delete

	UpdateQueue (UpdateQueue &&)=delete

UpdateQueue &	operator= (UpdateQueue &&)=delete

int	getPendingUpdateCount () const

void	performAllUpdates ()
	Execute each of the updates that are ready.

void	performNextUpdate ()
	Pop the next event from the queue and apply the change to the destination value tree.

bool	isDestinationThread (juce::Thread *thread) const
	Check if the given thread is the destination thread for this update queue.

Additional Inherited Members
Protected Member Functions inherited from cello::UpdateQueue
void	pushUpdate (juce::MemoryBlock &&update)

Member Enumeration Documentation

◆ ConnectOptions

Enumerator
noOptions	default, used for sockets, which have no options.
createOrFail	create the pipe, fail if we couldn't
mustExist	pipe must already exist, fail if it doesn't
createIfNeeded	If pipe exists, use it, otherwise create.

Construct a new Ipc Client object that connects using sockets.

Parameters

objectToWatch	Local object to connect over IPC
hostName	hostname of the machine running an IpcServer
portNum	port number on the host
msTimeout
updateType	see UpdateType
state	parent object to contain our IpcClientProperties object.

Construct a new Ipc Client object using a named pipe.

Parameters

objectToWatch	Local object to connect over IPC
pipeName	name of the pipe to use
msTimeout	timeout, -1 == wait forever.
updateType	see UpdateType
state	parent object to contain our IpcClientProperties object.

bool cello::IpcClient::connect ( ConnectOptions option = ConnectOptions::noOptions )

Attempt to make a connection to another IpcClient running in another process.

Parameters

option Only meaningful when connecting to a named pipe.

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