LibreOffice
LibreOffice 4.2 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
threadpool.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #include <cppu/cppudllapi.h>
21 #include <rtl/byteseq.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /***
28  * Thread identifier administration.
29  ***/
46 
47 
58 CPPU_DLLPUBLIC void SAL_CALL uno_getIdOfCurrentThread( sal_Sequence **ppThreadId )
60 
61 
68 
69 
70 struct _uno_ThreadPool;
71 typedef struct _uno_ThreadPool * uno_ThreadPool;
72 
77 CPPU_DLLPUBLIC uno_ThreadPool SAL_CALL
79 
80 
92 CPPU_DLLPUBLIC void SAL_CALL
93 uno_threadpool_attach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
94 
104 CPPU_DLLPUBLIC void SAL_CALL
105 uno_threadpool_enter( uno_ThreadPool hPool , void **ppJob )
106  SAL_THROW_EXTERN_C();
107 
113 CPPU_DLLPUBLIC void SAL_CALL
114 uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
115 
146 CPPU_DLLPUBLIC void SAL_CALL
148  uno_ThreadPool hPool,
149  sal_Sequence *pThreadId,
150  void *pJob,
151  void ( SAL_CALL * doRequest ) ( void *pThreadSpecificData ),
152  sal_Bool bIsOneway ) SAL_THROW_EXTERN_C();
153 
165 CPPU_DLLPUBLIC void SAL_CALL
166 uno_threadpool_dispose( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
167 
168 
178 CPPU_DLLPUBLIC void SAL_CALL
179 uno_threadpool_destroy( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
CPPU_DLLPUBLIC uno_ThreadPool uno_threadpool_create() SAL_THROW_EXTERN_C()
Creates a threadpool handle.
#define SAL_THROW_EXTERN_C()
Definition: types.h:360
CPPU_DLLPUBLIC sal_Bool uno_bindIdToCurrentThread(sal_Sequence *pThreadId) SAL_THROW_EXTERN_C()
Establishs an association between the current thread and the given thread identifier.
CPPU_DLLPUBLIC void uno_threadpool_destroy(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Releases the previously with uno_threadpool_create() created handle.
This is the binary specification of a SAL sequence.
Definition: types.h:325
CPPU_DLLPUBLIC void uno_releaseIdFromCurrentThread() SAL_THROW_EXTERN_C()
If the internal refcount drops to zero, the association between threadId and thread is broken...
CPPU_DLLPUBLIC void uno_threadpool_attach(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Makes the current thread known to the threadpool.
#define CPPU_DLLPUBLIC
Definition: cppudllapi.h:10
CPPU_DLLPUBLIC void uno_threadpool_putJob(uno_ThreadPool hPool, sal_Sequence *pThreadId, void *pJob, void(*doRequest)(void *pThreadSpecificData), sal_Bool bIsOneway) SAL_THROW_EXTERN_C()
Puts a job into the pool.
unsigned char sal_Bool
Definition: types.h:46
CPPU_DLLPUBLIC void uno_threadpool_detach(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Detaches the current thread from the threadpool.
CPPU_DLLPUBLIC void uno_threadpool_enter(uno_ThreadPool hPool, void **ppJob) SAL_THROW_EXTERN_C()
This method is called to wait for a reply of a previously sent request.
CPPU_DLLPUBLIC void uno_getIdOfCurrentThread(sal_Sequence **ppThreadId) SAL_THROW_EXTERN_C()
Get the identifier of the current thread.
CPPU_DLLPUBLIC void uno_threadpool_dispose(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
All threads, that are waiting on the hPool handle, are forced out of the pool.
struct _uno_ThreadPool * uno_ThreadPool
Definition: threadpool.h:71