An object that waits for client sockets to connect to a port on this host, and creates InterprocessConnection objects for each one. More...

#include <juce_InterprocessConnectionServer.h>

Inheritance diagram for juce::InterprocessConnectionServer:

[legend]

Collaboration diagram for juce::InterprocessConnectionServer:

[legend]

Public Member Functions
	InterprocessConnectionServer ()
	Creates an uninitialised server object.

	~InterprocessConnectionServer () override
	Destructor.

bool	beginWaitingForSocket (int portNumber, const String &bindAddress=String())
	Starts an internal thread which listens on the given port number.

int	getBoundPort () const noexcept
	Returns the local port number to which this server is currently bound.

void	stop ()
	Terminates the listener thread, if it's active.

Protected Member Functions
virtual InterprocessConnection *	createConnectionObject ()=0
	Creates a suitable connection object for a client process that wants to connect to this one.

Private Types
enum class	Priority { highest = 2 , high = 1 , normal = 0 , low = -1 , background = -2 }
	The different runtime priorities of non-realtime threads. More...

using	ThreadID = void *
	A value type used for thread IDs.

Private Member Functions
void	addListener (Listener *)
	Add a listener to this thread which will receive a callback when signalThreadShouldExit was called on this thread.

void	closeThreadHandle ()

bool	createNativeThread (Priority)

Priority	getPriority () const
	Returns the current priority of this thread.

ThreadID	getThreadId () const noexcept
	Returns the ID of this thread.

const String &	getThreadName () const noexcept
	Returns the name of the thread.

bool	isRealtime () const
	Returns true if this Thread represents a realtime thread.

bool	isThreadRunning () const
	Returns true if the thread is currently active.

void	killThread ()

void	notify () const
	Wakes up the thread.

void	removeListener (Listener *)
	Removes a listener added with addListener.

void	run () override
	Must be implemented to perform the thread's actual code.

void	setAffinityMask (uint32 affinityMask)
	Sets the affinity mask for the thread.

bool	setPriority (Priority newPriority)
	Attempts to set the priority for this thread.

void	signalThreadShouldExit ()
	Sets a flag to tell the thread it should stop.

bool	startRealtimeThread (const RealtimeOptions &options)
	Starts the thread with realtime performance characteristics on platforms that support it.

bool	startThread ()
	Attempts to start a new thread with default ('Priority::normal') priority.

bool	startThread (Priority newPriority)
	Attempts to start a new thread with a given priority.

bool	startThreadInternal (Priority)

bool	stopThread (int timeOutMilliseconds)
	Attempts to stop the thread running.

void	threadEntryPoint ()

bool	threadShouldExit () const
	Checks whether the thread has been told to stop running.

bool	wait (double timeOutMilliseconds) const
	Suspends the execution of this thread until either the specified timeout period has elapsed, or another thread calls the notify() method to wake it up.

bool	waitForThreadToExit (int timeOutMilliseconds) const
	Waits for the thread to stop.

Static Private Member Functions
static bool	currentThreadShouldExit ()
	Checks whether the current thread has been told to stop running.

static Thread *	getCurrentThread ()
	Finds the thread object that is currently running.

static ThreadID	getCurrentThreadId ()
	Returns an id that identifies the caller thread.

static void	initialiseJUCE (void jniEnv, void jContext)
	Initialises the JUCE subsystem for projects not created by the Projucer.

static bool	launch (Priority priority, std::function< void()> functionToRun)
	Invokes a lambda or function on its own thread with a custom priority.

static bool	launch (std::function< void()> functionToRun)
	Invokes a lambda or function on its own thread with the default priority.

static void	setCurrentThreadAffinityMask (uint32 affinityMask)
	Changes the affinity mask for the caller thread.

static void	setCurrentThreadName (const String &newThreadName)
	Changes the name of the caller thread.

static void	sleep (int milliseconds)
	Suspends the execution of the current thread until the specified timeout period has elapsed (note that this may not be exact).

static void	yield ()
	Yields the current thread's CPU time-slot and allows a new thread to run.

Private Attributes
uint32	affinityMask = 0

WaitableEvent	defaultEvent

bool	deleteOnThreadEnd = false

ThreadSafeListenerList< Listener >	listeners

std::atomic< Priority >	priority

std::optional< RealtimeOptions >	realtimeOptions = {}

std::atomic< bool >	shouldExit { false }

std::unique_ptr< StreamingSocket >	socket

CriticalSection	startStopLock

WaitableEvent	startSuspensionEvent

std::atomic< void * >	threadHandle { nullptr }

std::atomic< ThreadID >	threadId { nullptr }

