2007-03-22 10:30:00 -07:00
|
|
|
/* ***** 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.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2002
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Darin Fisher <darin@netscape.com>
|
|
|
|
*
|
|
|
|
* 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 nsAHttpTransaction_h__
|
|
|
|
#define nsAHttpTransaction_h__
|
|
|
|
|
|
|
|
#include "nsISupports.h"
|
|
|
|
|
|
|
|
class nsAHttpConnection;
|
|
|
|
class nsAHttpSegmentReader;
|
|
|
|
class nsAHttpSegmentWriter;
|
|
|
|
class nsIInterfaceRequestor;
|
2011-03-31 12:38:30 -07:00
|
|
|
class nsIEventTarget;
|
2011-04-10 10:33:08 -07:00
|
|
|
class nsITransport;
|
2011-04-08 11:37:16 -07:00
|
|
|
class nsHttpRequestHead;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
// Abstract base class for a HTTP transaction:
|
|
|
|
//
|
|
|
|
// A transaction is a "sink" for the response data. The connection pushes
|
|
|
|
// data to the transaction by writing to it. The transaction supports
|
|
|
|
// WriteSegments and may refuse to accept data if its buffers are full (its
|
|
|
|
// write function returns NS_BASE_STREAM_WOULD_BLOCK in this case).
|
|
|
|
//----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class nsAHttpTransaction : public nsISupports
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// called by the connection when it takes ownership of the transaction.
|
|
|
|
virtual void SetConnection(nsAHttpConnection *) = 0;
|
|
|
|
|
2011-04-10 10:33:08 -07:00
|
|
|
// called by the connection to get security callbacks to set on the
|
2007-03-22 10:30:00 -07:00
|
|
|
// socket transport.
|
2011-03-31 12:38:30 -07:00
|
|
|
virtual void GetSecurityCallbacks(nsIInterfaceRequestor **,
|
|
|
|
nsIEventTarget **) = 0;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
// called to report socket status (see nsITransportEventSink)
|
2011-04-10 10:33:08 -07:00
|
|
|
virtual void OnTransportStatus(nsITransport* transport,
|
|
|
|
nsresult status, PRUint64 progress) = 0;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
// called to check the transaction status.
|
|
|
|
virtual PRBool IsDone() = 0;
|
|
|
|
virtual nsresult Status() = 0;
|
|
|
|
|
|
|
|
// called to find out how much request data is available for writing.
|
|
|
|
virtual PRUint32 Available() = 0;
|
|
|
|
|
|
|
|
// called to read request data from the transaction.
|
|
|
|
virtual nsresult ReadSegments(nsAHttpSegmentReader *reader,
|
|
|
|
PRUint32 count, PRUint32 *countRead) = 0;
|
|
|
|
|
|
|
|
// called to write response data to the transaction.
|
|
|
|
virtual nsresult WriteSegments(nsAHttpSegmentWriter *writer,
|
|
|
|
PRUint32 count, PRUint32 *countWritten) = 0;
|
|
|
|
|
|
|
|
// called to close the transaction
|
|
|
|
virtual void Close(nsresult reason) = 0;
|
2011-04-08 11:37:16 -07:00
|
|
|
|
|
|
|
// called to indicate a failure at the SSL setup level
|
|
|
|
virtual void SetSSLConnectFailed() = 0;
|
|
|
|
|
|
|
|
// called to retrieve the request headers of the transaction
|
|
|
|
virtual nsHttpRequestHead *RequestHead() = 0;
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
#define NS_DECL_NSAHTTPTRANSACTION \
|
|
|
|
void SetConnection(nsAHttpConnection *); \
|
2011-03-31 12:38:30 -07:00
|
|
|
void GetSecurityCallbacks(nsIInterfaceRequestor **, \
|
|
|
|
nsIEventTarget **); \
|
2011-04-10 10:33:08 -07:00
|
|
|
void OnTransportStatus(nsITransport* transport, \
|
|
|
|
nsresult status, PRUint64 progress); \
|
2007-03-22 10:30:00 -07:00
|
|
|
PRBool IsDone(); \
|
|
|
|
nsresult Status(); \
|
|
|
|
PRUint32 Available(); \
|
|
|
|
nsresult ReadSegments(nsAHttpSegmentReader *, PRUint32, PRUint32 *); \
|
|
|
|
nsresult WriteSegments(nsAHttpSegmentWriter *, PRUint32, PRUint32 *); \
|
2011-04-08 11:37:16 -07:00
|
|
|
void Close(nsresult reason); \
|
|
|
|
void SetSSLConnectFailed(); \
|
|
|
|
nsHttpRequestHead *RequestHead();
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// nsAHttpSegmentReader
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class nsAHttpSegmentReader
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// any returned failure code stops segment iteration
|
|
|
|
virtual nsresult OnReadSegment(const char *segment,
|
|
|
|
PRUint32 count,
|
|
|
|
PRUint32 *countRead) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define NS_DECL_NSAHTTPSEGMENTREADER \
|
|
|
|
nsresult OnReadSegment(const char *, PRUint32, PRUint32 *);
|
|
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
// nsAHttpSegmentWriter
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class nsAHttpSegmentWriter
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// any returned failure code stops segment iteration
|
|
|
|
virtual nsresult OnWriteSegment(char *segment,
|
|
|
|
PRUint32 count,
|
|
|
|
PRUint32 *countWritten) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define NS_DECL_NSAHTTPSEGMENTWRITER \
|
|
|
|
nsresult OnWriteSegment(char *, PRUint32, PRUint32 *);
|
|
|
|
|
|
|
|
#endif // nsAHttpTransaction_h__
|