Application Programming Interfaces

This section describes the Application Programming Interfaces (APIs) USR0340N, USR0341N, USR3004N, USR4340N, USR4341N and USR4342N, which are used for handling Natural objects currently loaded in the buffer pool, the BP cache and/or the internal fast locate table. The APIs are supplied in the Natural system library SYSEXT.

For further information on these APIs, see the following:

  • The relevant Natural source object of the type Text and the example programs in the Natural system library SYSEXT.

  • The SYSBPM functions referenced in the table below.

Related Topic:

API Functionality
USR0340N

  • Deletes objects from the buffer pool and/or BP cache.

  • Marks objects as resident.

  • Removes the resident flag from objects.

  • Reads object directory information.

  • Retrieves general buffer pool statistics and buffer pool load/locate statistics.

Corresponding SYSBPM functions:

Delete Objects
List Objects
Directory Information
General Buffer Pool Statistics
Buffer Pool Load/Locate Statistics

USR0341N Collects garbage to clean up the buffer pool by removing objects which are no longer needed.

Selection criteria for specified objects are the relative age of an object. Relative age is the time the object has been loaded in the buffer pool which calculates from BP Last Action date. Minimum age is 30 minutes.

See also the SYSBPM function List Objects.

USR3004N Clears the internal fast locate table.

See also Internal Fast Locate Table.

USR4340N We recommend that you use this interface for batch processing instead of using the SYSBPM utility in batch.

Lists objects loaded in the buffer pool and/or BP cache sorted by Object Size (ObjSize), Total Use Count (TotalUC) or BP Last Action. BP Last Action only applies to the buffer pool.

Corresponding SYSBPM functions:

Display Sorted Extract
List Objects

USR4341N Maintains a blacklist of Natural objects, which are not to be executed and loaded into the buffer pool.

See also the SYSBPM function Blacklist Maintenance.

USR4342N

  • Deletes objects from the message pool.

  • Lists messages from the message pool.

  • Retrieves message pool statistics.

Corresponding SYSBPM functions:

Delete Objects
List Objects
Message Pool Statistics