cello_ipc.h

/*
    Copyright (c) 2023 Brett g Porter
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
 
#pragma once
 
#include <juce_events/juce_events.h>
 
#include "cello_object.h"
#include "cello_sync.h"
#include "cello_value.h"
 
namespace cello
{

struct IpcClientProperties : public Object
{
    IpcClientProperties (const juce::String& name, Object* state)
    : cello::Object (name + "IpcClient", state)
    {
    }
    MAKE_VALUE_MEMBER (bool, connected, false);
    MAKE_VALUE_MEMBER (int, rxCount, 0);
    MAKE_VALUE_MEMBER (int, txCount, 0);
};
 
//==============================================================================
 
class IpcClient : public juce::InterprocessConnection,
                  public juce::ValueTreeSynchroniser,
                  public UpdateQueue
{
public:
    enum UpdateType
    {
        send                = 0x01,
        receive             = 0x02,
        fullUpdateOnConnect = 0x04
    };
 
    enum ConnectOptions
    {
        noOptions,     
        createOrFail,  
        mustExist,     
        createIfNeeded 
    };

    IpcClient (Object& objectToWatch, const juce::String& hostName, int portNum, int msTimeout, UpdateType updateType,
               Object* state = nullptr);

    IpcClient (Object& objectToWatch, const juce::String& pipeName, int msTimeout, UpdateType updateType,
               Object* state = nullptr);
 
    ~IpcClient () override;

    bool connect (ConnectOptions option = ConnectOptions::noOptions);
 
private:
    friend class IpcServer;
    IpcClient (Object& objectToWatch, UpdateType updateType, const juce::String& hostName, int portNum,
               const juce::String& pipeName, int msTimeout, Object* state = nullptr);
 
    void connectionMade () override;
    void connectionLost () override;
    void messageReceived (const juce::MemoryBlock& message) override;

    void stateChanged (const void* encodedChange, size_t encodedSize) override;
 
private:
    IpcClientProperties clientProperties;

    UpdateType update;

    const juce::String host;
    const int port;
    const juce::String pipe;
    const int timeout;
};
 
//==============================================================================
 
enum IpcServerStatus
{
    unknown,        
    initialized,    
    startedOkay,    
    alreadyRunning, 
    errorStarting,  
    stoppedOkay,    
    alreadyStopped, 
    errorStopping   
};
 
struct IpcServerProperties : public Object
{
    IpcServerProperties (const juce::String& path, Object* state);
    void startServer (int portNum, const juce::String& address = juce::String ());

    void stopServer ();

    MAKE_VALUE_MEMBER (bool, running, false);

    MAKE_VALUE_MEMBER (IpcServerStatus, status, IpcServerStatus::unknown);

    MAKE_VALUE_MEMBER (int, portNumber, 0);

    MAKE_VALUE_MEMBER (juce::String, bindAddress, {});
};
 
//==============================================================================
 
class IpcServer : public juce::InterprocessConnectionServer
{
public:
    IpcServer (Object& sync, IpcClient::UpdateType updateType, const juce::String& statePath, Object* state = nullptr);
    ~IpcServer () override;

    bool startServer (int portNumber, const juce::String& bindAddress = juce::String ());

    bool stopServer ();
 
protected:
    juce::InterprocessConnection* createConnectionObject () override;
 
private:
    Object& syncObject;

    IpcClient::UpdateType update;

    std::vector<std::unique_ptr<juce::InterprocessConnection>> connections;

    IpcServerProperties serverProperties;
};
 
} // namespace cello