Product Information > JADE Object Manager Guide > Chapter 4 - JADE System Instrumentation and Diagnosis > beginSample

beginSample

beginSample(libraryName:             String;
            initializationParameter: String): Integer;

The beginSample method of the Node class opens a new sampling context for the node, begins the accumulation of sampling statistics for that node, and invokes the following entry points.

This method returns the sampling handle number used to identify the sampling context that is opened. All subsequent methods use this sampling context handle as the first parameter.

When the beginSample method is called in your application, request statistics are stored in transient memory for every process in the node until they are passed to a corresponding entry point in the user library specified in the libraryName parameter.

The JADE-supplied library writes a record type (6) to the statistics file. For details about the node sampling entry points and the contents of the statistics sample files, see "JADE Sampling Libraries" and "Statistics File Format", later in this chapter.

If you are using the filesmpl or tcpsmpl JADE sampling library, you can set the initializationParameter parameter to "<null>" or to "" so that sample values will not be output. For filesmpl, the values will not be written to a file.

For tcpsmpl, the values will not be sent to a TCP/IP connection. Use this option in situations where node sampling needs to be enabled for the Process class getRequestStatistics method but no file or TCP/IP output is wanted. For more details, see "Direct Retrieval of Node Sampling Statistics", later in this chapter.