HawkListener:getServerinfo

Method

Purpose

This method (on all platforms) gets the configuration parameters.

Remarks

 

Type

Synchronous, IMPACT_INFO

Arguments

None.

Returns

 

Name

Type

Description

asyncDBSize

Long

The value indicating total size of the asynchronous message store

authorizationEnabled

Boolean

The flag passed to indicate whether the authorization is turned on for this server

backupName

String

Returns the name of the fault tolerant backup for this store

connectionCount

Integer

Number of connections to the server.

connectionCountUsage

Double

Number of connections to the server as a fraction of maxConnections

diskReadRate

Long

The value indicating the rate at which messages are being read from the disk

diskWriteRate

Long

The value indicating the rate at which messages are being written to the disk

durableCount

Integer

Number of durable subscribers on the server

faultTolerantActivation

Integer

The value indicating the time period for which a backup server will wait for a heartbeat message before concluding that the active server has failed

faultTolerantHeartBeat

Integer

The value indicating the time period in seconds of heartbeat messages sent by the server

faultTolerantReconnectTimeout

Integer

The time period for which a server that has just become the active server following a failover will wait for clients, to reconnect before their state is removed from the shared state

faultTolerantURL

String

Returns fault tolerant URL for this server

flowControlEnabled

Boolean

The flag passed to indicate whether the flow control is enabled

fsyncEnabled

Boolean

The flag passed to indicate whether the fsync is enabled

inboundBytesRate

Long

The value indicating overall inbound bytes per second on this server

inboundMessageCount

Long

The value indicating number of inbound messages for the server

inboundMessageRate

Long

The value indicating rate at which messages are coming into the server

logFileMaxSize

Long

The value indicating maximum allowed size of the log file

logFileName

String

Returns log file name, or null if not set

logFileSize

Long

The value indicating total size of log file

maxConnections

Integer

Maximum number of connections this server will allow

maxMsgMemory

Long

The value indicating maximum memory, in bytes, which server is allowed to use for storing messages in memory

maxStatisticsMemory

Long

The value indicating maximum statistics memory, in bytes

messagePoolBlockSize

Long

The value of msg_pool_block_size setting

messagePoolSize

Long

The value of msg_pool_size setting

messageSwappingEnabled

Boolean

The flag passed to indicate whether the message swapping is enabled

messageMemory

Long

The amount of memory in use to store messages

messageMemoryUsage

Double

The amount of memory in use to store messages as a fraction of maxMsgMemory

messageMemoryPooled

Long

The amount of memory in use by the message pools

multicastEnabled

Boolean

The flag passed to indicate whether the multicast is turned on for this server

outboundBytesRate

Long

The overall outbound bytes per second on this server

outboundMessageCount

Long

The number of outbound messages for the server

outboundMessageRate

Long

The rate at which messages are flowing out of the server

pendingMessageCount

Long

Total number of pending messages for this server

pendingMessageSize

Long

Total size for all pending messages for this server

pid

Integer

The current process id of server

queueCount

Integer

Number of queues on the server

rateInterval

Long

The value indicating the statistics rate interval in milliseconds

reserveMemory

Long

The amount of reserve memory in bytes

routingEnabled

Boolean

The flag passed to indicate whether the routing is enabled for this server

routeRecoverInterval

Long

The value indicating route recover interval in milliseconds

serverName

String

Returns name of this server

serverRateInterval

Long

The value indicating the server statistics rate interval in milliseconds

startTime

Long

The value indicating time in milliseconds that the server was started

state

String

Returns the current state of the server

statisticsCleanupInterval

Long

The value indicating statistics cleanup interval in milliseconds

statisticsEnabled

Boolean

The flag passed to indicate whether the statistics are enabled

storeAsyncMinimum

Long

The minimum size of the server's asynchronous store file

storeCRCEnabled

Boolean

The flag passed to indicate whether the server uses CRC verification when reading store files

storeDirectory

String

Returns server store files directory

storeMinimum

Long

The minimum size in bytes of sever store files

storeSyncMinimum

Long

The minimum size of the server's synchronous store file

storeTruncateEnabled

Boolean

The flag passed to indicate whether the server attempts to truncate store files when possible

syncDBSize

Long

Total size of the synchronous message store

topicCount

Integer

Number of topics on the server

trackCorrelationIds

Boolean

The flag passed to indicate whether the server tracks messages by correlation ID

trackMsgIds

Boolean

The flag passed to indicate whether the server tracks messages by message ID

upTime

Long

The value indicating time in milliseconds since this server was started

URL

String

URL for this server

userAuth

String

Returns locations this server uses for authenticating users

versionInfo

String

Returns version info for this server