const String	threadName

size_t	threadStackSize

Static Private Attributes
static constexpr size_t	osDefaultStackSize { 0 }

Detailed Description

An object that waits for client sockets to connect to a port on this host, and creates InterprocessConnection objects for each one.

To use this, create a class derived from it which implements the createConnectionObject() method, so that it creates suitable connection objects for each client that tries to connect.

See also: InterprocessConnection

@tags{Events}

Member Typedef Documentation

◆ ThreadID

using juce::Thread::ThreadID = void*

inherited

A value type used for thread IDs.

See also: getCurrentThreadId(), getThreadId()

Member Enumeration Documentation

◆ Priority

enum class juce::Thread::Priority

stronginherited

The different runtime priorities of non-realtime threads.

See also: startThread

Enumerator
highest	The highest possible priority that isn't a dedicated realtime thread.
high	Makes use of performance cores and higher clocks.
normal	The OS default. It will balance out across all cores.
low	Uses efficiency cores when possible.
background	Restricted to efficiency cores on platforms that have them.

Constructor & Destructor Documentation

◆ InterprocessConnectionServer()

juce::InterprocessConnectionServer::InterprocessConnectionServer ( )

Creates an uninitialised server object.

◆ ~InterprocessConnectionServer()

juce::InterprocessConnectionServer::~InterprocessConnectionServer ( )

override

Destructor.

Member Function Documentation

◆ addListener()

void juce::Thread::addListener ( Listener * )

inherited

Add a listener to this thread which will receive a callback when signalThreadShouldExit was called on this thread.

See also: signalThreadShouldExit, removeListener

◆ beginWaitingForSocket()

bool juce::InterprocessConnectionServer::beginWaitingForSocket	(	int	portNumber,
		const String &	bindAddress = `String()`
	)

Starts an internal thread which listens on the given port number.

While this is running, if another process tries to connect with the InterprocessConnection::connectToSocket() method, this object will call createConnectionObject() to create a connection to that client.

Use stop() to stop the thread running.

Parameters

portNumber	The port on which the server will receive connections
bindAddress	The address on which the server will listen for connections. An empty string indicates that it should listen on all addresses assigned to this machine.

See also: createConnectionObject, stop

◆ closeThreadHandle()

void juce::Thread::closeThreadHandle ( )

privateinherited

References juce::Thread::threadHandle, and juce::Thread::threadId.

◆ createConnectionObject()

virtual InterprocessConnection * juce::InterprocessConnectionServer::createConnectionObject ( )

protectedpure virtual

Creates a suitable connection object for a client process that wants to connect to this one.

This will be called by the listener thread when a client process tries to connect, and must return a new InterprocessConnection object that will then run as this end of the connection.

See also: InterprocessConnection

◆ createNativeThread()

bool juce::Thread::createNativeThread ( Priority )

privateinherited

◆ currentThreadShouldExit()

static bool juce::Thread::currentThreadShouldExit ( )

staticinherited

Checks whether the current thread has been told to stop running.

On the message thread, this will always return false, otherwise it will return threadShouldExit() called on the current thread.

See also: threadShouldExit

◆ getBoundPort()

int juce::InterprocessConnectionServer::getBoundPort ( ) const

noexcept

Returns the local port number to which this server is currently bound.

This is useful if you need to know to which port the OS has actually bound your socket when calling beginWaitingForSocket with a port number of zero.

Returns -1 if the function fails.

◆ getCurrentThread()

static Thread * juce::Thread::getCurrentThread ( )

staticinherited

Finds the thread object that is currently running.

Note that the main UI thread (or other non-JUCE threads) don't have a Thread object associated with them, so this will return nullptr.

◆ getCurrentThreadId()

Thread::ThreadID juce::Thread::getCurrentThreadId ( )

staticinherited

Returns an id that identifies the caller thread.

To find the ID of a particular thread object, use getThreadId().

Returns: a unique identifier that identifies the calling thread.

See also: getThreadId

Referenced by juce::ThreadLocalValue< Type >::get(), and juce::ThreadLocalValue< Type >::releaseCurrentThreadStorage().

◆ getPriority()

Priority juce::Thread::getPriority ( ) const

protectedinherited

Returns the current priority of this thread.

This can only be called from the target thread. Doing so from another thread will cause an assert.

See also: setPriority

◆ getThreadId()

ThreadID juce::Thread::getThreadId ( ) const

noexceptinherited

Returns the ID of this thread.

That means the ID of this thread object - not of the thread that's calling the method. This can change when the thread is started and stopped, and will be invalid if the thread's not actually running.

