mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
115 lines
4.8 KiB
C++
115 lines
4.8 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** 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.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Google Inc.
|
|
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Darin Fisher <darin@meer.net>
|
|
*
|
|
* 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 nsBaseContentStream_h__
|
|
#define nsBaseContentStream_h__
|
|
|
|
#include "nsIAsyncInputStream.h"
|
|
#include "nsIEventTarget.h"
|
|
#include "nsCOMPtr.h"
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// nsBaseContentStream is designed to be subclassed with the intention of being
|
|
// used to satisfy the nsBaseChannel::OpenContentStream method.
|
|
//
|
|
// The subclass typically overrides the default Available, ReadSegments and
|
|
// CloseWithStatus methods. By default, Read is implemented in terms of
|
|
// ReadSegments, and Close is implemented in terms of CloseWithStatus. If
|
|
// CloseWithStatus is overriden, then the subclass will usually want to call
|
|
// the base class' CloseWithStatus method before returning.
|
|
//
|
|
// If the stream is non-blocking, then readSegments may return the exception
|
|
// NS_BASE_STREAM_WOULD_BLOCK if there is no data available and the stream is
|
|
// not at the "end-of-file" or already closed. This error code must not be
|
|
// returned from the Available implementation. When the caller receives this
|
|
// error code, he may choose to call the stream's AsyncWait method, in which
|
|
// case the base stream will have a non-null PendingCallback. When the stream
|
|
// has data or encounters an error, it should be sure to dispatch a pending
|
|
// callback if one exists (see DispatchCallback). The implementation of the
|
|
// base stream's CloseWithStatus (and Close) method will ensure that any
|
|
// pending callback is dispatched. It is the responsibility of the subclass
|
|
// to ensure that the pending callback is dispatched when it wants to have its
|
|
// ReadSegments method called again.
|
|
|
|
class nsBaseContentStream : public nsIAsyncInputStream
|
|
{
|
|
public:
|
|
NS_DECL_ISUPPORTS
|
|
NS_DECL_NSIINPUTSTREAM
|
|
NS_DECL_NSIASYNCINPUTSTREAM
|
|
|
|
nsBaseContentStream(PRBool nonBlocking)
|
|
: mStatus(NS_OK)
|
|
, mNonBlocking(nonBlocking) {
|
|
}
|
|
|
|
nsresult Status() { return mStatus; }
|
|
PRBool IsNonBlocking() { return mNonBlocking; }
|
|
PRBool IsClosed() { return NS_FAILED(mStatus); }
|
|
|
|
// Called to test if the stream has a pending callback.
|
|
PRBool HasPendingCallback() { return mCallback != nsnull; }
|
|
|
|
// The current dispatch target (may be null) for the pending callback if any.
|
|
nsIEventTarget *CallbackTarget() { return mCallbackTarget; }
|
|
|
|
// Called to dispatch a pending callback. If there is no pending callback,
|
|
// then this function does nothing. Pass true to this function to cause the
|
|
// callback to occur asynchronously; otherwise, the callback will happen
|
|
// before this function returns.
|
|
void DispatchCallback(PRBool async = PR_TRUE);
|
|
|
|
// Helper function to make code more self-documenting.
|
|
void DispatchCallbackSync() { DispatchCallback(PR_FALSE); }
|
|
|
|
protected:
|
|
virtual ~nsBaseContentStream() {}
|
|
|
|
private:
|
|
// Called from the base stream's AsyncWait method when a pending callback
|
|
// is installed on the stream.
|
|
virtual void OnCallbackPending() {}
|
|
|
|
private:
|
|
nsCOMPtr<nsIInputStreamCallback> mCallback;
|
|
nsCOMPtr<nsIEventTarget> mCallbackTarget;
|
|
nsresult mStatus;
|
|
PRPackedBool mNonBlocking;
|
|
};
|
|
|
|
#endif // nsBaseContentStream_h__
|