Home Original page

Binary Ninja API C++: NotificationsWorker Class Reference

Public Member Functions

 NotificationsWorker ()=delete
 NotificationsWorker (BinaryViewRef view, NotificationTypes notifications)
void setAnalysisCachingEnabled (bool enable)
void setNotificationEventQueuing (bool enable)
void setUpdateHandler (std::function< void(bool refresh, std::vector< NotificationEvent > &&)> &&updateHandler)
void asyncRefresh ()
void cancel ()
template<typename... Args>
void enqueue (NotificationType notification, Args &&... args)
uint64_t OnNotificationBarrier (BinaryNinja::BinaryView *view) override
void OnBinaryDataWritten (BinaryNinja::BinaryView *view, uint64_t offset, size_t len) override
void OnBinaryDataInserted (BinaryNinja::BinaryView *view, uint64_t offset, size_t len) override
void OnBinaryDataRemoved (BinaryNinja::BinaryView *view, uint64_t offset, uint64_t len) override
void OnAnalysisFunctionAdded (BinaryNinja::BinaryView *view, BinaryNinja::Function *func) override
void OnAnalysisFunctionRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Function *func) override
void OnAnalysisFunctionUpdated (BinaryNinja::BinaryView *view, BinaryNinja::Function *func) override
void OnAnalysisFunctionUpdateRequested (BinaryNinja::BinaryView *view, BinaryNinja::Function *func) override
void OnDataVariableAdded (BinaryNinja::BinaryView *view, const BinaryNinja::DataVariable &var) override
void OnDataVariableRemoved (BinaryNinja::BinaryView *view, const BinaryNinja::DataVariable &var) override
void OnDataVariableUpdated (BinaryNinja::BinaryView *view, const BinaryNinja::DataVariable &var) override
void OnDataMetadataUpdated (BinaryNinja::BinaryView *view, uint64_t offset) override
void OnTagTypeUpdated (BinaryNinja::BinaryView *view, BinaryNinja::Ref< BinaryNinja::TagType > tagTypeRef) override
void OnTagAdded (BinaryNinja::BinaryView *view, const BinaryNinja::TagReference &tagRef) override
void OnTagRemoved (BinaryNinja::BinaryView *view, const BinaryNinja::TagReference &tagRef) override
void OnTagUpdated (BinaryNinja::BinaryView *view, const BinaryNinja::TagReference &tagRef) override
void OnSymbolAdded (BinaryNinja::BinaryView *view, BinaryNinja::Symbol *sym) override
void OnSymbolRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Symbol *sym) override
void OnSymbolUpdated (BinaryNinja::BinaryView *view, BinaryNinja::Symbol *sym) override
void OnStringFound (BinaryNinja::BinaryView *view, BNStringType type, uint64_t offset, size_t len) override
void OnStringRemoved (BinaryNinja::BinaryView *view, BNStringType type, uint64_t offset, size_t len) override
void OnTypeDefined (BinaryNinja::BinaryView *view, const BinaryNinja::QualifiedName &name, BinaryNinja::Type *type) override
void OnTypeUndefined (BinaryNinja::BinaryView *view, const BinaryNinja::QualifiedName &name, BinaryNinja::Type *type) override
void OnTypeReferenceChanged (BinaryNinja::BinaryView *view, const BinaryNinja::QualifiedName &name, BinaryNinja::Type *type) override
void OnTypeFieldReferenceChanged (BinaryNinja::BinaryView *view, const BinaryNinja::QualifiedName &name, uint64_t offset) override
void OnSegmentAdded (BinaryNinja::BinaryView *view, BinaryNinja::Segment *segment) override
void OnSegmentRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Segment *segment) override
void OnSegmentUpdated (BinaryNinja::BinaryView *view, BinaryNinja::Segment *segment) override
void OnSectionAdded (BinaryNinja::BinaryView *view, BinaryNinja::Section *section) override
void OnSectionRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Section *section) override
void OnSectionUpdated (BinaryNinja::BinaryView *view, BinaryNinja::Section *section) override
void OnComponentAdded (BinaryNinja::BinaryView *view, BinaryNinja::Component *component) override
 This notification is posted after a Component is added to the tree.
void OnComponentRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Component *component, BinaryNinja::Component *) override
 This notification is posted after a Component is removed from the tree.
void OnComponentNameUpdated (BinaryNinja::BinaryView *view, std::string &previousName, BinaryNinja::Component *component) override
 This notification is posted after the display name for a component is updated.
void OnComponentMoved (BinaryNinja::BinaryView *view, BinaryNinja::Component *parent, BinaryNinja::Component *, BinaryNinja::Component *component) override
 This notification is posted whenever a component is moved from one component to another.
