PageRenderTime 19ms CodeModel.GetById 11ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/gecko_api/include/prtpool.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 115 lines | 45 code | 18 blank | 52 comment | 0 complexity | 33c944f84cf2780ed6d10427177b9d58 MD5 | raw file
  1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2/* ***** BEGIN LICENSE BLOCK *****
  3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4 *
  5 * The contents of this file are subject to the Mozilla Public License Version
  6 * 1.1 (the "License"); you may not use this file except in compliance with
  7 * the License. You may obtain a copy of the License at
  8 * http://www.mozilla.org/MPL/
  9 *
 10 * Software distributed under the License is distributed on an "AS IS" basis,
 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 12 * for the specific language governing rights and limitations under the
 13 * License.
 14 *
 15 * The Original Code is the Netscape Portable Runtime (NSPR).
 16 *
 17 * The Initial Developer of the Original Code is
 18 * Netscape Communications Corporation.
 19 * Portions created by the Initial Developer are Copyright (C) 1999-2000
 20 * the Initial Developer. All Rights Reserved.
 21 *
 22 * Contributor(s):
 23 *
 24 * Alternatively, the contents of this file may be used under the terms of
 25 * either the GNU General Public License Version 2 or later (the "GPL"), or
 26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 27 * in which case the provisions of the GPL or the LGPL are applicable instead
 28 * of those above. If you wish to allow use of your version of this file only
 29 * under the terms of either the GPL or the LGPL, and not to allow others to
 30 * use your version of this file under the terms of the MPL, indicate your
 31 * decision by deleting the provisions above and replace them with the notice
 32 * and other provisions required by the GPL or the LGPL. If you do not delete
 33 * the provisions above, a recipient may use your version of this file under
 34 * the terms of any one of the MPL, the GPL or the LGPL.
 35 *
 36 * ***** END LICENSE BLOCK ***** */
 37
 38#ifndef prtpool_h___
 39#define prtpool_h___
 40
 41#include "prtypes.h"
 42#include "prthread.h"
 43#include "prio.h"
 44#include "prerror.h"
 45
 46/*
 47 * NOTE:
 48 *		THIS API IS A PRELIMINARY VERSION IN NSPR 4.0 AND IS SUBJECT TO
 49 *		CHANGE
 50 */
 51
 52PR_BEGIN_EXTERN_C
 53
 54typedef struct PRJobIoDesc {
 55    PRFileDesc *socket;
 56    PRErrorCode error;
 57    PRIntervalTime timeout;
 58} PRJobIoDesc;
 59
 60typedef struct PRThreadPool PRThreadPool;
 61typedef struct PRJob PRJob;
 62typedef void (PR_CALLBACK *PRJobFn) (void *arg);
 63
 64/* Create thread pool */
 65NSPR_API(PRThreadPool *)
 66PR_CreateThreadPool(PRInt32 initial_threads, PRInt32 max_threads,
 67                          PRUint32 stacksize);
 68
 69/* queue a job */
 70NSPR_API(PRJob *)
 71PR_QueueJob(PRThreadPool *tpool, PRJobFn fn, void *arg, PRBool joinable);
 72
 73/* queue a job, when a socket is readable */
 74NSPR_API(PRJob *)
 75PR_QueueJob_Read(PRThreadPool *tpool, PRJobIoDesc *iod,
 76							PRJobFn fn, void * arg, PRBool joinable);
 77
 78/* queue a job, when a socket is writeable */
 79NSPR_API(PRJob *)
 80PR_QueueJob_Write(PRThreadPool *tpool, PRJobIoDesc *iod,
 81								PRJobFn fn, void * arg, PRBool joinable);
 82
 83/* queue a job, when a socket has a pending connection */
 84NSPR_API(PRJob *)
 85PR_QueueJob_Accept(PRThreadPool *tpool, PRJobIoDesc *iod,
 86									PRJobFn fn, void * arg, PRBool joinable);
 87
 88/* queue a job, when the socket connection to addr succeeds or fails */
 89NSPR_API(PRJob *)
 90PR_QueueJob_Connect(PRThreadPool *tpool, PRJobIoDesc *iod,
 91			const PRNetAddr *addr, PRJobFn fn, void * arg, PRBool joinable);
 92
 93/* queue a job, when a timer exipres */
 94NSPR_API(PRJob *)
 95PR_QueueJob_Timer(PRThreadPool *tpool, PRIntervalTime timeout,
 96								PRJobFn fn, void * arg, PRBool joinable);
 97/* cancel a job */
 98NSPR_API(PRStatus)
 99PR_CancelJob(PRJob *job);
100
101/* join a job */
102NSPR_API(PRStatus)
103PR_JoinJob(PRJob *job);
104
105/* shutdown pool */
106NSPR_API(PRStatus)
107PR_ShutdownThreadPool(PRThreadPool *tpool);
108
109/* join pool, wait for exit of all threads */
110NSPR_API(PRStatus)
111PR_JoinThreadPool(PRThreadPool *tpool);
112
113PR_END_EXTERN_C
114
115#endif /* prtpool_h___ */