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

Import packets or messages from a shared memory channel.

Detailed Description

This node is used in conjunction with sc_shm_broadcast or sc_shm_export to form a unidirectional shared memory channel between two SolarCapture sessions. sc_shm_import is the receiving end of the channel. Packets pushed into the channel are emitted by this node on its output.

Arguments

Argument Optional? Default Type Description
path No SC_PARAM_STR Location in the filesystem for the control socket.
reliable Yes 0 SC_PARAM_INT Set to 1 to request a reliable connection (which may cause head-of-line blocking).
active_connect Yes 1 SC_PARAM_INT If set to 0 then a listening socket is created at the path provided, and the remote side should do an active open.

Named Input Links

Packets arriving on an input link named "foo" are forwarded to an output link named "foo" on the other side of the shared memory channel. Note that these named channels do not support high performance.

Exposed Statistics

Statistics exposed by the sc_shm_broadcast and sc_shm_import nodes.

Name Type Data Type Description
pkts_dropped uint64_t pkt_count The number of packets dropped by the node.
wake_msgs uint64_t ev_count The number of wake messages.
sleep_notifies uint64_t ev_count The number of sleep notifications.
pkts_in_flight uint64_t pkt_count The number of packets in flight.
reliable_pkts_in_flight uint64_t pkt_count The number of packets in flight in reliable mode.