PTTW gate, QUERY_POOL function

Query the attributes and state of a pool.

Input Parameters

POOL_NAME
The eight character name of the pool. This name must be unique across all pools. There is no enforced character set for this name.
POOL_TOKEN
The token of this pool

Output Parameters

REASON
The values for the parameter are:
  • POOL_NOT_FOUND
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
FREE_USER_DATA_DOMAIN
Optional Parameter
An optional callback routine that may be called to free any user data addressed from the user_data_token associated with each state_token. This callback must implement the PTFD FREE_USER_DATA gate.
FREE_USER_DATA_GATE
Optional Parameter
An optional callback routine that may be called to free any user data addressed from the user_data_token associated with each state_token. This callback must implement the PTFD FREE_USER_DATA gate.
GARBAGE_COLLECT_INTERVAL
Optional Parameter
The interval in milliseconds between collections of garbage for this pool. If garbage collection is on, this parameter must be provided. If garbage collection is off, this parameter is ignored.
GARBAGE_COLLECTION
Optional Parameter
Whether or not garbage collection is to be performed for state_tokens in this pool.
Values for the parameter are:
  • OFF
  • ON
POOL_NAME_OUT
Optional Parameter
The pool name is returned.
POOL_STATE
Optional Parameter
The cureent state of the pool.
Values for the parameter are:
  • EMPTY
  • NOT_EMPTY
  • QUIESCING
POOL_TOKEN_OUT
Optional Parameter
The pool token is returned.


dfhs3_PTTWquery_pool.html | Timestamp icon Last updated: Monday, 5 June 2017