pjs/modules/progress/public/progress.h

116 строки
3.6 KiB
C

/* -*- Mode: C; tab-width: 4; 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
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* 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 ***** */
/*
* A C-interface to the progress manager.
*/
#ifndef progress_h__
#define progress_h__
#include "prtypes.h"
#include "structs.h"
#include "net.h"
PR_BEGIN_EXTERN_C
/**
* Create a progress manager in the specified context if one does
* not already exist.
*/
extern void
PM_EnsureProgressManager(MWContext* context);
/**
* Release the progress manager from the specified context.
*
* <p> Note that this will not necessarily destroy the progress
* manager and unbind it from the context: it simply decrements the
* reference count onthe progress manager.
*/
extern void
PM_ReleaseProgressManager(MWContext* context);
/**
* Notify the progress manager for the specified context that the
* specified URL has begun to connect.
*/
extern void
PM_StartBinding(MWContext* context, const URL_Struct* url);
/**
* Notify the progress manager for the specified context that some
* progress has been made for the specified URL.
*/
extern void
PM_Progress(MWContext* context, const URL_Struct* url, PRUint32 bytesReceived, PRUint32 contentLength);
/**
* Notify the progress manager for the specified context of status
* for the specified URL. The progress manager will make a copy of the
* message.
*/
extern void
PM_Status(MWContext* context, const URL_Struct* url, const char* message);
/**
* Notify the progress manager that the specified URL transfer has
* beein suspended.
*/
extern void
PM_Suspend(MWContext* context, const URL_Struct* url);
/**
* Notify the progress manager that the specified URL transfer has
* been resumed.
*/
extern void
PM_Resume(MWContext* context, const URL_Struct* url);
/**
* Notify the progress manager for the specified context that the
* URL has completed.
*/
extern void
PM_StopBinding(MWContext* context, const URL_Struct* url, PRInt32 status, const char* message);
PR_END_EXTERN_C
#endif /* progress_h__ */