2009-07-13 14:55:04 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
* vim: sw=4 ts=4 et :
|
|
|
|
*/
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (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.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Mozilla Plugin App.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Chris Jones <jones.chris.g@gmail.com>
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2009
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
#ifndef ipc_glue_SyncChannel_h
|
|
|
|
#define ipc_glue_SyncChannel_h 1
|
|
|
|
|
|
|
|
#include "mozilla/ipc/AsyncChannel.h"
|
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace ipc {
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class SyncChannel : public AsyncChannel
|
|
|
|
{
|
|
|
|
protected:
|
2010-10-22 15:28:40 -07:00
|
|
|
typedef IPC::Message::msgid_t msgid_t;
|
2009-07-13 14:55:04 -07:00
|
|
|
|
|
|
|
public:
|
2010-02-09 16:02:54 -08:00
|
|
|
static const int32 kNoTimeout;
|
|
|
|
|
2009-07-15 15:33:37 -07:00
|
|
|
class /*NS_INTERFACE_CLASS*/ SyncListener :
|
|
|
|
public AsyncChannel::AsyncListener
|
2009-07-13 14:55:04 -07:00
|
|
|
{
|
|
|
|
public:
|
2009-07-15 15:06:30 -07:00
|
|
|
virtual ~SyncListener() { }
|
2009-12-03 00:16:28 -08:00
|
|
|
|
|
|
|
virtual void OnChannelClose() = 0;
|
|
|
|
virtual void OnChannelError() = 0;
|
2009-07-13 14:55:04 -07:00
|
|
|
virtual Result OnMessageReceived(const Message& aMessage) = 0;
|
2010-08-20 16:24:40 -07:00
|
|
|
virtual void OnProcessingError(Result aError) = 0;
|
2010-02-09 16:02:55 -08:00
|
|
|
virtual bool OnReplyTimeout() = 0;
|
2009-07-13 14:55:04 -07:00
|
|
|
virtual Result OnMessageReceived(const Message& aMessage,
|
|
|
|
Message*& aReply) = 0;
|
2010-10-08 16:24:36 -07:00
|
|
|
virtual void OnChannelConnected(int32 peer_pid) {};
|
2009-07-13 14:55:04 -07:00
|
|
|
};
|
|
|
|
|
2009-11-12 14:16:54 -08:00
|
|
|
SyncChannel(SyncListener* aListener);
|
|
|
|
virtual ~SyncChannel();
|
2009-07-13 14:55:04 -07:00
|
|
|
|
2010-02-16 10:44:21 -08:00
|
|
|
NS_OVERRIDE
|
|
|
|
virtual bool Send(Message* msg) {
|
2009-07-13 14:55:04 -07:00
|
|
|
return AsyncChannel::Send(msg);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Synchronously send |msg| (i.e., wait for |reply|)
|
2010-02-16 10:44:21 -08:00
|
|
|
virtual bool Send(Message* msg, Message* reply);
|
2009-07-13 14:55:04 -07:00
|
|
|
|
2010-02-09 16:02:55 -08:00
|
|
|
void SetReplyTimeoutMs(int32 aTimeoutMs) {
|
|
|
|
AssertWorkerThread();
|
|
|
|
mTimeoutMs = (aTimeoutMs <= 0) ? kNoTimeout : aTimeoutMs;
|
|
|
|
}
|
|
|
|
|
2009-07-13 14:55:04 -07:00
|
|
|
// Override the AsyncChannel handler so we can dispatch sync messages
|
2009-09-21 19:02:15 -07:00
|
|
|
NS_OVERRIDE virtual void OnMessageReceived(const Message& msg);
|
|
|
|
NS_OVERRIDE virtual void OnChannelError();
|
2009-07-13 14:55:04 -07:00
|
|
|
|
2009-11-18 15:18:08 -08:00
|
|
|
static bool IsPumpingMessages() {
|
|
|
|
return sIsPumpingMessages;
|
|
|
|
}
|
|
|
|
static void SetIsPumpingMessages(bool aIsPumping) {
|
|
|
|
sIsPumpingMessages = aIsPumping;
|
|
|
|
}
|
2009-11-06 14:33:12 -08:00
|
|
|
|
2010-04-28 08:01:09 -07:00
|
|
|
#ifdef OS_WIN
|
|
|
|
struct NS_STACK_CLASS SyncStackFrame
|
|
|
|
{
|
|
|
|
SyncStackFrame(SyncChannel* channel, bool rpc);
|
|
|
|
~SyncStackFrame();
|
|
|
|
|
|
|
|
bool mRPC;
|
|
|
|
bool mSpinNestedEvents;
|
|
|
|
SyncChannel* mChannel;
|
|
|
|
|
|
|
|
/* the previous stack frame for this channel */
|
|
|
|
SyncStackFrame* mPrev;
|
|
|
|
|
|
|
|
/* the previous stack frame on any channel */
|
|
|
|
SyncStackFrame* mStaticPrev;
|
|
|
|
};
|
|
|
|
friend struct SyncChannel::SyncStackFrame;
|
|
|
|
|
|
|
|
static bool IsSpinLoopActive() {
|
|
|
|
for (SyncStackFrame* frame = sStaticTopFrame;
|
|
|
|
frame;
|
|
|
|
frame = frame->mPrev) {
|
|
|
|
if (frame->mSpinNestedEvents)
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
/* the deepest sync stack frame for this channel */
|
|
|
|
SyncStackFrame* mTopFrame;
|
|
|
|
|
|
|
|
/* the deepest sync stack frame on any channel */
|
|
|
|
static SyncStackFrame* sStaticTopFrame;
|
|
|
|
#endif // OS_WIN
|
|
|
|
|
2009-07-13 14:55:04 -07:00
|
|
|
protected:
|
|
|
|
// Executed on the worker thread
|
2010-04-26 22:42:59 -07:00
|
|
|
bool ProcessingSyncMessage() const {
|
2009-08-19 08:44:56 -07:00
|
|
|
return mProcessingSyncMessage;
|
2009-07-13 14:55:04 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
void OnDispatchMessage(const Message& aMsg);
|
2010-01-26 22:41:32 -08:00
|
|
|
|
|
|
|
NS_OVERRIDE
|
|
|
|
bool OnSpecialMessage(uint16 id, const Message& msg)
|
|
|
|
{
|
|
|
|
// SyncChannel doesn't care about any special messages yet
|
|
|
|
return AsyncChannel::OnSpecialMessage(id, msg);
|
|
|
|
}
|
|
|
|
|
2010-02-09 16:02:54 -08:00
|
|
|
//
|
|
|
|
// Return true if the wait ended because a notification was
|
|
|
|
// received. That is, true => event received.
|
|
|
|
//
|
|
|
|
// Return false if the time elapsed from when we started the
|
|
|
|
// process of waiting until afterwards exceeded the currently
|
|
|
|
// allotted timeout. That *DOES NOT* mean false => "no event" (==
|
|
|
|
// timeout); there are many circumstances that could cause the
|
|
|
|
// measured elapsed time to exceed the timeout EVEN WHEN we were
|
|
|
|
// notified.
|
|
|
|
//
|
|
|
|
// So in sum: true is a meaningful return value; false isn't,
|
|
|
|
// necessarily.
|
|
|
|
//
|
|
|
|
bool WaitForNotify();
|
|
|
|
|
|
|
|
bool ShouldContinueFromTimeout();
|
2009-07-13 14:55:04 -07:00
|
|
|
|
|
|
|
// Executed on the IO thread.
|
2009-10-08 23:21:39 -07:00
|
|
|
void NotifyWorkerThread();
|
2009-07-13 14:55:04 -07:00
|
|
|
|
2009-08-19 08:44:56 -07:00
|
|
|
// On both
|
2010-04-26 22:42:59 -07:00
|
|
|
bool AwaitingSyncReply() const {
|
2009-08-19 08:44:56 -07:00
|
|
|
mMutex.AssertCurrentThreadOwns();
|
|
|
|
return mPendingReply != 0;
|
|
|
|
}
|
|
|
|
|
2010-01-21 18:04:09 -08:00
|
|
|
int32 NextSeqno() {
|
|
|
|
AssertWorkerThread();
|
|
|
|
return mChild ? --mNextSeqno : ++mNextSeqno;
|
|
|
|
}
|
|
|
|
|
2010-10-22 15:28:40 -07:00
|
|
|
msgid_t mPendingReply;
|
2009-08-19 08:44:56 -07:00
|
|
|
bool mProcessingSyncMessage;
|
2009-07-13 14:55:04 -07:00
|
|
|
Message mRecvd;
|
2010-01-21 18:04:09 -08:00
|
|
|
// This is only accessed from the worker thread; seqno's are
|
|
|
|
// completely opaque to the IO thread.
|
|
|
|
int32 mNextSeqno;
|
2009-11-06 14:33:12 -08:00
|
|
|
|
2009-11-18 15:18:08 -08:00
|
|
|
static bool sIsPumpingMessages;
|
2010-02-09 16:02:54 -08:00
|
|
|
|
2010-02-11 12:19:21 -08:00
|
|
|
int32 mTimeoutMs;
|
|
|
|
|
2010-03-25 14:53:10 -07:00
|
|
|
#ifdef OS_WIN
|
|
|
|
HANDLE mEvent;
|
|
|
|
#endif
|
|
|
|
|
2010-02-09 16:02:54 -08:00
|
|
|
private:
|
|
|
|
bool EventOccurred();
|
2009-07-13 14:55:04 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
} // namespace ipc
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif // ifndef ipc_glue_SyncChannel_h
|