void OnComponentFunctionAdded (BinaryNinja::BinaryView *view, BinaryNinja::Component *component, BinaryNinja::Function *func) override
 This notification is posted whenever a Function is added to a Component.
void OnComponentFunctionRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Component *component, BinaryNinja::Function *func) override
 This notification is posted whenever a Function is removed from a Component.
void OnComponentDataVariableAdded (BinaryNinja::BinaryView *view, BinaryNinja::Component *component, const BinaryNinja::DataVariable &var) override
 This notification is posted whenever a DataVariable is added to a Component.
void OnComponentDataVariableRemoved (BinaryNinja::BinaryView *view, BinaryNinja::Component *component, const BinaryNinja::DataVariable &var) override
 This notification is posted whenever a DataVariable is removed from a Component.
void OnExternalLibraryAdded (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLibrary *library) override
void OnExternalLibraryRemoved (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLibrary *library) override
void OnExternalLibraryUpdated (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLibrary *library) override
void OnExternalLocationAdded (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLocation *location) override
void OnExternalLocationRemoved (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLocation *location) override
void OnExternalLocationUpdated (BinaryNinja::BinaryView *data, BinaryNinja::ExternalLocation *location) override
void OnTypeArchiveAttached (BinaryNinja::BinaryView *data, const std::string &id, const std::string &path) override
 This notification is posted whenever a Type Archive is attached to a Binary View.
void OnTypeArchiveDetached (BinaryNinja::BinaryView *data, const std::string &id, const std::string &path) override
 This notification is posted whenever a Type Archive is detached to a Binary View.
void OnTypeArchiveConnected (BinaryNinja::BinaryView *data, BinaryNinja::TypeArchive *archive) override
 This notification is posted whenever a previously disconnected Type Archive attached to the Binary View is connected.
void OnTypeArchiveDisconnected (BinaryNinja::BinaryView *data, BinaryNinja::TypeArchive *archive) override
 This notification is posted whenever a previously connected Type Archive attached to the Binary View is disconnected.
void OnUndoEntryAdded (BinaryNinja::BinaryView *data, BinaryNinja::UndoEntry *entry) override
 This notification is posted whenever an entry is added to undo history.
void OnUndoEntryTaken (BinaryNinja::BinaryView *data, BinaryNinja::UndoEntry *entry) override
 This notification is posted whenever an action is undone.
void OnRedoEntryTaken (BinaryNinja::BinaryView *data, BinaryNinja::UndoEntry *entry) override
 This notification is posted whenever an action is redone.
Public Member Functions inherited from BinaryNinja::BinaryDataNotification
 BinaryDataNotification ()
 BinaryDataNotification (NotificationTypes notifications)
virtual ~BinaryDataNotification ()
BNBinaryDataNotification * GetCallbacks ()
virtual void OnDerivedStringFound (BinaryView *data, const DerivedString &str)
virtual void OnDerivedStringRemoved (BinaryView *data, const DerivedString &str)
virtual void OnRebased (BinaryView *oldView, BinaryView *newView)
 This notification is posted whenever a binary view is rebased.

Additional Inherited Members

