From af74a6270d6ab6badf04a97495a6ef8ccded9b4b Mon Sep 17 00:00:00 2001 From: ramverma Date: Tue, 31 Jul 2018 18:25:39 +0100 Subject: Adding first set of apex-pdp document changes Adding document changes for auth, context, core, model, services & the main apex-pdp module. Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b Issue-ID: POLICY-867 Signed-off-by: ramverma --- .../adoc/fragments/howto-apex/app-ws.adoc | 45 ++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 src/site-docs/adoc/fragments/howto-apex/app-ws.adoc (limited to 'src/site-docs/adoc/fragments/howto-apex/app-ws.adoc') diff --git a/src/site-docs/adoc/fragments/howto-apex/app-ws.adoc b/src/site-docs/adoc/fragments/howto-apex/app-ws.adoc new file mode 100644 index 000000000..f11bdf277 --- /dev/null +++ b/src/site-docs/adoc/fragments/howto-apex/app-ws.adoc @@ -0,0 +1,45 @@ +// +// ============LICENSE_START======================================================= +// Copyright (C) 2016-2018 Ericsson. All rights reserved. +// ================================================================================ +// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +// +// SPDX-License-Identifier: CC-BY-4.0 +// ============LICENSE_END========================================================= +// +// @author Sven van der Meer (sven.van.der.meer@ericsson.com) +// + +== Application: Websocket Clients (Echo and Console) + +**Status: Production** + +The application launcher also provides a Websocket echo client and a Websocket console client. +The echo client connects to APEX and prints all events it receives from APEX. +The console client connects to APEX, reads input from the command line, and sends this input as events to APEX. + +[width="100%",options="header",cols="5a,5a"] +|==================== +| Unix, Cygwin | Windows +| +[source%nowrap,sh] +---- +# $APEX_HOME/bin/apexApps.sh ws-echo [args] +# $APEX_HOME/bin/apexApps.sh ws-console [args] +---- +| +[source%nowrap,bat] +---- +> %APEX_HOME%\bin\apexApps.bat ws-echo [args] +> %APEX_HOME%\bin\apexApps.bat ws-console [args] +---- +|==================== + +The arguments are the same for both applications: + +- `-p` defines the Websocket port to connect to (defaults to `8887`) +- `-s` defines the host on which a Websocket server is running (defaults to `localhost`) + +A discussion on how to use these two applications to build an APEX system is detailed HowTo-Websockets. + -- cgit 1.2.3-korg