asyncnotification.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_COMPHELPER_ASYNCNOTIFICATION_HXX
#define INCLUDED_COMPHELPER_ASYNCNOTIFICATION_HXX
 
#include <sal/config.h>
 
#include <comphelper/comphelperdllapi.h>
#include <rtl/ref.hxx>
#include <sal/types.h>
#include <salhelper/thread.hxx>
#include <salhelper/simplereferenceobject.hxx>
#include <memory>
#include <utility>
 
namespace comphelper
{
    //= AnyEvent
 
    class COMPHELPER_DLLPUBLIC AnyEvent : public salhelper::SimpleReferenceObject
    {
    public:
        AnyEvent();
 
    protected:
        virtual ~AnyEvent() override;
 
    private:
        AnyEvent( AnyEvent const & ) = delete;
        AnyEvent& operator=( AnyEvent const & ) = delete;
    };
 
 
    //= typedefs
 
    typedef ::rtl::Reference< AnyEvent >    AnyEventRef;
 
 
    //= IEventProcessor
 
    class SAL_NO_VTABLE IEventProcessor
    {
    public:
        virtual void processEvent( const AnyEvent& _rEvent ) = 0;
 
        virtual void SAL_CALL acquire() noexcept = 0;
        virtual void SAL_CALL release() noexcept = 0;
 
    protected:
        ~IEventProcessor() {}
    };
 
 
    //= AsyncEventNotifier
 
    struct EventNotifierImpl;
 
    class COMPHELPER_DLLPUBLIC AsyncEventNotifierBase
    {
        friend struct EventNotifierImpl;
 
    protected:
        std::unique_ptr<EventNotifierImpl>        m_xImpl;
 
        SAL_DLLPRIVATE virtual ~AsyncEventNotifierBase();
 
        // Thread
        SAL_DLLPRIVATE virtual void execute();
 
    public:
        AsyncEventNotifierBase();
 
        virtual void SAL_CALL terminate();
 
        void addEvent( const AnyEventRef& _rEvent, const ::rtl::Reference< IEventProcessor >& _xProcessor );
 
        void removeEventsForProcessor( const ::rtl::Reference< IEventProcessor >& _xProcessor );
    };
 
    class COMPHELPER_DLLPUBLIC AsyncEventNotifier final
        : public AsyncEventNotifierBase
        , public salhelper::Thread
    {
 
    private:
        SAL_DLLPRIVATE virtual ~AsyncEventNotifier() override;
 
        SAL_DLLPRIVATE virtual void execute() override;
 
    public:
        AsyncEventNotifier(char const* name);
 
        virtual void SAL_CALL terminate() override;
    };
 
    class COMPHELPER_DLLPUBLIC AsyncEventNotifierAutoJoin final
        : public AsyncEventNotifierBase
        , private osl::Thread
    {
 
    private:
        SAL_DLLPRIVATE AsyncEventNotifierAutoJoin(char const* name);
 
        SAL_DLLPRIVATE virtual void SAL_CALL run() override;
        SAL_DLLPRIVATE virtual void SAL_CALL onTerminated() override;
 
    public:
        // only public so shared_ptr finds it
        SAL_DLLPRIVATE virtual ~AsyncEventNotifierAutoJoin() override;
 
        static std::shared_ptr<AsyncEventNotifierAutoJoin>
            newAsyncEventNotifierAutoJoin(char const* name);
 
        virtual void SAL_CALL terminate() override;
 
        using osl::Thread::join;
        using osl::Thread::operator new;
        using osl::Thread::operator delete; // clang really wants this?
 
        static void launch(std::shared_ptr<AsyncEventNotifierAutoJoin> const&);
    };
 
 
    //= EventHolder
 
    template < typename EVENT_OBJECT >
    class SAL_DLLPUBLIC_RTTI EventHolder final : public AnyEvent
    {
    public:
        typedef EVENT_OBJECT    EventObjectType;
 
    private:
        EventObjectType const m_aEvent;
 
    public:
        EventHolder( EventObjectType _aEvent )
            :m_aEvent(std::move( _aEvent ))
        {
        }
 
        const EventObjectType& getEventObject() const { return m_aEvent; }
    };
 
    COMPHELPER_DLLPUBLIC void JoinAsyncEventNotifiers();
 
} // namespace comphelper
 
 
#endif // INCLUDED_COMPHELPER_ASYNCNOTIFICATION_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */