SolarCapture C Bindings User Guide  SF-115721-CD
Issue 1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
sc_exit Node Reference

Node that causes the process to exit when a condition is met.

Detailed Description

By default this node causes the process to exit when all sc_exit nodes in the process have received the end-of-stream signal on their inputs. Typically sc_exit nodes are placed at the end of a pipeline so that the process exits after all packet processing is complete.

Each sc_exit node has one or more exit conditions, set by the end_of_stream and predicate arguments. Each sc_exit node also has a scope. When all of the sc_exit nodes that reside within a single scope detect their exit condition, the process exits. The scope argument may take the following values:

  • process: Includes all sc_exit nodes in the same process.
  • session: Includes all sc_exit nodes in the same session.
  • none: Each sc_exit node has its own scope.

If multiple sc_exit nodes are created when the process exits when all sc_exit nodes within a particular scope

Input packets are forwarded to the output unmodified.

Arguments

Argument Optional? Default Type Description
end_of_stream Yes 1 SC_PARAM_INT Exit condition is met when end-of-stream signal is received.
scope Yes process SC_PARAM_STR See description. May be process, session or none.
predicate Yes SC_PARAM_OBJ Predicate is invoked on each input packet. Exit condition is met when it returns true.