PTTW gate, CREATE_POOL function
The CREATE_POOL function creates a pool for state_tokens.
Input Parameters
- GARBAGE_COLLECTION
- Whether or not garbage collection is to be performed for state_tokens in this pool.
- Values for the parameter are:
- OFF
- ON
- 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.
- 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.
Output Parameters
- REASON
- The values for the parameter are:
- BAD_CALLBACK
- NAME_NOT_UNIQUE
- POOL_TOKEN
- The token of this pool
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.