See also: getCurrentThreadId

◆ getThreadName()

const String & juce::Thread::getThreadName ( ) const

inlinenoexceptinherited

Returns the name of the thread.

This is the name that gets set in the constructor.

◆ initialiseJUCE()

static void juce::Thread::initialiseJUCE	(	void *	jniEnv,
		void *	jContext
	)

staticinherited

Initialises the JUCE subsystem for projects not created by the Projucer.

On Android, JUCE needs to be initialised once before it is used. The Projucer will automatically generate the necessary java code to do this. However, if you are using JUCE without the Projucer or are creating a library made with JUCE intended for use in non-JUCE apks, then you must call this method manually once on apk startup.

You can call this method from C++ or directly from java by calling the following java method:

com.rmsl.juce.Java.initialiseJUCE (myContext);

Note that the above java method is only available in Android Studio projects created by the Projucer. If you need to call this from another type of project then you need to add the following java file to your project:

package com.rmsl.juce;
 
public class Java
{
    static { System.loadLibrary ("juce_jni"); }
    public native static void initialiseJUCE (Context context);
}

Parameters

jniEnv	this is a pointer to JNI's JNIEnv variable. Any callback from Java into C++ will have this passed in as it's first parameter.
jContext	this is a jobject referring to your app/service/receiver/ provider's Context. JUCE needs this for many of it's internal functions.

◆ isRealtime()

bool juce::Thread::isRealtime ( ) const

inherited

Returns true if this Thread represents a realtime thread.

◆ isThreadRunning()

bool juce::Thread::isThreadRunning ( ) const

inherited

Returns true if the thread is currently active.

Referenced by juce::detail::MessageThread::isRunning().

◆ killThread()

void juce::Thread::killThread ( )

privateinherited

◆ launch() [1/2]

static bool juce::Thread::launch	(	Priority	priority,
		std::function< void()>	functionToRun
	)

staticinherited

Invokes a lambda or function on its own thread with a custom priority.

This will spin up a Thread object which calls the function and then exits. Bear in mind that starting and stopping a thread can be a fairly heavyweight operation, so you might prefer to use a ThreadPool if you're kicking off a lot of short background tasks.

Also note that using an anonymous thread makes it very difficult to interrupt the function when you need to stop it, e.g. when your app quits. So it's up to you to deal with situations where the function may fail to stop in time.

Parameters

priority	The priority the thread is started with.
functionToRun	The lambda to be called from the new Thread.

Returns: true if the thread started successfully, or false if it failed.

◆ launch() [2/2]

static bool juce::Thread::launch ( std::function< void()> functionToRun )

staticinherited

Invokes a lambda or function on its own thread with the default priority.

This will spin up a Thread object which calls the function and then exits. Bear in mind that starting and stopping a thread can be a fairly heavyweight operation, so you might prefer to use a ThreadPool if you're kicking off a lot of short background tasks.

Also note that using an anonymous thread makes it very difficult to interrupt the function when you need to stop it, e.g. when your app quits. So it's up to you to deal with situations where the function may fail to stop in time.

Parameters

functionToRun The lambda to be called from the new Thread.

Returns: true if the thread started successfully, or false if it failed.

See also: launch.

◆ notify()

void juce::Thread::notify ( ) const

inherited

Wakes up the thread.

If the thread has called the wait() method, this will wake it up.

See also: wait

◆ removeListener()

void juce::Thread::removeListener ( Listener * )

inherited

Removes a listener added with addListener.

◆ run()

void juce::InterprocessConnectionServer::run ( )

overrideprivatevirtual

Must be implemented to perform the thread's actual code.

Remember that the thread must regularly check the threadShouldExit() method whilst running, and if this returns true it should return from the run() method as soon as possible to avoid being forcibly killed.

See also: threadShouldExit, startThread

Implements juce::Thread.

◆ setAffinityMask()

void juce::Thread::setAffinityMask ( uint32 affinityMask )

inherited

Sets the affinity mask for the thread.

This will only have an effect next time the thread is started - i.e. if the thread is already running when called, it'll have no effect.

See also: setCurrentThreadAffinityMask

◆ setCurrentThreadAffinityMask()

void juce::Thread::setCurrentThreadAffinityMask ( uint32 affinityMask )

staticinherited

Changes the affinity mask for the caller thread.

This will change the affinity mask for the thread that calls this static method.

See also: setAffinityMask

References juce::Thread::affinityMask, jassertfalse, JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE, and JUCE_END_IGNORE_WARNINGS_GCC_LIKE.

◆ setCurrentThreadName()

void juce::Thread::setCurrentThreadName ( const String & newThreadName )

