diff options
| author |   Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-22 12:41:50 +0100 |
|---|---|---|
| committer | Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-22 22:19:38 +0100 |
| commit | a5a4427b505a5b0d79bb394093c9d6f6395d9a1f (patch) | |
| tree | 63e31fd0cadb956f2dcd87022cfbdfb89d122fc2 /tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc | |
| parent | e633cd8e2e4bd0dc20a8727a3c35eaacf00a136f (diff) | |
Add docs for tools package & update main apex-pdp
Change-Id: I2990157eb7bae51f7d38a652fd8dd488b7287cea
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-867
Diffstat (limited to 'tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc')
| -rw-r--r-- | tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc | 22 |
1 files changed, 22 insertions, 0 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 new file mode 100644 index 000000000..e1531bf79 --- /dev/null +++ b/tools/simple-wsclient/src/site-docs/adoc/fragments/clients.adoc @@ -0,0 +1,22 @@ +// +// ============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] |