107 lines
3.8 KiB
C
107 lines
3.8 KiB
C
|
/*
|
||
|
|
==============================================================================
|
||
|
|
|
||
|
|
This file is part of the JUCE library.
|
||
|
|
Copyright (c) 2020 - Raw Material Software Limited
|
||
|
|
|
||
|
|
JUCE is an open source library subject to commercial or open-source
|
||
|
|
licensing.
|
||
|
|
|
||
|
|
The code included in this file is provided under the terms of the ISC license
|
||
|
|
http://www.isc.org/downloads/software-support-policy/isc-license. 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.
|
||
|
|
|
||
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
||
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
||
|
|
DISCLAIMED.
|
||
|
|
|
||
|
|
==============================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace juce
|
||
|
|
{
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/**
|
||
|
|
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 InterprocessConnection
|
||
|
|
|
||
|
|
@tags{Events}
|
||
|
|
*/
|
||
|
|
class JUCE_API InterprocessConnectionServer : private Thread
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
//==============================================================================
|
||
|
|
/** Creates an uninitialised server object.
|
||
|
|
*/
|
||
|
|
InterprocessConnectionServer();
|
||
|
|
|
||
|
|
/** Destructor. */
|
||
|
|
~InterprocessConnectionServer() override;
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/** 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.
|
||
|
|
|
||
|
|
@param portNumber The port on which the server will receive
|
||
|
|
connections
|
||
|
|
@param 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 createConnectionObject, stop
|
||
|
|
*/
|
||
|
|
bool beginWaitingForSocket (int portNumber, const String& bindAddress = String());
|
||
|
|
|
||
|
|
/** Terminates the listener thread, if it's active.
|
||
|
|
|
||
|
|
@see beginWaitingForSocket
|
||
|
|
*/
|
||
|
|
void stop();
|
||
|
|
|
||
|
|
/** 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.
|
||
|
|
*/
|
||
|
|
int getBoundPort() const noexcept;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
/** 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 InterprocessConnection
|
||
|
|
*/
|
||
|
|
virtual InterprocessConnection* createConnectionObject() = 0;
|
||
|
|
|
||
|
|
private:
|
||
|
|
//==============================================================================
|
||
|
|
std::unique_ptr<StreamingSocket> socket;
|
||
|
|
|
||
|
|
void run() override;
|
||
|
|
|
||
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (InterprocessConnectionServer)
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace juce
|