Skip to content

Commit c60eff6

Browse files
Merge pull request #110 from dynamsoft-docs/preview
add Thread Safety notes
2 parents e58e718 + 7f38a94 commit c60eff6

8 files changed

Lines changed: 45 additions & 0 deletions

File tree

programming/cplusplus/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ The `CCaptureVisionRouter` class is what a user uses to interact with image-proc
2222
class CCaptureVisionRouter
2323
```
2424
25+
## Thread Safety
26+
27+
Instances of `CCaptureVisionRouter` are not thread-safe.
28+
Do not access the same `CCaptureVisionRouter` instance from multiple threads concurrently.
29+
Create a separate instance for each thread if concurrent processing is required.
30+
2531
## Constructor and Destructor
2632
2733
| Method | Description |

programming/cplusplus/api-reference/capture-vision-router/instantiate.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Default constructor of a `CCaptureVisionRouter` object.
2222
```cpp
2323
CCaptureVisionRouter::CCaptureVisionRouter()
2424
```
25+
26+
> [!IMPORTANT]
27+
> Instances of `CCaptureVisionRouter` are not thread-safe.
28+
> Do not access the same `CCaptureVisionRouter` instance from multiple threads concurrently.
29+
> Create a separate instance for each thread if concurrent processing is required.
30+
2531

2632
## ~CCaptureVisionRouter
2733

programming/dotnet/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ The `CaptureVisionRouter` class is what a user uses to interact with image-proce
2020
public class CaptureVisionRouter : IDisposable
2121
```
2222

23+
## Thread Safety
24+
25+
Instances of `CaptureVisionRouter` are not thread-safe.
26+
Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
27+
Create a separate instance for each thread if concurrent processing is required.
28+
29+
2330
## Constructor and Destructor Methods
2431

2532
| Method | Description |

programming/dotnet/api-reference/capture-vision-router/instantiate.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Default constructor of a `CaptureVisionRouter` object.
2323
CaptureVisionRouter()
2424
```
2525

26+
> [!IMPORTANT]
27+
> Instances of `CaptureVisionRouter` are not thread-safe.
28+
> Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
29+
> Create a separate instance for each thread if concurrent processing is required.
30+
2631
## ~CaptureVisionRouter
2732

2833
Destructor of a `CaptureVisionRouter` object.

programming/java/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ The `CaptureVisionRouter` class is what a user uses to interact with image-proce
1717
class CaptureVisionRouter
1818
```
1919

20+
## Thread Safety
21+
22+
Instances of `CaptureVisionRouter` are not thread-safe.
23+
Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
24+
Create a separate instance for each thread if concurrent processing is required.
25+
2026
## Constructor Methods
2127

2228
| Method | Description |

programming/java/api-reference/capture-vision-router/instantiate.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@ Initializes a `CaptureVisionRouter` object.
2121
public CaptureVisionRouter()
2222
```
2323

24+
> [!IMPORTANT]
25+
> Instances of `CaptureVisionRouter` are not thread-safe.
26+
> Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
27+
> Create a separate instance for each thread if concurrent processing is required.

programming/python/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ The `CaptureVisionRouter` class is what a user uses to interact with image-proce
1717
class CaptureVisionRouter
1818
```
1919

20+
## Thread Safety
21+
22+
Instances of `CaptureVisionRouter` are not thread-safe.
23+
Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
24+
Create a separate instance for each thread if concurrent processing is required.
25+
26+
2027
## Constructor Methods
2128

2229
| Method | Description |

programming/python/api-reference/capture-vision-router/instantiate.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,7 @@ Initializes a `CaptureVisionRouter` object.
2121
def __init__(self):
2222
```
2323

24+
> [!IMPORTANT]
25+
> Instances of `CaptureVisionRouter` are not thread-safe.
26+
> Do not access the same `CaptureVisionRouter` instance from multiple threads concurrently.
27+
> Create a separate instance for each thread if concurrent processing is required.

0 commit comments

Comments
 (0)