Node::getRpcServerStatistics Method

getRpcServerStatistics(jdo:      JadeDynamicObject input
                       detailed: Boolean);

The Node class getRpcServerStatistics method retrieves RPC statistics relating to activity between the database server node and the client node represented by the Node instance used as the method receiver.

The values returned represent information about the connection to the specified node and totals for requests received and replies sent to it.

The values are returned as Integer64 properties in the dynamic object specified by the jdo parameter.

The detailed parameter specifies whether the values returned should include individual totals for each request type.

If the value of the detailed parameter is false, the properties listed in the following table are returned in the dynamic object.

Property Type Description
timeStarted TimeStamp The time at which the connection to the client node was established
connectionType Integer Zero (0) for TCP/IP, 1 for shared memory
lastInboundRequest TimeStamp The time at which the most recent request from the client node was received
requestsFromClients Integer64 The total number of requests from the client node
repliesToClients Integer64 The total number of replies sent to the client node
requestPacketsFromClients Integer64 The total number of separate request packets received from the client node
replyPacketsToClients Integer64 The total number of separate reply packets sent to the client node
requestBytesFromClients Integer64 The total number of bytes received for requests from the client node
replyBytesToClients Integer64 The total number of bytes sent for replies to the client node
requestsToClients Integer64 The total number of requests sent to the client node
repliesFromClients Integer64 The total number of replies received from the client node
requestPacketsToClients Integer64 The total number of separate request packets sent to the client node
replyPacketsFromClients Integer64 The total number of separate reply packets received from the client node
requestBytesToClients Integer64 The total number of bytes sent for requests to the client node
replyBytesFromClients Integer64 The total number of bytes received for replies from the client node
notificationPacketsToClients Integer64 The total number of separate packets sent to the client node for notification delivery
notificationBytesToClients Integer64 The total number of bytes sent to the client node for notification delivery

If the value of the detailed parameter is true, the additional properties listed in the following table are returned in the dynamic object.

