TensorRT 8.4.1
nvinfer1::IPluginRegistry Class Referenceabstract

Single registration point for all plugins in an application. It is used to find plugin implementations during engine deserialization. Internally, the plugin registry is considered to be a singleton so all plugins in an application are part of the same global registry. Note that the plugin registry is only supported for plugins of type IPluginV2 and should also have a corresponding IPluginCreator implementation. More...

#include <NvInferRuntimeCommon.h>

Public Member Functions

virtual bool registerCreator (IPluginCreator &creator, AsciiChar const *const pluginNamespace) noexcept=0
 Register a plugin creator. Returns false if one with same type is already registered. More...
 
virtual IPluginCreator *const * getPluginCreatorList (int32_t *const numCreators) const noexcept=0
 Return all the registered plugin creators and the number of registered plugin creators. Returns nullptr if none found. More...
 
virtual IPluginCreatorgetPluginCreator (AsciiChar const *const pluginName, AsciiChar const *const pluginVersion, AsciiChar const *const pluginNamespace="") noexcept=0
 Return plugin creator based on plugin name, version, and namespace associated with plugin during network creation. More...
 
virtual void setErrorRecorder (IErrorRecorder *const recorder) noexcept=0
 Set the ErrorRecorder for this interface. More...
 
virtual IErrorRecordergetErrorRecorder () const noexcept=0
 Set the ErrorRecorder assigned to this interface. More...
 
virtual bool deregisterCreator (IPluginCreator const &creator) noexcept=0
 Deregister a previously registered plugin creator. More...
 

Protected Member Functions

virtual ~IPluginRegistry () noexcept=default
 

Detailed Description

Single registration point for all plugins in an application. It is used to find plugin implementations during engine deserialization. Internally, the plugin registry is considered to be a singleton so all plugins in an application are part of the same global registry. Note that the plugin registry is only supported for plugins of type IPluginV2 and should also have a corresponding IPluginCreator implementation.

See also
IPluginV2 and IPluginCreator
Warning
Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.
In the automotive safety context, be sure to call IPluginRegistry::setErrorRecorder() to register an error recorder with the registry before using other methods in the registry.

Constructor & Destructor Documentation

◆ ~IPluginRegistry()

virtual nvinfer1::IPluginRegistry::~IPluginRegistry ( )
protectedvirtualdefaultnoexcept

Member Function Documentation

◆ deregisterCreator()

virtual bool nvinfer1::IPluginRegistry::deregisterCreator ( IPluginCreator const &  creator)
pure virtualnoexcept

Deregister a previously registered plugin creator.

Since there may be a desire to limit the number of plugins, this function provides a mechanism for removing plugin creators registered in TensorRT. The plugin creator that is specified by creator is removed from TensorRT and no longer tracked.

Returns
True if the plugin creator was deregistered, false if it was not found in the registry or otherwise could not be deregistered.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes

◆ getErrorRecorder()

virtual IErrorRecorder * nvinfer1::IPluginRegistry::getErrorRecorder ( ) const
pure virtualnoexcept

Set the ErrorRecorder assigned to this interface.

Retrieves the assigned error recorder object for the given class. A default error recorder does not exist, so a nullptr will be returned if setErrorRecorder has not been called, or an ErrorRecorder has not been inherited.

Returns
A pointer to the IErrorRecorder object that has been registered.
See also
setErrorRecorder()


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes

◆ getPluginCreator()

virtual IPluginCreator * nvinfer1::IPluginRegistry::getPluginCreator ( AsciiChar const *const  pluginName,
AsciiChar const *const  pluginVersion,
AsciiChar const *const  pluginNamespace = "" 
)
pure virtualnoexcept

Return plugin creator based on plugin name, version, and namespace associated with plugin during network creation.

Warning
The strings pluginName, pluginVersion, and pluginNamespace must be 1024 bytes or less including the NULL terminator and must be NULL terminated.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes

◆ getPluginCreatorList()

virtual IPluginCreator *const * nvinfer1::IPluginRegistry::getPluginCreatorList ( int32_t *const  numCreators) const
pure virtualnoexcept

Return all the registered plugin creators and the number of registered plugin creators. Returns nullptr if none found.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: No

◆ registerCreator()

virtual bool nvinfer1::IPluginRegistry::registerCreator ( IPluginCreator creator,
AsciiChar const *const  pluginNamespace 
)
pure virtualnoexcept

Register a plugin creator. Returns false if one with same type is already registered.

Warning
The string pluginNamespace must be 1024 bytes or less including the NULL terminator and must be NULL terminated.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes; calls to this method will be synchronized by a mutex.

◆ setErrorRecorder()

virtual void nvinfer1::IPluginRegistry::setErrorRecorder ( IErrorRecorder *const  recorder)
pure virtualnoexcept

Set the ErrorRecorder for this interface.

Assigns the ErrorRecorder to this interface. The ErrorRecorder will track all errors during execution. This function will call incRefCount of the registered ErrorRecorder at least once. Setting recorder to nullptr unregisters the recorder with the interface, resulting in a call to decRefCount if a recorder has been registered.

Parameters
recorderThe error recorder to register with this interface.
See also
getErrorRecorder()


Usage considerations

  • Allowed context for the API call
    • Thread-safe: No

The documentation for this class was generated from the following file: