[#BloombergLP-bdlmt-FixedThreadPool-tryEnqueueJob-0a5]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/FixedThreadPool.adoc[FixedThreadPool]::tryEnqueueJob
:relfileprefix: ../../../
:mrdocs:

Try to enqueue `function` with `userData` without blocking.

== Synopsis

Declared in `<bdlmt_fixedthreadpool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
tryEnqueueJob(
    xref:BloombergLP/bdlmt/FixedThreadPoolJobFunc.adoc[FixedThreadPoolJobFunc] function,
    void* userData);
----

== Description

Try to enqueue `function`/`userData` for the next available thread.

Enqueue the specified `function` to be executed by the next available thread. The specified `userData` pointer will be passed to the function by the processing thread. Return 0 on success, and a non‐zero value otherwise. Specifically, return `e_SUCCESS` on success, `e_DISABLED` if `!isEnabled()`, `e_FULL` if `isEnabled()` and the underlying queue was full, and `e_FAILED` if an error occurs. The behavior is undefined unless `function` is not null.

== Return Value

0 on success, and a non‐zero value if the queue is full or disabled

== Parameters

[cols="1,4"]
|===
| Name| Description
| *function*
| job function to enqueue
| *userData*
| opaque pointer passed to `function`
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#