Property Type Description
— Number of requests from the client node —  
reqsFromClnt_initialize Integer64 Node initialize
reqsFromClnt_finalize Integer64 Node finalize
reqsFromClnt_signOn Integer64 Sign on process
reqsFromClnt_signOff Integer64 Sign off process
reqsFromClnt_chgAccessMode Integer64 Change access mode
reqsFromClnt_setSchema Integer64 Set schema
reqsFromClnt_setExecInsts Integer64 Set exec instances
reqsFromClnt_openFile Integer64 Open a file
reqsFromClnt_closeFile Integer64 Close a file
reqsFromClnt_beginTrans Integer64 beginTransaction
reqsFromClnt_endTrans Integer64 commitTransaction
reqsFromClnt_abortTrans Integer64 abortTransaction
reqsFromClnt_getOid Integer64 Get an oid
reqsFromClnt_getEdition Integer64 Get an edition
reqsFromClnt_getObject Integer64 Get an object
reqsFromClnt_getObjGroup Integer64 Get a group of objects
reqsFromClnt_putObject Integer64 Send object to database
reqsFromClnt_lockObject Integer64 Lock an object
reqsFromClnt_lockObjGroup Integer64 Lock a group of objects
reqsFromClnt_unlockObject Integer64 Unlock an object
reqsFromClnt_UnlockObjGroup Integer64 Unlock a group of objects
reqsFromClnt_removeLocks Integer64 Remove all locks for a process
reqsFromClnt_sendMsg Integer64 Send a message, that is execute a method
reqsFromClnt_sendDbMsg Integer64 Special database request
reqsFromClnt_beginNote Integer64 beginNotification
reqsFromClnt_returnNotes Integer64 Send pending notifications
reqsFromClnt_queryNote Integer64 Query notifications
reqsFromClnt_endNote Integer64 endNotification
reqsFromClnt_causeEvent Integer64 causeEvent
reqsFromClnt_acquireSchema Integer64 Acquire a schema
reqsFromClnt_releaseSchema Integer64 Release a schema
reqsFromClnt_authRequest Integer64 Authorization request
reqsFromClnt_authChallenge Integer64 Authorization challenge
reqsFromClnt_authResponse Integer64 Authorization response
reqsFromClnt_getReplyCont Integer64 Retrieve next portion of large reply
reqsFromClnt_acquireClass Integer64 Acquire a class
reqsFromClnt_releaseClass Integer64 Release a class
reqsFromClnt_canUpdateClass Integer64 Query if class can be updated
reqsFromClnt_beginLoad Integer64 Begin load state
reqsFromClnt_endLoad Integer64 End load state
reqsFromClnt_beginLock Integer64 Begin lock state
reqsFromClnt_endLock Integer64 End lock state
reqsFromClnt_flushBuffObjs Integer64 Force buffered objects to be sent to the database
reqsFromClnt_commitTrans Integer64 Prepare to commit a transaction
reqsFromClnt_getObjBranches Integer64 Versioning – get object branches
reqsFromClnt_getBranchObjs Integer64 Versioning – get branch objects
reqsFromClnt_getBranchObjOid Integer64 Versioning – get branch object oid
reqsFromClnt_getLastBranch Integer64 Versioning – get last branch
reqsFromClnt_getLatestVnOid Integer64 Versioning – get latest version oid
reqsFromClnt_getLatestEdtn Integer64 Versioning – get latest edition
reqsFromClnt_mgmtRequest Integer64 Special administrative request
reqsFromClnt_unknown Integer64 Unknown request type
— Number of replies to the client node —  
repliesToClnt_initialize Integer64 Node initialize
repliesToClnt_finalize Integer64 Node finalize
repliesToClnt_signOn Integer64 Sign on process
repliesToClnt_signOff Integer64 Sign off process
repliesToClnt_chgAccessMode Integer64 Change access mode
repliesToClnt_setSchema Integer64 Set schema
repliesToClnt_setExecInsts Integer64 Set exec instances
repliesToClnt_openFile Integer64 Open a file
repliesToClnt_closeFile Integer64 Close a file
repliesToClnt_beginTrans Integer64 beginTransaction
repliesToClnt_endTrans Integer64 commitTransaction
repliesToClnt_abortTrans Integer64 abortTransaction
repliesToClnt_getOid Integer64 Get an oid
repliesToClnt_getEdition Integer64 Get an edition
repliesToClnt_getObject Integer64 Get an object
repliesToClnt_getObjGroup Integer64 Get a group of objects
repliesToClnt_putObject Integer64 Send object to database
repliesToClnt_lockObject Integer64 Lock an object
repliesToClnt_lockObjGroup Integer64 Lock a group of objects
repliesToClnt_unlockObject Integer64 Unlock an object
repliesToClnt_UnlockObjGroup Integer64 Unlock a group of objects
repliesToClnt_removeLocks Integer64 Remove all locks for a process
repliesToClnt_sendMsg Integer64 Send a message, that is execute a method
repliesToClnt_sendDbMsg Integer64 Special database request
repliesToClnt_beginNote Integer64 beginNotification
repliesToClnt_returnNotes Integer64 Send pending notifications
repliesToClnt_queryNote Integer64 Query notifications
repliesToClnt_endNote Integer64 endNotification
repliesToClnt_causeEvent Integer64 causeEvent
repliesToClnt_acquireSchema Integer64 Acquire a schema
repliesToClnt_releaseSchema Integer64 Release a schema
repliesToClnt_authRequest Integer64 Authorization request
repliesToClnt_authChallenge Integer64 Authorization challenge
repliesToClnt_authResponse Integer64 Authorization response
repliesToClnt_getReplyCont Integer64 Retrieve next portion of large reply
repliesToClnt_acquireClass Integer64 Acquire a class
repliesToClnt_releaseClass Integer64 Release a class
repliesToClnt_canUpdateClass Integer64 Query if class can be updated
repliesToClnt_beginLoad Integer64 Begin load state
repliesToClnt_endLoad Integer64 End load state
repliesToClnt_beginLock Integer64 Begin lock state
repliesToClnt_endLock Integer64 End lock state
repliesToClnt_flushBuffObjs Integer64 Force buffered objects to be sent to the database
repliesToClnt_commitTrans Integer64 Prepare to commit a transaction
repliesToClnt_getObjBranches Integer64 Versioning – get object branches
repliesToClnt_getBranchObjs Integer64 Versioning – get branch objects
repliesToClnt_getBranchObjOid Integer64 Versioning – get branch object oid
repliesToClnt_getLastBranch Integer64 Versioning – get last branch
repliesToClnt_getLatestVnOid Integer64 Versioning – get latest version oid
repliesToClnt_getLatestEdtn Integer64 Versioning – get latest edition
repliesToClnt_mgmtRequest Integer64 Special administrative request
repliesToClnt_unknown Integer64 Unknown request type
— Total elapsed time for processing requests from the client node (in microseconds) —
reqsElapsedTime _initialize Integer64 Node initialize
reqsElapsedTime _finalize Integer64 Node finalize
reqsElapsedTime _signOn Integer64 Sign on process
reqsElapsedTime _signOff Integer64 Sign off process
reqsElapsedTime _chgAccessMode Integer64 Change access mode
reqsElapsedTime _setSchema Integer64 Set schema
reqsElapsedTime _setExecInsts Integer64 Set exec instances
reqsElapsedTime _openFile Integer64 Open a file
reqsElapsedTime _closeFile Integer64 Close a file
reqsElapsedTime _beginTrans Integer64 beginTransaction
reqsElapsedTime _endTrans Integer64 commitTransaction
reqsElapsedTime _abortTrans Integer64 abortTransaction
reqsElapsedTime _getOid Integer64 Get an oid
reqsElapsedTime _getEdition Integer64 Get an edition
reqsElapsedTime _getObject Integer64 Get an object
reqsElapsedTime _getObjGroup Integer64 Get a group of objects
reqsElapsedTime _putObject Integer64 Send object to database
reqsElapsedTime _lockObject Integer64 Lock an object
reqsElapsedTime _lockObjGroup Integer64 Lock a group of objects
reqsElapsedTime _unlockObject Integer64 Unlock an object
reqsElapsedTime _UnlockObjGroup Integer64 Unlock a group of objects
reqsElapsedTime _removeLocks Integer64 Remove all locks for a process
reqsElapsedTime _sendMsg Integer64 Send a message, that is execute a method
reqsElapsedTime _sendDbMsg Integer64 Special database request
reqsElapsedTime _beginNote Integer64 beginNotification
reqsElapsedTime _returnNotes Integer64 Send pending notifications
reqsElapsedTime _queryNote Integer64 Query notifications
reqsElapsedTime _endNote Integer64 endNotification
reqsElapsedTime _causeEvent Integer64 causeEvent
reqsElapsedTime _acquireSchema Integer64 Acquire a schema
reqsElapsedTime _releaseSchema Integer64 Release a schema
reqsElapsedTime _authRequest Integer64 Authorization request
reqsElapsedTime _authChallenge Integer64 Authorization challenge
reqsElapsedTime _authResponse Integer64 Authorization response
reqsElapsedTime _getReplyCont Integer64 Retrieve next portion of large reply
reqsElapsedTime _acquireClass Integer64 Acquire a class
reqsElapsedTime _releaseClass Integer64 Release a class
reqsElapsedTime _canUpdateClass Integer64 Query if class can be updated
reqsElapsedTime _beginLoad Integer64 Begin load state
reqsElapsedTime _endLoad Integer64 End load state
reqsElapsedTime _beginLock Integer64 Begin lock state
reqsElapsedTime _endLock Integer64 End lock state
reqsElapsedTime _flushBuffObjs Integer64 Force buffered objects to be sent to the database
reqsElapsedTime _commitTrans Integer64 Prepare to commit a transaction
reqsElapsedTime _getObjBranches Integer64 Versioning – get object branches
reqsElapsedTime _getBranchObjs Integer64 Versioning – get branch objects
reqsElapsedTime _getBranchObjOid Integer64 Versioning – get branch object oid
reqsElapsedTime _getLastBranch Integer64 Versioning – get last branch
reqsElapsedTime _getLatestVnOid Integer64 Versioning – get latest version oid
reqsElapsedTime _getLatestEdtn Integer64 Versioning – get latest edition
reqsElapsedTime _mgmtRequest Integer64 Special administrative request
reqsElapsedTime _unknown Integer64 Unknown request type
— Number of requests sent to the client node —
reqsToClnt_initialize Integer64 Node initialize
reqsToClnt_finalize Integer64 Node finalize
reqsToClnt_signOn Integer64 Sign on process
reqsToClnt_signOff Integer64 Sign off process
reqsToClnt_chgAccessMode Integer64 Change access mode
reqsToClnt_setSchema Integer64 Set schema
reqsToClnt_setExecInsts Integer64 Set exec instances
reqsToClnt_openFile Integer64 Open a file
reqsToClnt_closeFile Integer64 Close a file
reqsToClnt_beginTrans Integer64 beginTransaction
reqsToClnt_endTrans Integer64 commitTransaction
reqsToClnt_abortTrans Integer64 abortTransaction
reqsToClnt_getOid Integer64 Get an oid
reqsToClnt_getEdition Integer64 Get an edition
reqsToClnt_getObject Integer64 Get an object
reqsToClnt_getObjGroup Integer64 Get a group of objects
reqsToClnt_putObject Integer64 Send object to database
reqsToClnt_lockObject Integer64 Lock an object
reqsToClnt_lockObjGroup Integer64 Lock a group of objects
reqsToClnt_unlockObject Integer64 Unlock an object
reqsToClnt_UnlockObjGroup Integer64 Unlock a group of objects
reqsToClnt_removeLocks Integer64 Remove all locks for a process
reqsToClnt_sendMsg Integer64 Send a message, that is execute a method
reqsToClnt_sendDbMsg Integer64 Special database request
reqsToClnt_beginNote Integer64 beginNotification
reqsToClnt_returnNotes Integer64 Send pending notifications
reqsToClnt_queryNote Integer64 Query notifications
reqsToClnt_endNote Integer64 endNotification
reqsToClnt_causeEvent Integer64 causeEvent
reqsToClnt_acquireSchema Integer64 Acquire a schema
reqsToClnt_releaseSchema Integer64 Release a schema
reqsToClnt_authRequest Integer64 Authorization request
reqsToClnt_authChallenge Integer64 Authorization challenge
reqsToClnt_authResponse Integer64 Authorization response
reqsToClnt_getReplyCont Integer64 Retrieve next portion of large reply
reqsToClnt_acquireClass Integer64 Acquire a class
reqsToClnt_releaseClass Integer64 Release a class
reqsToClnt_canUpdateClass Integer64 Query if class can be updated
reqsToClnt_beginLoad Integer64 Begin load state
reqsToClnt_endLoad Integer64 End load state
reqsToClnt_beginLock Integer64 Begin lock state
reqsToClnt_endLock Integer64 End lock state
reqsToClnt_flushBuffObjs Integer64 Force buffered objects to be sent to the database
reqsToClnt_commitTrans Integer64 Prepare to commit a transaction
reqsToClnt_getObjBranches Integer64 Versioning – get object branches
reqsToClnt_getBranchObjs Integer64 Versioning – get branch objects
reqsToClnt_getBranchObjOid Integer64 Versioning – get branch object oid
reqsToClnt_getLastBranch Integer64 Versioning – get last branch
reqsToClnt_getLatestVnOid Integer64 Versioning – get latest version oid
reqsToClnt_getLatestEdtn Integer64 Versioning – get latest edition
reqsToClnt_mgmtRequest Integer64 Special administrative request
reqsToClnt_unknown Integer64 Unknown request type
— Total number of replies received from the client node —
repliesFromClnt_initialize Integer64 Node initialize
repliesFromClnt_finalize Integer64 Node finalize
repliesFromClnt_signOn Integer64 Sign on process
repliesFromClnt_signOff Integer64 Sign off process
repliesFromClnt_chgAccessMode Integer64 Change access mode
repliesFromClnt_setSchema Integer64 Set schema
repliesFromClnt_setExecInsts Integer64 Set exec instances
repliesFromClnt_openFile Integer64 Open a file
repliesFromClnt_closeFile Integer64 Close a file
repliesFromClnt_beginTrans Integer64 beginTransaction
repliesFromClnt_endTrans Integer64 commitTransaction
repliesFromClnt_abortTrans Integer64 abortTransaction
repliesFromClnt_getOid Integer64 Get an oid
repliesFromClnt_getEdition Integer64 Get an edition
repliesFromClnt_getObject Integer64 Get an object
repliesFromClnt_getObjGroup Integer64 Get a group of objects
repliesFromClnt_putObject Integer64 Send object to database
repliesFromClnt_lockObject Integer64 Lock an object
repliesFromClnt_lockObjGroup Integer64 Lock a group of objects
repliesFromClnt_unlockObject Integer64 Unlock an object
repliesFromClnt_UnlockObjGroup Integer64 Unlock a group of objects
repliesFromClnt_removeLocks Integer64 Remove all locks for a process
repliesFromClnt_sendMsg Integer64 Send a message, that is execute a method
repliesFromClnt_sendDbMsg Integer64 Special database request
repliesFromClnt_beginNote Integer64 beginNotification
repliesFromClnt_returnNotes Integer64 Send pending notifications
repliesFromClnt_queryNote Integer64 Query notifications
repliesFromClnt_endNote Integer64 endNotification
repliesFromClnt_causeEvent Integer64 causeEvent
repliesFromClnt_acquireSchema Integer64 Acquire a schema
repliesFromClnt_releaseSchema Integer64 Release a schema
repliesFromClnt_authRequest Integer64 Authorization request
repliesFromClnt_authChallenge Integer64 Authorization challenge
repliesFromClnt_authResponse Integer64 Authorization response
repliesFromClnt_getReplyCont Integer64 Retrieve next portion of large reply
repliesFromClnt_acquireClass Integer64 Acquire a class
repliesFromClnt_releaseClass Integer64 Release a class
repliesFromClnt_canUpdateClass Integer64 Query if class can be updated
repliesFromClnt_beginLoad Integer64 Begin load state
repliesFromClnt_endLoad Integer64 End load state
repliesFromClnt_beginLock Integer64 Begin lock state
repliesFromClnt_endLock Integer64 End lock state
repliesFromClnt_flushBuffObjs Integer64 Force buffered objects to be sent to the database
repliesFromClnt_commitTrans Integer64 Prepare to commit a transaction
repliesFromClnt_getObjBranches Integer64 Versioning – get object branches
repliesFromClnt_getBranchObjs Integer64 Versioning – get branch objects
repliesFromClnt_getBranchObjOid Integer64 Versioning – get branch object oid
repliesFromClnt_getLastBranch Integer64 Versioning – get last branch
repliesFromClnt_getLatestVnOid Integer64 Versioning – get latest version oid
repliesFromClnt_getLatestEdtn Integer64 Versioning – get latest edition
repliesFromClnt_mgmtRequest Integer64 Special administrative request
repliesFromClnt_unknown Integer64 Unknown request type

Properties are added to the dynamic object when the method is first called. The object can then be used in subsequent calls.

If the dynamic object passed to the method already contains properties that do not match the properties to be returned, the existing dynamic object properties are removed and replaced with the appropriate properties.

The method is most efficient when the properties match those to be returned.

For an example of the use of the getRpcServerStatistics method, see the Node class getRpcServerStatistics method in Volume 2 of the JADE Encyclopaedia of Classes.

 

VERSION 2018.0.01  |  Copyright © 2018  Jade Software Corporation Limited.  All rights reserved.