PTTW gate, WAIT_FOR_PARTNER function

Wait to be notified by a partner or until the wait times out.

Input Parameters

PARTNER_EXISTENCE
Specifies whether the partner must exist for this request.
Values for the parameter are:
  • DONT_CARE
  • MUST_EXIST
STATE_TOKEN
The state_token used to manage the handshake
PURGEABLE
Optional Parameter
Specifies whether the wait can be purged.
Values for the parameter are:
  • NO
  • YES
TIMEOUT
Optional Parameter
An optional maximum time to wait before waking up in milliseconds

Output Parameters

REASON
The values for the parameter are:
  • NOT_FOUND
  • NOT_PARTNER
  • PARTNER_NOT_THERE
  • PARTNER_WAITING
  • PARTNERSHIP_NOT_MADE
  • TIMED_OUT
PARTNER_COMPLETION_CODE
The partner's completion code indicates why the partner broke the partnership.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
NEW_TRIGSTATE1
Optional Parameter
The state of partner 1 after the request.
Values for the parameter are:
  • RESUMED
  • TRIGGERED
  • UNDEFINED
  • VALID
  • WAITING
NEW_TRIGSTATE2
Optional Parameter
The state of partner 2 after the request.
Values for the parameter are:
  • RESUMED
  • TRIGGERED
  • UNDEFINED
  • VALID
  • WAITING
OLD_TRIGSTATE1
Optional Parameter
The state of partner 1 before the request.
Values for the parameter are:
  • RESUMED
  • TRIGGERED
  • UNDEFINED
  • VALID
  • WAITING
OLD_TRIGSTATE2
Optional Parameter
The state of partner 2 before the request.
Values for the parameter are:
  • RESUMED
  • TRIGGERED
  • UNDEFINED
  • VALID
  • WAITING


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