summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2023-06-23 14:45:37 -0400
committerPeter LaFosse <peter@vector35.com>2023-06-23 14:45:51 -0400
commitf2430c57b19d1ff3fb4bcaf2f8c511e4d2a05d56 (patch)
tree89e8bab8b55864128ef542d7dc19822e0ce3e5e3 /python/binaryview.py
parenta50e039e34a6909d33c886d2d8ba9c35fa53e974 (diff)
Add warnings around the use of add_binaryview_initial_analysis_completion_event and add_binaryview_finalized_event
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 586c9f6e..2735e882 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -1307,6 +1307,9 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass):
`add_binaryview_finalized_event` adds a callback that gets executed
when new binaryview is finalized.
For more details, please refer to the documentation of BinaryViewEvent.
+
+ .. warning:: The callback provided **must** stay in scope for the lifetime of the process, deletion or \
+ garbage collection of the callback will result in a crash.
"""
BinaryViewEvent.register(BinaryViewEventType.BinaryViewFinalizationEvent, callback)
@@ -1317,6 +1320,9 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass):
that gets executed after the initial analysis, as well as linear
sweep and signature matcher (if they are configured to run) completed.
For more details, please refer to the documentation of BinaryViewEvent.
+
+ .. warning:: The callback provided **must** stay in scope for the lifetime of the process, deletion or \
+ garbage collection of the callback will result in a crash.
"""
BinaryViewEvent.register(BinaryViewEventType.BinaryViewInitialAnalysisCompletionEvent, callback)