Section:

Lock a PDF document using JavaScript

If you plan on sharing a single PDF document instance across multiple threads, then you need to lock the document. Not locking a PDF document instance shared across threads can result in undefined behaviour, including crashing.

An Apryse SDK lock is based on two principles:

Reentrant mutex (also known as recursive lock)
Recursive mutex may be locked multiple times by the same process/thread without causing a deadlock.

Readers-writer (RW) lock (also known as shared-exclusive lock)
An RW lock allows concurrent access for read-only operations, while write operations require exclusive access.

Write to a document

To write to a PDF document in a multithreaded environment.

Only one thread can hold a write lock at any given time.

JavaScript

1async function main() {
2  const doc = await PDFNet.PDFDoc.createFromURL(filename);
3
4  // Lock the document
5  doc.lock();
6
7  // ... perform some document processing using write operations
8
9  // Now we release the lock
10  doc.unlock();
11}
12PDFNet.runWithCleanup(main);

Multithreaded PDF reading
Full source code which illustrates how to use PDFDoc locking mechanisms to access the document concurrently. PDFDoc uses a recursive shared lock model.

Read and write to a document

To read and write to a PDF document in a multithreaded environment.

A thread cannot acquire a write lock while holding a read lock.

JavaScript

1async function main() {
2  const doc = await PDFNet.PDFDoc.createFromURL(filename);
3
4  // Lock the document
5  doc.lock();
6
7  // Optionally note that locking a second time does not cause a deadlock
8  doc.lock();
9
10  // You can acquire a read lock while holding a write lock:
11  doc.lockRead();
12
13  // ... perform some document processing using read operations
14
15  doc.unlockRead();
16
17  // ... perform some document processing using write operations
18
19  // Releasing the lock decrements our lock count,
20  // but the thread still holds a write lock on the document
21  doc.unlock();
22
23  // Now we release the write lock, and
24  // other tasks can begin execution
25  doc.unlock();
26}
27PDFNet.runWithCleanup(main);

Multithreaded PDF reading
Full source code which illustrates how to use PDFDoc locking mechanisms to access the document concurrently. PDFDoc uses a recursive shared lock model.

About locking a document

As computing devices become more parallel in nature, Apryse is evolving to allow developers to leverage this power in new and exciting ways. Apryse version 6.0 introduces new locking semantics which allow for concurrent access of a PDFDoc instance. This was done to improve performance during interactive viewing (simultaneous rendering, text extraction, etc.), as well as to open up the possibility for new use cases (parallel rendering). This article introduces the locking system, and will get you on your way to developing parallel applications with Apryse SDK.

PDFDoc lock

Apryse uses a recursive read/write locking system. Multiple threads can hold a read lock on the document, but only one thread can hold a write lock at any given time. A thread can acquire an equivalent or weaker lock as many times as it likes without causing a deadlock. In other words, the following is valid:

JavaScript

1async function main() {
2  const doc = await PDFNet.PDFDoc.createFromURL("foo.pdf");
3  d.lock();
4  d.lock();
5  d.lockRead();
6}
7PDFNet.runWithCleanup(main);

However, a thread cannot acquire a write lock while holding a read lock. Because one can only acquire a write lock when no read locks are held, this situation would inevitably lead to a deadlock. To avoid this scenario, Apryse will throw a runtime exception whenever the situation occurs.

Locking in the Apryse API

Some of our API calls internally acquire a write lock on the document. As a result, these calls can also throw a runtime exception if they are invoked while holding a read lock. This is noted in each method's documentation. Additionally, you will find a complete list of those methods at the end of this article.

In general, the parts of our library that manage the UI will maintain document locks. For the lower level calls which actually modify the document, you are responsible for maintaining document locks.

Client side locking

Apryse provides the following APIs for locking the document:

JavaScript

1function PDFDoc.lock()
2function PDFDoc.tryLock(milliseconds)
3function PDFDoc.unlock()
4function PDFDoc.lockRead()
5function PDFDoc.tryLockRead(milliseconds)
6function PDFDoc.unlockRead()

Migration of earlier code

The new locking system is backwards compatible, meaning previous calls to PDFDoc.Lock now acquire a write lock. If you would like to take advantage of the ability to read a PDF concurrently, it is your responsibility to review document locks and determine whether it is safe to downgrade them to a read lock.

Opting out

Conversely, if you are happy with the existing 'one document, one thread' model previously used in Apryse 5.9., you can continue to work with this system. No change is required on your behalf.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales