diff --git a/wiki/APIExamples.wiki b/wiki/APIExamples.wiki index ea359879..960a1b15 100644 --- a/wiki/APIExamples.wiki +++ b/wiki/APIExamples.wiki @@ -1,7 +1,7 @@ #summary example usage of the CORE API = How to get and read API traces = -From the CORE GUI, choose _View_ -> _Show_ -> _API Messages_. Once this option is turned on, you will see trace output such as the below. +From the CORE GUI, choose _View_ -> _Show_ -> _API Messages_. Once this option is turned on, you will see trace output such as the lines listed below. == Output == Each line of console output starting with a *>* character indicate an outgoing CORE API message that has been sent: @@ -21,7 +21,6 @@ NODE(num=0,emuid=1000,) http://hipserver.mct.phantomworks.org/core/images/wiki/api_example_two_node.png - Here is the API trace output from the CORE GUI for a two-node wired scenario. {{{ @@ -54,4 +53,7 @@ read 8 bytes (type=1, flags=10, len=8)... NODE(num=1,) }}} - # as part of the shutdown sequence, the CORE GUI kills running processes on each node; this is performed by sending cored the first two EXEC messages containing the _killall_ command. Each EXEC message is given a number (101, 102, etc...) \ No newline at end of file + # as part of the shutdown sequence, the CORE GUI kills running processes on each node; this is performed by sending cored the first two EXEC messages containing the _killall_ command. Each EXEC message is given a sequence number (101, 102, etc...) so the response output can be matches. + # the LINK message with flags=2 instructs cored to remove the link between n0 and n1 + # the two NODE messages that follow with flags=del instruct cored to shutdown nodes n0 and n1; the str "status request" flag tells cored that the status is requested once the node shutdown completes + # similar to startup, the GUI draws a red square around each node indicating the request to shutdown each node; the last two NODE messages have the str flag set and are the response to the node shutdown request; the red squares are then removed in the GUI \ No newline at end of file