LibreOffice: uno/threadpool.h Source File

LibreOffice LibreOffice 5.3 SDK C/C++ API Reference

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 #ifndef INCLUDED_UNO_THREADPOOL_H
21 #define INCLUDED_UNO_THREADPOOL_H
22
23 #include <cppu/cppudllapi.h>
24 #include <sal/types.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /***
31 * Thread identifier administration.
32 ***/
47 CPPU_DLLPUBLIC sal_Bool SAL_CALL uno_bindIdToCurrentThread( sal_Sequence *pThreadId )
48 SAL_THROW_EXTERN_C();
49
50
61 CPPU_DLLPUBLIC void SAL_CALL uno_getIdOfCurrentThread( sal_Sequence **ppThreadId )
62 SAL_THROW_EXTERN_C();
63
64
69 CPPU_DLLPUBLIC void SAL_CALL uno_releaseIdFromCurrentThread()
70 SAL_THROW_EXTERN_C();
71
72
73 struct _uno_ThreadPool;
74 typedef struct _uno_ThreadPool * uno_ThreadPool;
75
80 CPPU_DLLPUBLIC uno_ThreadPool SAL_CALL
81 uno_threadpool_create() SAL_THROW_EXTERN_C();
82
83
95 CPPU_DLLPUBLIC void SAL_CALL
96 uno_threadpool_attach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
97
107 CPPU_DLLPUBLIC void SAL_CALL
108 uno_threadpool_enter( uno_ThreadPool hPool , void **ppJob )
109 SAL_THROW_EXTERN_C();
110
116 CPPU_DLLPUBLIC void SAL_CALL
117 uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
118
149 CPPU_DLLPUBLIC void SAL_CALL
150 uno_threadpool_putJob(
151 uno_ThreadPool hPool,
152 sal_Sequence *pThreadId,
153 void *pJob,
154 void ( SAL_CALL * doRequest ) ( void *pThreadSpecificData ),
155 sal_Bool bIsOneway ) SAL_THROW_EXTERN_C();
156
168 CPPU_DLLPUBLIC void SAL_CALL
169 uno_threadpool_dispose( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
170
171
181 CPPU_DLLPUBLIC void SAL_CALL
182 uno_threadpool_destroy( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
183
184 #ifdef __cplusplus
185 }
186 #endif
187
188 #endif // INCLUDED_UNO_THREADPOOL_H
189
190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
CPPU_DLLPUBLIC
#define CPPU_DLLPUBLIC
Definition: cppudllapi.h:10
SAL_THROW_EXTERN_C
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:370
uno_threadpool_attach
CPPU_DLLPUBLIC void uno_threadpool_attach(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Makes the current thread known to the threadpool.
sal_Bool
unsigned char sal_Bool
Definition: types.h:48
uno_threadpool_putJob
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.
uno_ThreadPool
struct _uno_ThreadPool * uno_ThreadPool
Definition: threadpool.h:74
types.h
uno_threadpool_create
CPPU_DLLPUBLIC uno_ThreadPool uno_threadpool_create() SAL_THROW_EXTERN_C()
Creates a threadpool handle.
uno_getIdOfCurrentThread
CPPU_DLLPUBLIC void uno_getIdOfCurrentThread(sal_Sequence **ppThreadId) SAL_THROW_EXTERN_C()
Get the identifier of the current thread.
uno_threadpool_enter
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.
uno_threadpool_destroy
CPPU_DLLPUBLIC void uno_threadpool_destroy(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Releases the previously with uno_threadpool_create() created handle.
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:345
cppudllapi.h
uno_threadpool_detach
CPPU_DLLPUBLIC void uno_threadpool_detach(uno_ThreadPool hPool) SAL_THROW_EXTERN_C()
Detaches the current thread from the threadpool.
uno_releaseIdFromCurrentThread
CPPU_DLLPUBLIC void uno_releaseIdFromCurrentThread() SAL_THROW_EXTERN_C()
If the internal refcount drops to zero, the association between threadId and thread is broken...
uno_threadpool_dispose
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.
uno_bindIdToCurrentThread
CPPU_DLLPUBLIC sal_Bool uno_bindIdToCurrentThread(sal_Sequence *pThreadId) SAL_THROW_EXTERN_C()
Establishes an association between the current thread and the given thread identifier.