org.bytedeco.tensorrt.nvinfer

Class IPluginRegistry

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorrt.nvinfer.IPluginRegistry

All Implemented Interfaces:

AutoCloseable

@Namespace(value="nvinfer1")
 @Properties(inherit=nvinfer.class)
public class IPluginRegistry
extends Pointer

\class IPluginRegistry \brief 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:

and IPluginCreator \warning Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI. \warning 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPluginRegistry.PluginLibraryHandle \brief Pointer for plugin library handle.

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
IPluginRegistry(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
IPluginResource	acquirePluginResource(BytePointer key, IPluginResource resource)
IPluginResource	acquirePluginResource(String key, IPluginResource resource) \brief Get a plugin resource
boolean	deregisterCreator(IPluginCreator creator) Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::deregisterCreator(IPluginCreatorInterface const&).
boolean	deregisterCreator(IPluginCreatorInterface creator) \brief Deregister a previously registered plugin creator.
void	deregisterLibrary(IPluginRegistry.PluginLibraryHandle handle) \brief Deregister plugins associated with a library.
PointerPointer	getAllCreators(IntPointer numCreators) \brief Return all registered plugin creators.
IPluginCreatorInterface	getCreator(BytePointer pluginName, BytePointer pluginVersion)
IPluginCreatorInterface	getCreator(BytePointer pluginName, BytePointer pluginVersion, BytePointer pluginNamespace)
IPluginCreatorInterface	getCreator(String pluginName, String pluginVersion)
IPluginCreatorInterface	getCreator(String pluginName, String pluginVersion, String pluginNamespace) \brief Return a registered plugin creator based on plugin name, version, and namespace associated with the plugin during network creation.
IErrorRecorder	getErrorRecorder() \brief Get the ErrorRecorder assigned to this interface.
IPluginCreator	getPluginCreator(BytePointer pluginName, BytePointer pluginVersion) Deprecated.
IPluginCreator	getPluginCreator(BytePointer pluginName, BytePointer pluginVersion, BytePointer pluginNamespace) Deprecated.
IPluginCreator	getPluginCreator(String pluginName, String pluginVersion) Deprecated.
IPluginCreator	getPluginCreator(String pluginName, String pluginVersion, String pluginNamespace) Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::getCreator(AsciiChar const* const, AsciiChar const* const, AsciiChar const* const).
PointerPointer	getPluginCreatorList(IntPointer numCreators) Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::getAllCreators(int32_t* const).
boolean	isParentSearchEnabled() \brief Return whether the parent registry will be searched if a plugin is not found in this registry default: true
IPluginRegistry.PluginLibraryHandle	loadLibrary(BytePointer pluginPath)
IPluginRegistry.PluginLibraryHandle	loadLibrary(String pluginPath) \brief Load and register a shared library of plugins.
boolean	registerCreator(IPluginCreator creator, BytePointer pluginNamespace) Deprecated.
boolean	registerCreator(IPluginCreatorInterface creator, BytePointer pluginNamespace)
boolean	registerCreator(IPluginCreatorInterface creator, String pluginNamespace) \brief Register a plugin creator.
boolean	registerCreator(IPluginCreator creator, String pluginNamespace) Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::registerCreator(IPluginCreatorInterface&, AsciiChar const* const).
int	releasePluginResource(BytePointer key)
int	releasePluginResource(String key) \brief Decrement reference count for the resource with this key If reference count goes to zero after decrement, release() will be invoked on the resource, the key will be deregistered and the resource object will be deleted
void	setErrorRecorder(IErrorRecorder recorder) \brief Set the ErrorRecorder for this interface Assigns the ErrorRecorder to this interface.
void	setParentSearchEnabled(boolean enabled) \brief Set whether the parent registry will be searched if a plugin is not found in this registry.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPluginRegistry

public IPluginRegistry(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

registerCreator

@Cast(value="bool")
 @Deprecated
 @NoException(value=true)
public boolean registerCreator(@ByRef
                                                                                             IPluginCreator creator,
                                                                                             String pluginNamespace)

Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::registerCreator(IPluginCreatorInterface&, AsciiChar const* const).

\brief Register a plugin creator implementing IPluginCreator. Returns false if any plugin creator with the same name, version or namespace is already registered. \warning The string pluginNamespace must be 1024 bytes or less including the NULL terminator and must be NULL terminated. \usage - Allowed context for the API call - Thread-safe: Yes; calls to this method will be synchronized by a mutex.

registerCreator

@Cast(value="bool")
 @Deprecated
 @NoException(value=true)
public boolean registerCreator(@ByRef
                                                                                             IPluginCreator creator,
                                                                                             @Cast(value="const char*")
                                                                                             BytePointer pluginNamespace)

Deprecated.

getPluginCreatorList

@Cast(value="nvinfer1::IPluginCreator*const*")
public PointerPointer getPluginCreatorList(IntPointer numCreators)

Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::getAllCreators(int32_t* const).

\brief Return all the registered plugin creators and the number of registered plugin creators. Returns nullptr if none found. \warning If any plugin creators are registered or deregistered after calling this function, the returned pointer is not guaranteed to be valid thereafter. \usage - Allowed context for the API call - Thread-safe: No

getPluginCreator

@Deprecated
 @NoException(value=true)
public IPluginCreator getPluginCreator(String pluginName,
                                                                               String pluginVersion,
                                                                               String pluginNamespace)

Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::getCreator(AsciiChar const* const, AsciiChar const* const, AsciiChar const* const).

\brief 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. \warning Returns nullptr if a plugin creator with matching name, version, and namespace is found, but is not a descendent of IPluginCreator \usage - Allowed context for the API call - Thread-safe: Yes

getPluginCreator

@Deprecated
 @NoException(value=true)
public IPluginCreator getPluginCreator(String pluginName,
                                                                               String pluginVersion)

Deprecated.

getPluginCreator

@Deprecated
 @NoException(value=true)
public IPluginCreator getPluginCreator(@Cast(value="const char*")
                                                                               BytePointer pluginName,
                                                                               @Cast(value="const char*")
                                                                               BytePointer pluginVersion,
                                                                               @Cast(value="const char*")
                                                                               BytePointer pluginNamespace)

Deprecated.

getPluginCreator

@Deprecated
 @NoException(value=true)
public IPluginCreator getPluginCreator(@Cast(value="const char*")
                                                                               BytePointer pluginName,
                                                                               @Cast(value="const char*")
                                                                               BytePointer pluginVersion)

Deprecated.

setErrorRecorder

@NoException(value=true)
public void setErrorRecorder(IErrorRecorder recorder)

\brief 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:

recorder - The error recorder to register with this interface.

See Also:

\usage - Allowed context for the API call - Thread-safe: No

getErrorRecorder

@NoException(value=true)
public IErrorRecorder getErrorRecorder()

\brief Get 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:

\usage - Allowed context for the API call - Thread-safe: Yes

deregisterCreator

@Cast(value="bool")
 @Deprecated
 @NoException(value=true)
public boolean deregisterCreator(@Const @ByRef
                                                                                               IPluginCreator creator)

Deprecated. Deprecated in TensorRT 10.0. Superseded by IPluginRegistry::deregisterCreator(IPluginCreatorInterface const&).

\brief Deregister a previously registered plugin creator implementing IPluginCreator. 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 \p 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 - Allowed context for the API call - Thread-safe: Yes

isParentSearchEnabled

@Cast(value="bool")
public boolean isParentSearchEnabled()

\brief Return whether the parent registry will be searched if a plugin is not found in this registry default: true

Returns:

bool variable indicating whether parent search is enabled.

See Also:

setParentSearchEnabled

setParentSearchEnabled

public void setParentSearchEnabled(@Cast(value="const bool")
                                   boolean enabled)

\brief Set whether the parent registry will be searched if a plugin is not found in this registry.

Parameters:

enabled - The bool variable indicating whether parent search is enabled.

See Also:

isParentSearchEnabled

loadLibrary

@NoException(value=true)
public IPluginRegistry.PluginLibraryHandle loadLibrary(String pluginPath)

\brief Load and register a shared library of plugins.

Parameters:

pluginPath - the plugin library path.

Returns:

The loaded plugin library handle. The call will fail and return nullptr if any of the plugins are already registered.

loadLibrary

@NoException(value=true)
public IPluginRegistry.PluginLibraryHandle loadLibrary(@Cast(value="const char*")
                                                                                 BytePointer pluginPath)

deregisterLibrary

@NoException(value=true)
public void deregisterLibrary(IPluginRegistry.PluginLibraryHandle handle)

\brief Deregister plugins associated with a library. Any resources acquired when the library was loaded will be released.

Parameters:

handle - the plugin library handle to deregister.

registerCreator

@Cast(value="bool")
 @NoException(value=true)
public boolean registerCreator(@ByRef
                                                                               IPluginCreatorInterface creator,
                                                                               String pluginNamespace)

\brief Register a plugin creator. Returns false if a plugin creator with the 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 - Allowed context for the API call - Thread-safe: Yes; calls to this method will be synchronized by a mutex.

registerCreator

@Cast(value="bool")
 @NoException(value=true)
public boolean registerCreator(@ByRef
                                                                               IPluginCreatorInterface creator,
                                                                               @Cast(value="const char*")
                                                                               BytePointer pluginNamespace)

getAllCreators

@Cast(value="nvinfer1::IPluginCreatorInterface*const*")
 @NoException(value=true)
public PointerPointer getAllCreators(IntPointer numCreators)

\brief Return all registered plugin creators. Returns nullptr if none found. \warning If any plugin creators are registered or deregistered after calling this function, the returned pointer is not guaranteed to be valid thereafter. \usage - Allowed context for the API call - Thread-safe: No

getCreator

@NoException(value=true)
public IPluginCreatorInterface getCreator(String pluginName,
                                                                    String pluginVersion,
                                                                    String pluginNamespace)

\brief Return a registered plugin creator based on plugin name, version, and namespace associated with the 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 - Allowed context for the API call - Thread-safe: Yes

getCreator

@NoException(value=true)
public IPluginCreatorInterface getCreator(String pluginName,
                                                                    String pluginVersion)

getCreator

@NoException(value=true)
public IPluginCreatorInterface getCreator(@Cast(value="const char*")
                                                                    BytePointer pluginName,
                                                                    @Cast(value="const char*")
                                                                    BytePointer pluginVersion,
                                                                    @Cast(value="const char*")
                                                                    BytePointer pluginNamespace)

getCreator

@NoException(value=true)
public IPluginCreatorInterface getCreator(@Cast(value="const char*")
                                                                    BytePointer pluginName,
                                                                    @Cast(value="const char*")
                                                                    BytePointer pluginVersion)

deregisterCreator

@Cast(value="bool")
 @NoException(value=true)
public boolean deregisterCreator(@Const @ByRef
                                                                                 IPluginCreatorInterface creator)

\brief 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 \p 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 - Allowed context for the API call - Thread-safe: Yes

acquirePluginResource

@NoException(value=true)
public IPluginResource acquirePluginResource(String key,
                                                                       IPluginResource resource)

\brief Get a plugin resource

Parameters:

key - Key for identifying the resource. Cannot be null.

resource - A plugin resource object. The object will only need to be valid until this method returns, as only a clone of this object will be registered by TRT. Cannot be null.

Returns:

Registered plugin resource object \usage - Allowed context for the API call - Thread-safe: Yes; calls to this method will be synchronized by a mutex.

acquirePluginResource

@NoException(value=true)
public IPluginResource acquirePluginResource(@Cast(value="const char*")
                                                                       BytePointer key,
                                                                       IPluginResource resource)

releasePluginResource

@NoException(value=true)
public int releasePluginResource(String key)

\brief Decrement reference count for the resource with this key If reference count goes to zero after decrement, release() will be invoked on the resource, the key will be deregistered and the resource object will be deleted

Parameters:

key - Key that was used to register the resource. Cannot be null.

Returns:

0 for success, else non-zero \usage - Allowed context for the API call - Thread-safe: Yes; calls to this method will be synchronized by a mutex.

releasePluginResource

@NoException(value=true)
public int releasePluginResource(@Cast(value="const char*")
                                                           BytePointer key)