Public Types inherited from BinaryNinja::BinaryDataNotification
enum  NotificationType : uint64_t {
  NotificationBarrier = 1ULL << 0 , DataWritten = 1ULL << 1 , DataInserted = 1ULL << 2 , DataRemoved = 1ULL << 3 ,
  FunctionAdded = 1ULL << 4 , FunctionRemoved = 1ULL << 5 , FunctionUpdated = 1ULL << 6 , FunctionUpdateRequested = 1ULL << 7 ,
  DataVariableAdded = 1ULL << 8 , DataVariableRemoved = 1ULL << 9 , DataVariableUpdated = 1ULL << 10 , DataMetadataUpdated = 1ULL << 11 ,
  TagTypeUpdated = 1ULL << 12 , TagAdded = 1ULL << 13 , TagRemoved = 1ULL << 14 , TagUpdated = 1ULL << 15 ,
  SymbolAdded = 1ULL << 16 , SymbolRemoved = 1ULL << 17 , SymbolUpdated = 1ULL << 18 , StringFound = 1ULL << 19 ,
  StringRemoved = 1ULL << 20 , TypeDefined = 1ULL << 21 , TypeUndefined = 1ULL << 22 , TypeReferenceChanged = 1ULL << 23 ,
  TypeFieldReferenceChanged = 1ULL << 24 , SegmentAdded = 1ULL << 25 , SegmentRemoved = 1ULL << 26 , SegmentUpdated = 1ULL << 27 ,
  SectionAdded = 1ULL << 28 , SectionRemoved = 1ULL << 29 , SectionUpdated = 1ULL << 30 , ComponentNameUpdated = 1ULL << 31 ,
  ComponentAdded = 1ULL << 32 , ComponentRemoved = 1ULL << 33 , ComponentMoved = 1ULL << 34 , ComponentFunctionAdded = 1ULL << 35 ,
  ComponentFunctionRemoved = 1ULL << 36 , ComponentDataVariableAdded = 1ULL << 37 , ComponentDataVariableRemoved = 1ULL << 38 , ExternalLibraryAdded = 1ULL << 39 ,
  ExternalLibraryRemoved = 1ULL << 40 , ExternalLibraryUpdated = 1ULL << 41 , ExternalLocationAdded = 1ULL << 42 , ExternalLocationRemoved = 1ULL << 43 ,
  ExternalLocationUpdated = 1ULL << 44 , TypeArchiveAttached = 1ULL << 45 , TypeArchiveDetached = 1ULL << 46 , TypeArchiveConnected = 1ULL << 47 ,
  TypeArchiveDisconnected = 1ULL << 48 , UndoEntryAdded = 1ULL << 49 , UndoEntryTaken = 1ULL << 50 , RedoEntryTaken = 1ULL << 51 ,
  Rebased = 1ULL << 52 , DerivedStringFound = 1ULL << 53 , DerivedStringRemoved = 1ULL << 54 , BinaryDataUpdates = DataWritten | DataInserted | DataRemoved ,
  FunctionLifetime = FunctionAdded | FunctionRemoved , FunctionUpdates = FunctionLifetime | FunctionUpdated , DataVariableLifetime = DataVariableAdded | DataVariableRemoved , DataVariableUpdates = DataVariableLifetime | DataVariableUpdated ,
  TagLifetime = TagAdded | TagRemoved , TagUpdates = TagLifetime | TagUpdated , SymbolLifetime = SymbolAdded | SymbolRemoved , SymbolUpdates = SymbolLifetime | SymbolUpdated ,
  StringUpdates = StringFound | StringRemoved | DerivedStringFound | DerivedStringRemoved , TypeLifetime = TypeDefined | TypeUndefined , TypeUpdates = TypeLifetime | TypeReferenceChanged | TypeFieldReferenceChanged , SegmentLifetime = SegmentAdded | SegmentRemoved ,
  SegmentUpdates = SegmentLifetime | SegmentUpdated , SectionLifetime = SectionAdded | SectionRemoved , SectionUpdates = SectionLifetime | SectionUpdated , ComponentUpdates = ComponentNameUpdated | ComponentAdded | ComponentRemoved | ComponentMoved | ComponentFunctionAdded | ComponentFunctionRemoved | ComponentDataVariableAdded | ComponentDataVariableRemoved ,
  ExternalLibraryLifetime = ExternalLibraryAdded | ExternalLibraryRemoved , ExternalLibraryUpdates = ExternalLibraryLifetime | ExternalLibraryUpdated , ExternalLocationLifetime = ExternalLocationAdded | ExternalLocationRemoved , ExternalLocationUpdates = ExternalLocationLifetime | ExternalLocationUpdated ,
  TypeArchiveUpdates = TypeArchiveAttached | TypeArchiveDetached | TypeArchiveConnected | TypeArchiveDisconnected , UndoUpdates = UndoEntryAdded | UndoEntryTaken | RedoEntryTaken
}
using NotificationTypes = uint64_t
NotificationsWorker::NotificationsWorker ( )
delete

◆ NotificationsWorker() [2/2]

◆ setAnalysisCachingEnabled()

void NotificationsWorker::setAnalysisCachingEnabled ( bool enable)
inline

◆ setNotificationEventQueuing()

void NotificationsWorker::setNotificationEventQueuing ( bool enable)
inline

◆ setUpdateHandler()

void NotificationsWorker::setUpdateHandler ( std::function< void(bool refresh, std::vector< NotificationEvent > &&)> && updateHandler)
inline

◆ asyncRefresh()

void NotificationsWorker::asyncRefresh ( )

◆ cancel()

void NotificationsWorker::cancel ( )

◆ enqueue()

template<typename... Args>

void NotificationsWorker::enqueue ( NotificationType notification,
Args &&... args )
inline

◆ OnNotificationBarrier()

◆ OnBinaryDataWritten()

void NotificationsWorker::OnBinaryDataWritten ( BinaryNinja::BinaryView * view,
uint64_t offset,
size_t len )
overridevirtual

◆ OnBinaryDataInserted()

void NotificationsWorker::OnBinaryDataInserted ( BinaryNinja::BinaryView * view,
uint64_t offset,
size_t len )
overridevirtual

◆ OnBinaryDataRemoved()

void NotificationsWorker::OnBinaryDataRemoved ( BinaryNinja::BinaryView * view,
uint64_t offset,
uint64_t len )
overridevirtual

