Enum DebugPortCommands
Commands for when to launch and/or break a debugger when debugging dataflow ports.
Multiple commands can be set at the same time by combining them with bitwise OR
(| in C#).
The various "On..." commands defines when to break or launch the debugger, while Launch and Break defines what to do, i.e. launching and breaking the debugger. In most debugging scenarios, both one or more "On..." commands, as well as either Launch or Break, should be set.
There are also several predefined combinations, e.g. BreakOnRowsAndStateCompleted that is very useful for viewing rows sent from an output or error output port.
Note that to view the dataflow rows while debugging, the DebugCommands property must be set to something other than None when the port worker initially runs.
Also note that any Launch command will be automatically downgraded to a Break command after the first attempt to launch a debugger.
Namespace: actionETL
Assembly: actionETL.dll
Syntax
[Flags]
public enum DebugPortCommandsFields
| Name | Description |
|---|---|
| Break | Break any attached debugger when any of the "On..." commands are triggered. If no debugger is attached, no action is taken. |
| BreakOnRowsAndStateCompleted | Break any attached debugger when this port sends rows, or this port and the downstream
port both become completed.
This equates to
Breaking on rows is also governed by DebugBreakAfterRows. |
| BreakOnStateCompleted | Break any attached debugger when this port and the downstream port both become completed.
This equates to
|
| Launch | Launch, attach, and break a debugger when any of the "On..." commands are triggered. If a debugger is already attached, this command will only Break the debugger. Note that the Launch command will be automatically downgraded to a Break command after the first attempt to launch a debugger. |
| LaunchOnRowsAndStateCompleted | Launch, attach, and break a debugger when this port sends rows, or this port and
the downstream port both become completed. This equates to
Breaking on rows is also governed by DebugBreakAfterRows. Note that the Launch command will be automatically downgraded to a Break command after the first attempt to launch a debugger. |
| LaunchOnStateCompleted | Launch, attach, and break a debugger when this port and the downstream port both become completed.
This equates to
Note that the Launch command will be automatically downgraded to a Break command after the first attempt to launch a debugger. |
| None | Debugging disabled. |
| OnAllStates | Execute any Launch or Break command when either the upstream port
or downstream port gets any state. This equates to
|
| OnAnyStateCanceled | Execute any Launch or Break command when the upstream port becomes Canceled, or the downstream port becomes Canceled. |
| OnAnyStateFailure | Execute any Launch or Break command when the upstream port becomes Error, or the downstream port becomes Error or Fatal. |
| OnAnyStateReady | Execute any Launch or Break command when the upstream port becomes Ready, or the downstream port becomes Ready. |
| OnRows | Execute any Launch or Break command when this port sends rows. The DebugBreakAfterRows property controls whether to take action on every send, or after a certain number of rows are sent. Note that to view the dataflow rows while debugging, DebugCommands must be set to something other than None when the port worker initially runs. Also note that the port will consume extra memory, and run slightly slower, when this command is set. While it can be enabled in production, it should normally not be enabled after debugging activities has concluded. |
| OnStateActive | Execute any Launch or Break command when the upstream port becomes Active and the downstream port becomes ActiveAndUpstreamActive. |
| OnStateCanceled | Execute any Launch or Break command when the upstream port becomes Canceled and the downstream port becomes Canceled. |
| OnStateCompleted | Execute any Launch or Break command when the upstream and
downstream ports both become completed. This equates to
|
| OnStateSucceeded | Execute any Launch or Break command when the upstream port becomes Succeeded and the downstream port becomes Succeeded. |
| OnUpstreamStateSucceeded | Execute any Launch or Break command when the upstream port becomes Succeeded and the downstream port becomes ActiveAndUpstreamSucceeded. |