Adding Apex docs for Plugins module

Change-Id: Icf68473b472a5896972de5b07b275682a77a1c9f
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-867

1 files changed, 23 insertions, 0 deletions

diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ws-intro.adoc b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ws-intro.adoc
new file mode 100644
index 000000000..cbecbbe7f
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-websocket/src/site-docs/adoc/fragments/ws-intro.adoc
@@ -0,0 +1,23 @@
+//
+// ============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)
+//
+
+== Websockets
+
+Websocket is a protocol to run sockets of HTTP.
+Since it in essence a socket, the connection is realized between a server (waiting for connections) and a client (connecting to a server).
+Server/client separation is only important for connection establishment, once connected, everyone can send/receive on the same socket (as any standard socket would allow). 
+
+Standard Websocket implementations are simple, no publish/subscribe and no special event handling.
+Most servers simply send all incoming messages to all connections.
+There is a PubSub definition on top of Websocket called link:http://wamp-proto.org/[WAMP].
+APEX does not support WAMP at the moment.