◆ OnAnalysisFunctionAdded()

◆ OnAnalysisFunctionRemoved()

◆ OnAnalysisFunctionUpdated()

◆ OnAnalysisFunctionUpdateRequested()

◆ OnDataVariableAdded()

◆ OnDataVariableRemoved()

◆ OnDataVariableUpdated()

◆ OnDataMetadataUpdated()

◆ OnTagTypeUpdated()

◆ OnTagAdded()

◆ OnTagRemoved()

◆ OnTagUpdated()

◆ OnSymbolAdded()

◆ OnSymbolRemoved()

◆ OnSymbolUpdated()

◆ OnStringFound()

◆ OnStringRemoved()

◆ OnTypeDefined()

◆ OnTypeUndefined()

◆ OnTypeReferenceChanged()

◆ OnTypeFieldReferenceChanged()

◆ OnSegmentAdded()

◆ OnSegmentRemoved()

◆ OnSegmentUpdated()

◆ OnSectionAdded()

◆ OnSectionRemoved()

◆ OnSectionUpdated()

◆ OnComponentAdded()

This notification is posted after a Component is added to the tree.

Parameters
dataBinaryView the Component was added to
componentComponent which was added.

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentRemoved()

This notification is posted after a Component is removed from the tree.

Parameters
dataBinaryView the Component was removed from
formerParentFormer parent of the Component
component

The removed and now "dead" Component object.

This "dead" Component can no longer be moved to other components or have components added to it. It should not be used after this point for storing any objects, and will be destroyed once no more references are held to it.

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentNameUpdated()

This notification is posted after the display name for a component is updated.

Parameters
dataBinaryView the Component is contained in
previousNamePrevious name of the component
componentThe component which was modified.

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentMoved()

This notification is posted whenever a component is moved from one component to another.

Parameters
dataBinaryView the Component was removed from
formerParentFormer parent of the Component
newParentNew parent which the Component was moved to
componentThe component that was moved.

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentFunctionAdded()

This notification is posted whenever a Function is added to a Component.

Parameters
dataBinaryView containing the Component and Function
componentComponent the Function was added to
functionThe Function which was added

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentFunctionRemoved()

This notification is posted whenever a Function is removed from a Component.

Parameters
dataBinaryView containing the Component and Function
componentComponent the Function was removed from
functionThe Function which was removed

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentDataVariableAdded()

This notification is posted whenever a DataVariable is added to a Component.

Parameters
dataBinaryView containing the Component and DataVariable
componentComponent the DataVariable was added to
varThe DataVariable which was added

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnComponentDataVariableRemoved()

This notification is posted whenever a DataVariable is removed from a Component.

Parameters
dataBinaryView containing the Component and DataVariable
componentComponent the DataVariable was removed from
varThe DataVariable which was removed

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnExternalLibraryAdded()

◆ OnExternalLibraryRemoved()

◆ OnExternalLibraryUpdated()

◆ OnExternalLocationAdded()

◆ OnExternalLocationRemoved()

◆ OnExternalLocationUpdated()

◆ OnTypeArchiveAttached()

void NotificationsWorker::OnTypeArchiveAttached ( BinaryNinja::BinaryView * data,
const std::string & id,
const std::string & path )
overridevirtual

This notification is posted whenever a Type Archive is attached to a Binary View.

Parameters
dataBinaryView target
idId of the attached archive
pathPath on disk of the attached archive

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnTypeArchiveDetached()

void NotificationsWorker::OnTypeArchiveDetached ( BinaryNinja::BinaryView * data,
const std::string & id,
const std::string & path )
overridevirtual

This notification is posted whenever a Type Archive is detached to a Binary View.

Parameters
dataBinaryView target
idId of the attached archive
pathPath on disk of the attached archive

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnTypeArchiveConnected()

This notification is posted whenever a previously disconnected Type Archive attached to the Binary View is connected.

Parameters
dataBinaryView the archive is attached to
archiveAttached archive

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnTypeArchiveDisconnected()

This notification is posted whenever a previously connected Type Archive attached to the Binary View is disconnected.

Parameters
dataBinaryView the archive is attached to
archivePreviously attached archive

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnUndoEntryAdded()

This notification is posted whenever an entry is added to undo history.

Parameters
dataBinaryView the action was taken on
entryUndoEntry

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnUndoEntryTaken()

This notification is posted whenever an action is undone.

Parameters
dataBinaryView the action was taken on
entryUndoEntry that was undone

Reimplemented from BinaryNinja::BinaryDataNotification.

◆ OnRedoEntryTaken()

This notification is posted whenever an action is redone.

Parameters
dataBinaryView the action was taken on
entryUndoEntry that was redone

Reimplemented from BinaryNinja::BinaryDataNotification.