[#BloombergLP-bdlmt-TimerEventScheduler-start-0d]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/TimerEventScheduler.adoc[TimerEventScheduler]::start
:relfileprefix: ../../../
:mrdocs:

`start` overloads

== Synopses

Declared in `<bdlmt_timereventscheduler.h>`

Begin dispatching events on this scheduler using default attributes for the dispatcher thread. Return 0 on success, and a nonzero value otherwise. If another thread is currently executing `stop`, wait until the dispatcher thread stops before starting a new one. If this scheduler has already started (and is not currently being stopped by another thread) then this invocation has no effect and 0 is returned. The created thread will use the `eventSchedulerName` supplied at construction if it is not empty, otherwise "bdl.TimerEvent". The behavior is undefined if this method is invoked in the dispatcher thread (i.e., in a job executed by this scheduler). Note that any event whose time has already passed is pending and will be dispatched immediately.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/TimerEventScheduler/start-08.adoc[start]();
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/start-08.adoc[_» more..._]#

Begin dispatching events on this scheduler using the specified `threadAttributes` for the dispatcher thread (except that the DETACHED attribute is ignored). Return 0 on success, and a nonzero value otherwise. If another thread is currently executing `stop`, wait until the dispatcher thread stops before starting a new one. If this scheduler has already started (and is not currently being stopped by another thread) then this invocation has no effect and 0 is returned. The created thread will use the name `threadAttributes.getThreadName()` if it is not empty, otherwise `eventSchedulerName` supplied at construction if it is not empty, otherwise "bdl.TimerEvent". The behavior is undefined if this method is invoked in the dispatcher thread (i.e., in a job executed by this scheduler). Note that any event whose time has already passed is pending and will be dispatched immediately.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/TimerEventScheduler/start-07.adoc[start](xref:BloombergLP/bslmt/ThreadAttributes.adoc[bslmt::ThreadAttributes] const& threadAttributes);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/start-07.adoc[_» more..._]#


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