PTTW gate, BREAK_PARTNERSHIP function
Break an established partnership.
Input Parameters
- STATE_TOKEN
- The state_token used to manage the handshake
- COMPLETION_CODE
- Optional Parameter
- 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.
Output Parameters
- REASON
- The values for the parameter are:
- NOT_FOUND
- NOT_PARTNER
- PARTNERSHIP_NOT_MADE
- 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