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

This node parses out lines from a data stream.

Detailed Description

This node parses out lines from a data stream. Input is interpreted as a stream of text data. Output is a single contiguous packet buffer per line of input.

This is useful for parsing sc_packet objects created by an sc_fd_reader node, and converting them into one sc_packet object per line.

Arguments

Argument Optional? Default Type Description
forward_truncated Yes 0 SC_PARAM_INT Specifies whether lines too large to fit in an sc_packet object should be sent down stream. If set to true such packets will have the SC_TRUNCATED flag set.
lstrip Yes 1 SC_PARAM_INT Specifies whether whitespace should be stripped from the start of a line.
rstrip Yes 1 SC_PARAM_INT Specifies whether whitespace should be stripped from the end of a line.
strip_comments Yes 1 SC_PARAM_INT Specifies whether lines starting with '#' should be forwarded.
strip_blank Yes 1 SC_PARAM_INT Specifies whether blank lines should be forwarded.
add_nul Yes 1 SC_PARAM_INT Specifies whether a nul ('\0') character should be appended to each line sent downstream.
add_new_line Yes 0 SC_PARAM_INT Specifies whether a new line ('
') character should be appended to each line sent downstream.

Named Input Links

None

Output Links

Link Description
"" One sc_packet object per line in the input data stream.
"input" The sc_packet objects sent on the "" input link.