From 5308b03898e959a568406d3223f9efbc47df0c63 Mon Sep 17 00:00:00 2001 From: Sebastien Sikora Date: Tue, 30 Nov 2021 16:45:46 +0000 Subject: [PATCH] Updating README.md. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f3db28..ed47e2b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Updated 30/11/2021. satellite_terminal automates the process of launching a client process connected to it's own terminal emulator instance from within a parent process, linked with an arbitrary number of [named pipes](https://en.wikipedia.org/wiki/Named_pipe) to allow bidirectional interprocess communication. -satellite_terminal leverages the functionality defined in the [unistd.h](https://en.wikipedia.org/wiki/Unistd.h), [sys/stat.h](https://en.wikibooks.org/wiki/C_Programming/POSIX_Reference/sys/stat.h) & [fcntl.h](https://pubs.opengroup.org/onlinepubs/007904875/basedefs/fcntl.h.html) headers, and as-such will work only with [POSIX compatible](https://en.wikipedia.org/wiki/POSIX) operating systems and environments. satellite_terminal has to-date been compiled and tested on GNU/Linux. +satellite_terminal leverages the functionality defined in the [unistd.h](https://en.wikipedia.org/wiki/Unistd.h), [sys/stat.h](https://en.wikibooks.org/wiki/C_Programming/POSIX_Reference/sys/stat.h) & [fcntl.h](https://pubs.opengroup.org/onlinepubs/007904875/basedefs/fcntl.h.html) headers, and as-such will work only with [POSIX compatible](https://en.wikipedia.org/wiki/POSIX) operating systems and [environments](https://www.cygwin.com/). satellite_terminal has to-date been compiled and tested on GNU/Linux. satellite_terminal is easy to incorporate and use within your own projects, as the basic examples below will demonstrate.
@@ -42,6 +42,11 @@ By default two named pipes will be created to form a tx-rx pair, but an arbitrar #include "satellite_terminal.h" ... +// Server constructor prototype in satellite_terminal.h: +// +// SatTerm_Server(std::string const& identifier, std::string const& path_to_client_binary, bool display_messages = true, size_t stop_fifo_index = 0, +// size_t sc_fifo_count = 1, size_t cs_fifo_count = 1, char end_char = 3, std::string const& stop_message = "q"); + SatTerm_Server sts("test_server", "./child_binary"); // Path to child binary above can incorporate desired command-line arguments