1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_MAILDISPATCHER_HXX
#define INCLUDED_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 <salhelper/refobj.hxx>
#include <list>
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 MailDispatcher : public ::salhelper::ReferenceObject, private ::osl::Thread
{
public:
// bringing operator new/delete into scope
using osl::Thread::operator new;
using osl::Thread::operator delete;
using osl::Thread::join;
public:
/**
@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 ::com::sun::star::uno::RuntimeException
on errors during construction of an instance of this class.
*/
MailDispatcher(::com::sun::star::uno::Reference< ::com::sun::star::mail::XSmtpService> xMailService);
/**
Shutdown the mail dispatcher. Every mail messages
not yet sent will be discarded.
*/
virtual ~MailDispatcher();
/**
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(::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> xMailMessage);
/**
Dequeues a mail message.
This enables the caller to remove attachments when sending mails is to be cancelled.
*/
::com::sun::star::uno::Reference< ::com::sun::star::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 an 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;
/** returns if the thread is still running
*/
using osl::Thread::isRunning;
/** returns if shutdown has already been called
*/
bool isShutdownRequested() const
{ return shutdown_requested_; }
/**
Register a listener for mail dispatcher events.
*/
void addListener(::rtl::Reference<IMailDispatcherListener> listener);
/**
Unregister a listener for mail dispatcher events
*/
void removeListener(::rtl::Reference<IMailDispatcherListener> listener);
protected:
virtual void SAL_CALL run();
virtual void SAL_CALL onTerminated();
private:
std::list< ::rtl::Reference<IMailDispatcherListener> > cloneListener();
void sendMailMessageNotifyListener(::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> message);
private:
::com::sun::star::uno::Reference< ::com::sun::star::mail::XSmtpService> mailserver_;
::std::list< ::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage > > messages_;
::std::list< ::rtl::Reference<IMailDispatcherListener> > listeners_;
::osl::Mutex message_container_mutex_;
::osl::Mutex listener_container_mutex_;
::osl::Mutex thread_status_mutex_;
::osl::Condition mail_dispatcher_active_;
::osl::Condition wakening_call_;
::rtl::Reference<MailDispatcher> m_xSelfReference;
bool run_;
bool shutdown_requested_;
};
#endif // INCLUDED_MAILDISPATCHER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