staticinherited

Changes the name of the caller thread.

Different OSes may place different length or content limits on this name.

References JUCE_AUTORELEASEPOOL.

◆ setPriority()

bool juce::Thread::setPriority ( Priority newPriority )

protectedinherited

Attempts to set the priority for this thread.

Returns true if the new priority was set successfully, false if not.

This can only be called from the target thread. Doing so from another thread will cause an assert.

Parameters

newPriority The new priority to be applied to the thread. Note: This has no effect on Linux platforms, subsequent calls to 'getPriority' will return this value.

See also: Priority

◆ signalThreadShouldExit()

void juce::Thread::signalThreadShouldExit ( )

inherited

Sets a flag to tell the thread it should stop.

Calling this means that the threadShouldExit() method will then return true. The thread should be regularly checking this to see whether it should exit.

If your thread makes use of wait(), you might want to call notify() after calling this method, to interrupt any waits that might be in progress, and allow it to reach a point where it can exit.

See also: threadShouldExit, waitForThreadToExit

Referenced by juce::detail::MessageThread::stop().

◆ sleep()

void juce::Thread::sleep ( int milliseconds )

staticinherited

Suspends the execution of the current thread until the specified timeout period has elapsed (note that this may not be exact).

The timeout period must not be negative and whilst sleeping the thread cannot be woken up so it should only be used for short periods of time and when other methods such as using a WaitableEvent or CriticalSection are not possible.

Referenced by juce::OpenGLContext::NativeContext::getNativeWindowFromSurfaceHolder(), juce::detail::MessageThread::run(), and juce::OpenGLContext::NativeContext::swapBuffers().

◆ startRealtimeThread()

bool juce::Thread::startRealtimeThread ( const RealtimeOptions & options )

inherited

Starts the thread with realtime performance characteristics on platforms that support it.

You cannot change the options of a running realtime thread, nor switch a non-realtime thread to a realtime thread. To make these changes you must first stop the thread and then restart with different options.

Parameters

options Realtime options the thread should be created with.

See also: startThread, RealtimeOptions

◆ startThread() [1/2]

bool juce::Thread::startThread ( )

inherited

Attempts to start a new thread with default ('Priority::normal') priority.

This will cause the thread's run() method to be called by a new thread. If this thread is already running, startThread() won't do anything.

If a thread cannot be created with the requested priority, this will return false and Thread::run() will not be called. An exception to this is the Android platform, which always starts a thread and attempts to upgrade the thread after creation.

Returns: true if the thread started successfully. false if it was unsuccessful.

See also: stopThread

Referenced by juce::detail::MessageThread::start().

◆ startThread() [2/2]

bool juce::Thread::startThread ( Priority newPriority )

inherited

Attempts to start a new thread with a given priority.

This will cause the thread's run() method to be called by a new thread. If this thread is already running, startThread() won't do anything.

If a thread cannot be created with the requested priority, this will return false and Thread::run() will not be called. An exception to this is the Android platform, which always starts a thread and attempts to upgrade the thread after creation.

Parameters

newPriority Priority the thread should be assigned. This parameter is ignored on Linux.

Returns: true if the thread started successfully, false if it was unsuccesful.

See also: startThread, setPriority, startRealtimeThread

◆ startThreadInternal()

bool juce::Thread::startThreadInternal ( Priority )

privateinherited

◆ stop()

void juce::InterprocessConnectionServer::stop ( )

Terminates the listener thread, if it's active.

See also: beginWaitingForSocket

◆ stopThread()

bool juce::Thread::stopThread ( int timeOutMilliseconds )

inherited

Attempts to stop the thread running.

This method will cause the threadShouldExit() method to return true and call notify() in case the thread is currently waiting.

Hopefully the thread will then respond to this by exiting cleanly, and the stopThread method will wait for a given time-period for this to happen.

If the thread is stuck and fails to respond after the timeout, it gets forcibly killed, which is a very bad thing to happen, as it could still be holding locks, etc. which are needed by other parts of your program.

Parameters

timeOutMilliseconds The number of milliseconds to wait for the thread to finish before killing it by force. A negative value in here will wait forever.

Returns: true if the thread was cleanly stopped before the timeout, or false if it had to be killed by force.

See also: signalThreadShouldExit, threadShouldExit, waitForThreadToExit, isThreadRunning

Referenced by juce::detail::MessageThread::stop().

◆ threadEntryPoint()

void juce::Thread::threadEntryPoint ( )

privateinherited

◆ threadShouldExit()

bool juce::Thread::threadShouldExit ( ) const

inherited

