Getting the Ping Period for the Exception Listener

Figure 16-62 Use Case Diagram: Getting the Ping Period for the Exception Listener
Text description of the illustration adq16jsi61.gif

To refer to the table of all basic operations having to do with the Operational Interface see: "Use Case Model: Operational Interface -- Basic Operations"

Purpose

Get the ping period for the Exception Listener.

Usage Notes

If an exception listener is set for the connection, the connection pings the database periodically to ensure that the database is accessible. The period is specified in milliseconds. The default value is 2 minutes. If an exception listener is not set for the connection, the database is not pinged. This method will return the value of the period set by the last call to setPingPeriod. If setPingPeriod was never called, then the default value is returned

Syntax

See Chapter 3, "AQ Programmatic Environments" for a list of available functions in each programmatic environment. Use the following syntax references for each programmatic environment:

• See Java (JDBC): Oracle9i Supplied Java Packages Reference, oracle.jms AQjmsConnection.getPingPeriod

Examples

//get the ping period
Connection jms_connection;
long pp = jms_connection.getPingPeriod();