jpool-statistics

Arguments: &key new sum error-p slot pool

This operator was added in a patch release in late July, 2013. That patch upgraded jlinker to version 7.1. See jlinker.htm for more information on the patch and version 7.1.

This function accesses or manages statistics maintained by jlinker about the behavior and performance of the connection pool.

If the sum argument is specified, it must be a pool statistics instance obtained in a previous call to jpool-statistics.

If the slot argument is non-nil, it must be one of the following keywords to retrieve the corresponding value from a statistics instance. When slot is non-nil, the new argument is ignored. If sum is specified (as a statistics instance), the value returned comes from that instance. If sum is nil or unspecified, the value comes from the current pool.

• :active: number of Lisp ports to Java in use at some moment.
• :max: maximum number of Lisp ports to Java in use.
• :wait: number of seconds spent waiting for a Lisp port to Java.
• :free: number of times a port was obtained for a call.
• :busy: number of times a caller was told all ports are busy.

The following slots refer to non-pool and pool ports combined:

• :idle-wait: number of times a port was available after waiting.
• :idle-free: number of times a port was available without waiting.
• :idle-busy: number of times a port was not available.

If the slot argument is omitted or nil, the return value is always a new pool statistics instance in which the values are copied atomically from the current pool. When sum is specified, it is updated from the current value as a side-effect. The :max slot is the maximum of two, the other slots are sums. (To be clear: when slot is nil, the return value is always a new statistics instance. When sum is also a statistics instance, that instance is updated but not returned.)

If the new argument is non-nil, the current pool statistics are reset to zero.

The pool argument is reserved for internal use and must not be specified.

See jlinker.htm for more information on the jLinker facility.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page is new in the 9.0 release.
Created 2019.8.20.