Checks whether the thread has been told to stop running.

Threads need to check this regularly, and if it returns true, they should return from their run() method at the first possible opportunity.

See also: signalThreadShouldExit, currentThreadShouldExit

Referenced by juce::detail::MessageThread::run().

◆ wait()

bool juce::Thread::wait ( double timeOutMilliseconds ) const

inherited

Suspends the execution of this thread until either the specified timeout period has elapsed, or another thread calls the notify() method to wake it up.

A negative timeout value means that the method will wait indefinitely.

Returns: true if the event has been signalled, false if the timeout expires.

◆ waitForThreadToExit()

bool juce::Thread::waitForThreadToExit ( int timeOutMilliseconds ) const

inherited

Waits for the thread to stop.

This will wait until isThreadRunning() is false or until a timeout expires.

Parameters

timeOutMilliseconds the time to wait, in milliseconds. If this value is less than zero, it will wait forever.

Returns: true if the thread exits, or false if the timeout expires first.

◆ yield()

void juce::Thread::yield ( )

staticinherited

Yields the current thread's CPU time-slot and allows a new thread to run.

If there are no other threads of equal or higher priority currently running then this will return immediately and the current thread will continue to run.

Member Data Documentation

◆ affinityMask

uint32 juce::Thread::affinityMask = 0

privateinherited

Referenced by juce::Thread::setCurrentThreadAffinityMask().

◆ defaultEvent

WaitableEvent juce::Thread::defaultEvent

privateinherited

◆ deleteOnThreadEnd

bool juce::Thread::deleteOnThreadEnd = false

privateinherited

◆ listeners

ThreadSafeListenerList<Listener> juce::Thread::listeners

privateinherited

◆ osDefaultStackSize

constexpr size_t juce::Thread::osDefaultStackSize { 0 }

staticconstexprinherited

◆ priority

std::atomic<Priority> juce::Thread::priority

privateinherited

◆ realtimeOptions

std::optional<RealtimeOptions> juce::Thread::realtimeOptions = {}

privateinherited

◆ shouldExit

std::atomic<bool> juce::Thread::shouldExit { false }

privateinherited

◆ socket

std::unique_ptr<StreamingSocket> juce::InterprocessConnectionServer::socket

private

◆ startStopLock

CriticalSection juce::Thread::startStopLock

privateinherited

◆ startSuspensionEvent

WaitableEvent juce::Thread::startSuspensionEvent

privateinherited

◆ threadHandle

std::atomic<void*> juce::Thread::threadHandle { nullptr }

privateinherited

Referenced by juce::Thread::closeThreadHandle().

◆ threadId

std::atomic<ThreadID> juce::Thread::threadId { nullptr }

privateinherited

Referenced by juce::Thread::closeThreadHandle().

◆ threadName

const String juce::Thread::threadName

privateinherited

◆ threadStackSize

size_t juce::Thread::threadStackSize

privateinherited

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

juce_InterprocessConnectionServer.h

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ThreadID

Member Enumeration Documentation

◆ Priority

Constructor & Destructor Documentation

◆ InterprocessConnectionServer()

◆ ~InterprocessConnectionServer()

Member Function Documentation

◆ addListener()

◆ beginWaitingForSocket()

◆ closeThreadHandle()

◆ createConnectionObject()

◆ createNativeThread()

◆ currentThreadShouldExit()

◆ getBoundPort()

◆ getCurrentThread()

◆ getCurrentThreadId()

◆ getPriority()

◆ getThreadId()

◆ getThreadName()

◆ initialiseJUCE()

◆ isRealtime()

◆ isThreadRunning()

◆ killThread()

◆ launch() [1/2]

◆ launch() [2/2]

◆ notify()

◆ removeListener()

◆ run()

◆ setAffinityMask()

◆ setCurrentThreadAffinityMask()

◆ setCurrentThreadName()

◆ setPriority()

◆ signalThreadShouldExit()

◆ sleep()

◆ startRealtimeThread()

◆ startThread() [1/2]

◆ startThread() [2/2]

◆ startThreadInternal()

◆ stop()

◆ stopThread()

◆ threadEntryPoint()

◆ threadShouldExit()

◆ wait()

◆ waitForThreadToExit()

◆ yield()

Member Data Documentation

◆ affinityMask

◆ defaultEvent

◆ deleteOnThreadEnd

◆ listeners

◆ osDefaultStackSize

◆ priority

◆ realtimeOptions

◆ shouldExit

◆ socket

◆ startStopLock

◆ startSuspensionEvent

◆ threadHandle

◆ threadId

◆ threadName

◆ threadStackSize