Back to index

lightning-sunbird  0.9+nobinonly
prtpool.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef prtpool_h___
00039 #define prtpool_h___
00040 
00041 #include "prtypes.h"
00042 #include "prthread.h"
00043 #include "prio.h"
00044 #include "prerror.h"
00045 
00046 /*
00047  * NOTE:
00048  *            THIS API IS A PRELIMINARY VERSION IN NSPR 4.0 AND IS SUBJECT TO
00049  *            CHANGE
00050  */
00051 
00052 PR_BEGIN_EXTERN_C
00053 
00054 typedef struct PRJobIoDesc {
00055     PRFileDesc *socket;
00056     PRErrorCode error;
00057     PRIntervalTime timeout;
00058 } PRJobIoDesc;
00059 
00060 typedef struct PRThreadPool PRThreadPool;
00061 typedef struct PRJob PRJob;
00062 typedef void (PR_CALLBACK *PRJobFn) (void *arg);
00063 
00064 /* Create thread pool */
00065 NSPR_API(PRThreadPool *)
00066 PR_CreateThreadPool(PRInt32 initial_threads, PRInt32 max_threads,
00067                           PRUint32 stacksize);
00068 
00069 /* queue a job */
00070 NSPR_API(PRJob *)
00071 PR_QueueJob(PRThreadPool *tpool, PRJobFn fn, void *arg, PRBool joinable);
00072 
00073 /* queue a job, when a socket is readable */
00074 NSPR_API(PRJob *)
00075 PR_QueueJob_Read(PRThreadPool *tpool, PRJobIoDesc *iod,
00076                                                  PRJobFn fn, void * arg, PRBool joinable);
00077 
00078 /* queue a job, when a socket is writeable */
00079 NSPR_API(PRJob *)
00080 PR_QueueJob_Write(PRThreadPool *tpool, PRJobIoDesc *iod,
00081                                                         PRJobFn fn, void * arg, PRBool joinable);
00082 
00083 /* queue a job, when a socket has a pending connection */
00084 NSPR_API(PRJob *)
00085 PR_QueueJob_Accept(PRThreadPool *tpool, PRJobIoDesc *iod,
00086                                                                PRJobFn fn, void * arg, PRBool joinable);
00087 
00088 /* queue a job, when the socket connection to addr succeeds or fails */
00089 NSPR_API(PRJob *)
00090 PR_QueueJob_Connect(PRThreadPool *tpool, PRJobIoDesc *iod,
00091                      const PRNetAddr *addr, PRJobFn fn, void * arg, PRBool joinable);
00092 
00093 /* queue a job, when a timer exipres */
00094 NSPR_API(PRJob *)
00095 PR_QueueJob_Timer(PRThreadPool *tpool, PRIntervalTime timeout,
00096                                                         PRJobFn fn, void * arg, PRBool joinable);
00097 /* cancel a job */
00098 NSPR_API(PRStatus)
00099 PR_CancelJob(PRJob *job);
00100 
00101 /* join a job */
00102 NSPR_API(PRStatus)
00103 PR_JoinJob(PRJob *job);
00104 
00105 /* shutdown pool */
00106 NSPR_API(PRStatus)
00107 PR_ShutdownThreadPool(PRThreadPool *tpool);
00108 
00109 /* join pool, wait for exit of all threads */
00110 NSPR_API(PRStatus)
00111 PR_JoinThreadPool(PRThreadPool *tpool);
00112 
00113 PR_END_EXTERN_C
00114 
00115 #endif /* prtpool_h___ */