PTTW gate, TRIGGER_PARTNER function

Notify a waiting partner. If the partner is not waiting when trigger is called, the partner will be triggered when it next waits.

Input Parameters

COMPLETION_CODE
The completion code to be passed to the partner. The caller can use this to notify partner why the partnership is being broken. Once read the completion code is reset to zero. This is optional so that the caller can pass exactly one completion code when calling trigger_partner followed by break_partnership. The completion code is ignored if the resulting state is not_made.
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

Output Parameters

REASON
The values for the parameter are:
  • ALREADY_TRIGGERED
  • NOT_FOUND
  • NOT_PARTNER
  • PARTNER_NOT_THERE
  • PARTNERSHIP_NOT_MADE
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_PTTWtrigger_partner.html | Timestamp icon Last updated: Monday, 5 June 2017