From e9d6573c7827b856272def821a1686f7a1eda0be Mon Sep 17 00:00:00 2001 From: "Jay L. Gao" Date: Sat, 10 Feb 2024 18:14:35 -0800 Subject: [PATCH] update APIs --- .../docs/ION-Application-Service-Interface.md | 26 ++++++++++++++++++- gh-pages/docs/ION-Utilities.md | 2 ++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/gh-pages/docs/ION-Application-Service-Interface.md b/gh-pages/docs/ION-Application-Service-Interface.md index 224a0ef83..d2715320c 100644 --- a/gh-pages/docs/ION-Application-Service-Interface.md +++ b/gh-pages/docs/ION-Application-Service-Interface.md @@ -386,7 +386,31 @@ Return Value * 0: on success, the total number of extents received so far is reported through `extentCount` * -1: on system failure, returns -1 -### CFDP Code Example +### CFDP Shell Test Program: `cfdptest` + +ION provides application CFDP test program called `cfdptest`, which installed as part of regular ION build/install process and can be invoked from terminal this way: + +```bash +cfdptest +``` + +The shell program present a ':' prompt for interactive mode commanding. You can type 'h' to see a list of available commands. + +One can also feed a sequence of commands to `cfdptest` non-interactively such that you will not see the stdout of the program. This is useful for running automated tests. + +```bash +cfdptest [file_containing_cfdptest_commands] +``` + +A third way to use cfdptest is to feed command scripts but allows the interactive responses to be displayed in stdout: + +```bash +cfdptest < [file_containing_cfdptest_commands] +``` + +The `cfdptest.c` source code is also provided as a code examples on how write applications using the CFDP APIs. The cfdptest command set can be found in the manual pages [here.](https://nasa-jpl.github.io/ION-DTN/man/cfdp/cfdptest/?h=cfdptest) + +### CFDP Application Code Example _this section is work-in-progress_ diff --git a/gh-pages/docs/ION-Utilities.md b/gh-pages/docs/ION-Utilities.md index b0aa39abd..d55abfc87 100644 --- a/gh-pages/docs/ION-Utilities.md +++ b/gh-pages/docs/ION-Utilities.md @@ -17,3 +17,5 @@ Normally, when ION was shut down by calling `ionstop`, issuing the command '.' * killm * runtests * bptrace +* owltsim +* cfdptest