summaryrefslogtreecommitdiff
path: root/cppu/inc/uno/threadpool.h
diff options
context:
space:
mode:
authorBjoern Michaelsen <bjoern.michaelsen@canonical.com>2011-08-23 15:22:27 +0200
committerBjoern Michaelsen <bjoern.michaelsen@canonical.com>2011-08-23 15:22:27 +0200
commitebb2358f52acf7fd73f6be85771e1301a886bbdf (patch)
treeec91905c0c6bf08d7fa866b8260bdc9da7942248 /cppu/inc/uno/threadpool.h
parent4d771c9583d9db425f3c5c23cb18409dd815d639 (diff)
recreated tag libreoffice-3.3.0.4 which had these commits:
commit 5d72cb3cf5b1e61a804e7a5db52a4a6bd041afdd (tag: refs/tags/libreoffice-3.3.0.4, refs/remotes/origin/libreoffice-3-3-0) Author: Petr Mladek <pmladek@suse.cz> Date: Tue Jan 18 19:01:21 2011 +0100 Version 3.3.0.4, tag libreoffice-3.3.0.4 (3.3-rc4) commit 95323c2f1c8e7c340e8f3bb1261cd63fca66b68a Author: Petr Mladek <pmladek@suse.cz> Date: Tue Jan 11 22:59:38 2011 +0100 Branch libreoffice-3-3-0 This is 'libreoffice-3-3-0' - the stable branch for the 3.3.0 release. Only very safe changes, reviewed by three people are allowed. If you want to commit more complicated fix for the next 3.3.x release, please use the 'libreoffice-3-3' branch. If you want to build something cool, unstable, and risky, use master.
Notes
split repo tag: ure_libreoffice-3.3.0.4
Diffstat (limited to 'cppu/inc/uno/threadpool.h')
-rw-r--r--cppu/inc/uno/threadpool.h40
1 files changed, 20 insertions, 20 deletions
diff --git a/cppu/inc/uno/threadpool.h b/cppu/inc/uno/threadpool.h
index 0c647442e377..f2acf71fe092 100644
--- a/cppu/inc/uno/threadpool.h
+++ b/cppu/inc/uno/threadpool.h
@@ -2,7 +2,7 @@
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
+ *
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
@@ -42,13 +42,13 @@ extern "C" {
uno_releaseIdFromCurrentThread().
This method is in general called by a bridge, that wants to bind a remote threadId
to a new thread.
-
+
@param pThreadId a byte sequence, that contains the identifier of the current thread.
- @return true, when the identifier was registered.
+ @return true, when the identifier was registered.
false, when the thread has already an identifier. The identifier was not
altered. ( This is in general a bug ).
- @see uno_releaseIdFromCurrentThread()
+ @see uno_releaseIdFromCurrentThread()
*/
sal_Bool SAL_CALL uno_bindIdToCurrentThread( sal_Sequence *pThreadId )
SAL_THROW_EXTERN_C();
@@ -59,8 +59,8 @@ sal_Bool SAL_CALL uno_bindIdToCurrentThread( sal_Sequence *pThreadId )
If no id has been bound for the thread before, a new one is generated and bound
to the thread.
For each call to uno_getIdOfCurrentThread(), a call to uno_releaseIdFromCurrentThread()
- must be done.
-
+ must be done.
+
@param ppThreadId [out] Contains the (acquired) ThreadId.
@see uno_releaseIdFromCurrentThread()
*/
@@ -68,7 +68,7 @@ void SAL_CALL uno_getIdOfCurrentThread( sal_Sequence **ppThreadId )
SAL_THROW_EXTERN_C();
-/**
+/**
If the internal refcount drops to zero, the association betwen threadId and
thread is broken.
*/
@@ -94,9 +94,9 @@ uno_threadpool_create() SAL_THROW_EXTERN_C();
an incoming request/reply).
For every call to uno_threadpool_attach, a corrosponding call to
uno_threadpool_detach must be done.
-
+
@param hPool The bridge threadpool handle previously created by uno_threadpool_create.
-
+
*/
void SAL_CALL
uno_threadpool_attach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
@@ -104,7 +104,7 @@ uno_threadpool_attach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
/**
This method is called to wait for a reply of a previously sent request. This is a
blocking method. uno_threadpool_attach() must have been called before.
-
+
@param hPool the handle that was previously created by uno_threadpool_create().
@param ppJob [out] the pointer, that was given by uno_threadpool_putJob
0, when uno_threadpool_dispose() was the reason to fall off from threadpool.
@@ -117,30 +117,30 @@ uno_threadpool_enter( uno_ThreadPool hPool , void **ppJob )
/**
Detaches the current thread from the threadpool. Must be called for
every call to uno_threadpool_attach.
-*/
+*/
void SAL_CALL
uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
/**
Puts a job into the pool. A job may eiter be a request or a reply
(replies have a 0 in the doRequest parameter). This function is non-blocking.
-
+
A request may either be synchronous or asynchronous.
If the request is synchronous, it is first looked up,
if there exists a handle with the given
identifier. If this is the case, the thread is woken up and the doRequest
function is called with the given pJob. If no handle exists,
a new thread is created and the given threadId is bound to the new thread.
-
+
If the request is asynchronous, it is put into the queue of asynchronous
requests for the current threadid. The requests are always executed in a new
thread, even if the thread with the given id is waiting in the pool. No id is bound
to the newly created thread. The responsibilty is left to the bridge ( if it
wishes to bind a name).
-
+
If pJob is a reply, there MUST be a thread with the given threadId waiting
- for this reply.
-
+ for this reply.
+
@param pThreadId The Id of the thread, that initialized this request. (In general a
remote threadid).
@param pJob The argument, that doRequest will get or that will be returned by
@@ -161,16 +161,16 @@ uno_threadpool_putJob(
/**
All threads, that are waiting on the hPool handle, are forced out of the pool.
The threads waiting with uno_threadpool_enter() will return with *ppJob == 0
-
- Later calls to uno_threadpool_enter() using the hPool handle will also
+
+ Later calls to uno_threadpool_enter() using the hPool handle will also
return immeadiatly with *ppJob == 0.
-
+
@param hPool The handle to be disposed.
In case, hPool is 0, this function joins on all threads created
by the threadpool administration. This may e.g. used to ensure, that
no threads are inside the cppu library anymore, in case it needs to get
unloaded.
-
+
This function is called i.e. by a bridge, that is forced to dispose itself.
*/
void SAL_CALL