summaryrefslogtreecommitdiffstats
path: root/tools/simple-wsclient
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2020-10-16 14:17:43 +0000
committerGerrit Code Review <gerrit@onap.org>2020-10-16 14:17:43 +0000
commit5190c58837149c4599182d211d8ae5bd83003d34 (patch)
tree6186091f088a43623a2b9ebf9b203fc33e90825a /tools/simple-wsclient
parentc293413c1c46d3c59ff8a855d683f4614bbe644a (diff)
parent0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 (diff)
Merge "Remove apex asciidoc documents"
Diffstat (limited to 'tools/simple-wsclient')
-rw-r--r--tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc22
-rw-r--r--tools/simple-wsclient/src/site-docs/adoc/fragments/run-console.adoc77
-rw-r--r--tools/simple-wsclient/src/site-docs/adoc/fragments/run-echo.adoc79
3 files changed, 0 insertions, 178 deletions
diff --git a/tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc b/tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc
deleted file mode 100644
index e1531bf79..000000000
--- a/tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc
+++ /dev/null
@@ -1,22 +0,0 @@
-//
-// ============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)
-//
-
-== Simple Websocket Clients
-
-In a full installation, the APEX applications provide two demo Websocket clients: echo and console.
-The __echo__ client connects to a Websocket server and prints all events it receives (reading text/string from Websocket).
-The __console__ client connects to a Websocket server, takes strings from the console (multi-line JSON encoded string starting with ‘{‘ and ending with ‘}’) and sends them as text via a Websocket.
-
-Both demo clients use `Java-WebSocket` and have no further dependency on APEX:
-
-- link:https://search.maven.org/#artifactdetails%7Corg.java-websocket%7CJava-WebSocket%7C1.3.4%7Cjar[Websocket implementation]
diff --git a/tools/simple-wsclient/src/site-docs/adoc/fragments/run-console.adoc b/tools/simple-wsclient/src/site-docs/adoc/fragments/run-console.adoc
deleted file mode 100644
index 04d37613a..000000000
--- a/tools/simple-wsclient/src/site-docs/adoc/fragments/run-console.adoc
+++ /dev/null
@@ -1,77 +0,0 @@
-//
-// ============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)
-//
-
-== Run the Websocket Console Client
-
-The console client is included in an APEX full installation.
-To run the client, open a new shell (Unix, Cygwin) or command prompt (`cmd` on Windows).
-Then use the APEX application launcher to start the client.
-
-[IMPORTANT]
-.APEX engine needs to run first
-====
-The example assumes that an APEX engine configured for __consume__ carrier technology Websocket and __JSON__ event protocol is executed first.
-====
-
-
-[width="100%",options="header",cols="5a,5a"]
-|====================
-| Unix, Cygwin | Windows
-|
-[source%nowrap,sh]
-----
-# $APEX_HOME/bin/apexApps.sh ws-console [args]
-----
-|
-[source%nowrap,bat]
-----
-> %APEX_HOME%\bin\apexApps.bat ws-console [args]
-----
-|====================
-
-Use the following command line arguments for server and port of the Websocket server.
-The port should be the same as configured in the APEX engine.
-The server host should be the host on which the APEX engine is running
-
-- `-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`)
-
-Let's assume that there is an APEX engine running, configured for consume Websocket carrier technology, as server, for port 42450, with consume event protocol JSON,.
-If we start the console client on the same host, we can omit the `-s` options.
-We start the console client as:
-
-[source%nowrap,bat]
-----
-# $APEX_HOME/bin/apexApps.sh ws-console -p 42450 <1>
-> %APEX_HOME%\bin\apexApps.sh ws-console -p 42450 <2>
-----
-<1> Start client on Unix or Cygwin
-<2> Start client on Windows
-
-Once started successfully, the client will produce the following messages (assuming we used `-p 42450` and an APEX engine is running on `localhost` with the same port:
-
-[source%nowrap,bat]
-----
-
-ws-simple-console: starting simple event console
- --> server: localhost
- --> port: 42450
-
- - terminate the application typing 'exit<enter>' or using 'CTRL+C'
- - events are created by a non-blank starting line and terminated by a blank line
-
-
-ws-simple-console: opened connection to APEX (Web Socket Protocol Handshake)
-
-----
-
diff --git a/tools/simple-wsclient/src/site-docs/adoc/fragments/run-echo.adoc b/tools/simple-wsclient/src/site-docs/adoc/fragments/run-echo.adoc
deleted file mode 100644
index 213b4acbc..000000000
--- a/tools/simple-wsclient/src/site-docs/adoc/fragments/run-echo.adoc
+++ /dev/null
@@ -1,79 +0,0 @@
-//
-// ============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)
-//
-
-== Run the Websocket Echo Client
-
-The echo client is included in an APEX full installation.
-To run the client, open a new shell (Unix, Cygwin) or command prompt (`cmd` on Windows).
-Then use the APEX application launcher to start the client.
-
-[IMPORTANT]
-.APEX engine needs to run first
-====
-The example assumes that an APEX engine configured for __produce__ carrier technology Websocket and __JSON__ event protocol is executed first.
-====
-
-
-[width="100%",options="header",cols="5a,5a"]
-|====================
-| Unix, Cygwin | Windows
-|
-[source%nowrap,sh]
-----
-# $APEX_HOME/bin/apexApps.sh ws-echo [args]
-----
-|
-[source%nowrap,bat]
-----
-> %APEX_HOME%\bin\apexApps.bat ws-echo [args]
-----
-|====================
-
-Use the following command line arguments for server and port of the Websocket server.
-The port should be the same as configured in the APEX engine.
-The server host should be the host on which the APEX engine is running
-
-- `-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`)
-
-Let's assume that there is an APEX engine running, configured for produce Websocket carrier technology, as server, for port 42452, with produce event protocol JSON,.
-If we start the console client on the same host, we can omit the `-s` options.
-We start the console client as:
-
-[source%nowrap,bat]
-----
-# $APEX_HOME/bin/apexApps.sh ws-echo -p 42452 <1>
-> %APEX_HOME%\bin\apexApps.bat ws-echo -p 42452 <2>
-----
-<1> Start client on Unix or Cygwin
-<2> Start client on Windows
-
-Once started successfully, the client will produce the following messages (assuming we used `-p 42452` and an APEX engine is running on `localhost` with the same port:
-
-[source%nowrap,bat]
-----
-
-
-ws-simple-echo: starting simple event echo
- --> server: localhost
- --> port: 42452
-
-Once started, the application will simply print out all received events to standard out.
-Each received event will be prefixed by '---' and suffixed by '===='
-
-
-ws-simple-echo: opened connection to APEX (Web Socket Protocol Handshake)
-
-
-----
-