[#BaseIndex-BlockUntilSyncedToCurrentChain]
= xref:BaseIndex.adoc[BaseIndex]::BlockUntilSyncedToCurrentChain
:relfileprefix: ../
:mrdocs:

Blocks the current thread until the index is caught up to the current state of the block chain. This only blocks if the index has gotten in sync once and only needs to process blocks in the ValidationInterface queue. If the index is catching up from far behind, this method does not block and immediately returns false.

== Synopsis

Declared in `<index/base.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[locks_excluded(0x7f2e26d83708), locks_excluded(0x7f2e3567e0e8), locks_excluded(0x7f2e3a1d77d8), locks_excluded(0x7f2e286ab468), locks_excluded(0x7f2e093909c8)]]
bool
BlockUntilSyncedToCurrentChain() const;
----

== Return Value

True if the index was caught up, or false if it is still catching up from far behind.


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