libreoffice/sw/source/uibase/inc/maildispatcher.hxx

/* -*- 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_SW_SOURCE_UIBASE_INC_MAILDISPATCHER_HXX
#define INCLUDED_SW_SOURCE_UIBASE_INC_MAILDISPATCHER_HXX

#include <com/sun/star/mail/XSmtpService.hpp>
#include <com/sun/star/mail/XMailMessage.hpp>
#include <osl/thread.hxx>
#include <osl/conditn.hxx>
#include <rtl/ref.hxx>
#include <salhelper/simplereferenceobject.hxx>

#include <list>
#include <vector>

#include <swdllapi.h>

class IMailDispatcherListener;

/**
    A MailDispatcher should be used for sending a bunch a mail messages
    asynchronously. Usually a client enqueues a number of mail messages
    and then calls start to begin sending them. An instance of this class
    must not be shared among different client threads. Instead each client
    thread should create an own instance of this class.
*/
class SW_DLLPUBLIC MailDispatcher final : public salhelper::SimpleReferenceObject,
                                          private ::osl::Thread
{
public:
    // bringing operator new/delete into scope
    using osl::Thread::operator new;
    using osl::Thread::operator delete;
    using osl::Thread::join;

    /**
        @param xSmtpService
        [in] a reference to a mail server. A user must be
        connected to the mail server otherwise errors occur
        during the delivery of mail messages.

        @throws css::uno::RuntimeException
        on errors during construction of an instance of this class.
    */
    MailDispatcher(css::uno::Reference<css::mail::XSmtpService> xMailService);

    /**
        Shutdown the mail dispatcher. Every mail messages
        not yet sent will be discarded.
    */
    virtual ~MailDispatcher() override;

    /**
        Enqueue a mail message for delivery. A client must
        start the mail dispatcher in order to send the
        enqueued mail messages.

        @param xMailMessage
        [in] a mail message that should be send.
    */
    void enqueueMailMessage(css::uno::Reference<css::mail::XMailMessage> const& xMailMessage);
    /**
        Dequeues a mail message.
        This enables the caller to remove attachments when sending mails is to be cancelled.
    */
    css::uno::Reference<css::mail::XMailMessage> dequeueMailMessage();

    /**
        Start sending mail messages asynchronously. A client may register
        a listener for mail dispatcher events. For every mail message sent
        the notification will be sent. While handling such notification a
        client may enqueue new mail messages. If there are no more mail
        messages to send a respective notification is sent and the mail
        dispatcher waits for more mail messages.

        @precond not isStarted()
    */
    void start();

    /**
        Stop sending mail messages.

        @precond isStarted()
    */
    void stop();

    /**
        Request shutdown of the mail dispatcher thread.
        NOTE: You must call this method before you release
        your last reference to this class otherwise the
        mail dispatcher thread will never end.
    */
    void shutdown();

    /**
        Check whether the mail dispatcher is started or not.

        @return
        <TRUE/> if the sending thread is running.
    */
    bool isStarted() const { return m_bActive; }

    /** returns if the thread is still running
    */
    using osl::Thread::isRunning;

    /**
     * returns if shutdown has already been called
     */
    bool isShutdownRequested() const { return m_bShutdownRequested; }

    /**
     * Register a listener for mail dispatcher events
     */
    void addListener(::rtl::Reference<IMailDispatcherListener> const& listener);

private:
    virtual void SAL_CALL run() override;
    virtual void SAL_CALL onTerminated() override;

    std::vector<::rtl::Reference<IMailDispatcherListener>> cloneListener();
    void sendMailMessageNotifyListener(css::uno::Reference<css::mail::XMailMessage> const& message);

    css::uno::Reference<css::mail::XSmtpService> m_xMailserver;
    std::list<css::uno::Reference<css::mail::XMailMessage>> m_aXMessageList;
    std::vector<::rtl::Reference<IMailDispatcherListener>> m_aListenerVector;
    ::osl::Mutex m_aMessageContainerMutex;
    ::osl::Mutex m_aListenerContainerMutex;
    ::osl::Mutex m_aThreadStatusMutex;
    ::osl::Condition m_aRunCondition;
    ::osl::Condition m_aWakeupCondition;
    ::rtl::Reference<MailDispatcher> m_xSelfReference;
    bool m_bActive;
    bool m_bShutdownRequested;
};

#endif // INCLUDED_SW_SOURCE_UIBASE_INC_MAILDISPATCHER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */