juce_OSCReceiver.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   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
{
 
//==============================================================================
class JUCE_API  OSCReceiver
{
public:
    //==============================================================================
    OSCReceiver();
 
    OSCReceiver (const String& threadName);
 
    ~OSCReceiver();
 
    //==============================================================================
    bool connect (int portNumber);
 
    bool connectToSocket (DatagramSocket& socketToUse);
 
    //==============================================================================
    bool disconnect();
 
 
    //==============================================================================
    struct JUCE_API  MessageLoopCallback {};
 
    struct JUCE_API  RealtimeCallback {};
 
    //==============================================================================
    template <typename CallbackType = MessageLoopCallback>
    class JUCE_API  Listener
    {
    public:
        virtual ~Listener() = default;
 
        virtual void oscMessageReceived (const OSCMessage& message) = 0;
 
        virtual void oscBundleReceived (const OSCBundle& /*bundle*/) {}
    };
 
    //==============================================================================
    template <typename CallbackType = MessageLoopCallback>
    class JUCE_API  ListenerWithOSCAddress
    {
    public:
        virtual ~ListenerWithOSCAddress() = default;
 
        virtual void oscMessageReceived (const OSCMessage& message) = 0;
    };
 
    //==============================================================================
    void addListener (Listener<MessageLoopCallback>* listenerToAdd);
 
    void addListener (Listener<RealtimeCallback>* listenerToAdd);
 
    void addListener (ListenerWithOSCAddress<MessageLoopCallback>* listenerToAdd,
                      OSCAddress addressToMatch);
 
    void addListener (ListenerWithOSCAddress<RealtimeCallback>* listenerToAdd,
                      OSCAddress addressToMatch);
 
    void removeListener (Listener<MessageLoopCallback>* listenerToRemove);
 
    void removeListener (Listener<RealtimeCallback>* listenerToRemove);
 
    void removeListener (ListenerWithOSCAddress<MessageLoopCallback>* listenerToRemove);
 
    void removeListener (ListenerWithOSCAddress<RealtimeCallback>* listenerToRemove);
 
    //==============================================================================
    using FormatErrorHandler = std::function<void (const char* data, int dataSize)>;
 
    void registerFormatErrorHandler (FormatErrorHandler handler);
 
private:
    //==============================================================================
    struct Pimpl;
    std::unique_ptr<Pimpl> pimpl;
    friend struct OSCReceiverCallbackMessage;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (OSCReceiver)
};
 
} // namespace juce