Namespace: OpenEdge.ApplicationServer
Type: Class AgentInfo
Parent Classes:
Inherits: Progress.Lang.Object


Copyright (c) 2014,2017-2018 by Progress Software Corporation. All rights reserved.
File:AgentInfo.cls
Author(s):aherbstr
Created:Tuesday July 8 2014
Notes:Used by the Server Broker tools to manage agent sessions.
File:AgentInfo.cls
Author(s):aherbstr
Created:Tuesday July 8 2014
Notes:Used by the Server Broker tools to manage agent sessions.



Method Summary
  Options Name Purpose
  clearAgentStatData () /* Empties the cached agent request stats */
  getAgentActiveRequestData (character, table-handle) /* Returns the active request for a given sessionID @param character in session id @param longchar out request info for the given session id */
  LOGICAL getAgentConnectionData (table-handle)
  LOGICAL getAgentRequestData (table-handle) /* This method used to give all the requests that are running on the agent. But because of the Issue:PSC00364863, we limited the API to return only last 1000 requests information. */
  INT64 getAgentRequestQty () /* Returns the number of agent requests being monitored return int64 The number of agent requests. Returns -1 if not enabled */
  LOGICAL getAgentSessionData (table-handle)
  INTEGER getAgentSessionID (character)
  LOGICAL getAgentSessionStack (character, longchar) /* Returns the agent call stack for a given session @param character The session id for which to return a call stack @param longchar out JSON representation of the stack @return logical */
  LOGICAL getAgentSessionStack (integer, longchar) /* Returns the agent call stack for a given session @param integer The agent session id for which to return a call stack @param longchar out JSON representation of the stack @return logical */
  LOGICAL getAgentStacks (longchar) /* Returns the agent call stack for all sessions @param longchar out JSON representation of the stack @return logical */
  LOGICAL getAgentStatData (table-handle)
  LOGICAL getAgentThreadData (table-handle)
  LOGICAL getClientSessionID (integer, character)
  LOGICAL GetDynamicABLSessionLimitInfo (longchar) /* Returns the agent dynamic ABL session info @param longchar out JSON representation of the stack @return logical */
  LOGICAL setArchiveAgentStats (logical) /* Toggles the agent stats archive on and off. If we turn gathering stats OFF (a FALSE parameter) then we also empty the cached stats @param logical TRUE to enabled archiving; FALSE to disable @return logical TRUE when stats are archived, false otherwise */

Constructor Summary
  Options Name Purpose
  AgentInfo () /* Default constructor */

Method Detail
Top

clearAgentStatData ()

/* Empties the cached agent request stats
Top

getAgentActiveRequestData (character, table-handle)

/* Returns the active request for a given sessionID
Parameters:
sessionId CHARACTER
 
hTTCopy TABLE-HANDLE
 
Top

LOGICAL getAgentConnectionData (table-handle)

Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
 
Top

LOGICAL getAgentRequestData (table-handle)

/*
This method used to give all the requests that are running on the agent.
But because of the Issue:PSC00364863, we limited the API to return only
last 1000 requests information.
Parameters:
hTTCopy TABLE-HANDLE
 
Returns LOGICAL
 
Top

INT64 getAgentRequestQty ()

/* Returns the number of agent requests being monitored
return int64 The number of agent requests. Returns -1 if not enabled
Returns INT64
 
Top

LOGICAL getAgentSessionData (table-handle)

Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
 
Top

INTEGER getAgentSessionID (character)

Parameters:
clsessid CHARACTER
 
Returns INTEGER
 
Top

LOGICAL getAgentSessionStack (character, longchar)

/* Returns the agent call stack for a given session
Parameters:
sessid CHARACTER
 
pStack LONGCHAR
 
Returns LOGICAL
  logical
Top

LOGICAL getAgentSessionStack (integer, longchar)

/* Returns the agent call stack for a given session
Parameters:
sessid INTEGER
 
pStack LONGCHAR
 
Returns LOGICAL
  logical
Top

LOGICAL getAgentStacks (longchar)

/* Returns the agent call stack for all sessions
Parameters:
pStacks LONGCHAR
 
Returns LOGICAL
  logical
Top

LOGICAL getAgentStatData (table-handle)

Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
 
Top

LOGICAL getAgentThreadData (table-handle)

Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
 
Top

LOGICAL getClientSessionID (integer, character)

Parameters:
agentsessid INTEGER
 
clientsessid CHARACTER
 
Returns LOGICAL
 
Top

LOGICAL GetDynamicABLSessionLimitInfo (longchar)

/* Returns the agent dynamic ABL session info
Parameters:
sessionInfo LONGCHAR
 
Returns LOGICAL
  logical
Top

LOGICAL setArchiveAgentStats (logical)

/* Toggles the agent stats archive on and off.
If we turn gathering stats OFF (a FALSE parameter) then we also
empty the cached stats
Parameters:
setValue LOGICAL
 
Returns LOGICAL
  logical TRUE when stats are archived, false otherwise


Constructor Detail
Top

AgentInfo ()

/* Default constructor