com.sun.star.lib.uno.environments.remote

Interface IThreadPool

All Known Implementing Classes:

JavaThreadPool

public interface IThreadPool

This interface is an abstraction of the various threadpool implementations.

Since:

UDK1.0

See Also:

com.sun.star.lib.uno.environments.remote.ThreadPoolFactory, com.sun.star.lib.uno.environments.remote.IThreadPoolFactory

Method Summary

Modifier and Type	Method and Description
void	attach() Attaches this thread to the thread pool.
java.lang.Object	attach(ThreadId id) As above, but hands in an already existing instance of the threadid of the current thread.
void	destroy() Destroys the thread pool and tries to join all created threads immediately.
void	detach() Detaches this thread from the thread pool.
void	detach(java.lang.Object handle, ThreadId id) As above, but hands in an already existing instance of the threadid of the current thread and a handle returned by attach.
void	dispose(java.lang.Throwable throwable) Disposes this thread pool, thus releasing all threads by throwing a DisposedException with the given Throwable cause.
java.lang.Object	enter() Lets this thread enter the thread pool.
java.lang.Object	enter(java.lang.Object handle, ThreadId id) as above but hands in an already existing instance of the threadid of the current thread and a handle returned by attach.
ThreadId	getThreadId() Retrieves the global threadId for the current thread.
void	putJob(Job job) Queues a job into the jobQueue of the thread belonging to the jobs threadId.

Method Detail

getThreadId

ThreadId getThreadId()

Retrieves the global threadId for the current thread.

Returns:

the thread id

attach

void attach()

Attaches this thread to the thread pool.

See Also:

enter()

attach

java.lang.Object attach(ThreadId id)

As above, but hands in an already existing instance of the threadid of the current thread. Returns a handle which can be used in enter and detach calls.

The function exists for performance optimization reasons.

See Also:

attach()

detach

void detach()

Detaches this thread from the thread pool.

See Also:

enter()

detach

void detach(java.lang.Object handle,
            ThreadId id)

As above, but hands in an already existing instance of the threadid of the current thread and a handle returned by attach. The function exists for performance optimization reasons.

See Also:

#attach,#detach

enter

java.lang.Object enter()
                throws java.lang.Throwable

Lets this thread enter the thread pool. This thread then executes all jobs put via putJob until a reply job arrives.

Throws:

java.lang.Throwable

See Also:

putJob(com.sun.star.lib.uno.environments.remote.Job)

enter

java.lang.Object enter(java.lang.Object handle,
                       ThreadId id)
                throws java.lang.Throwable

as above but hands in an already existing instance of the threadid of the current thread and a handle returned by attach. This thread then executes all jobs put via putJob until a reply job arrives.

Throws:

java.lang.Throwable

See Also:

putJob(com.sun.star.lib.uno.environments.remote.Job)

putJob

void putJob(Job job)

Queues a job into the jobQueue of the thread belonging to the jobs threadId.

Parameters:

job - the job

dispose

void dispose(java.lang.Throwable throwable)

Disposes this thread pool, thus releasing all threads by throwing a DisposedException with the given Throwable cause.

Parameters:

throwing - the cause

destroy

void destroy()

Destroys the thread pool and tries to join all created threads immediately.