diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..4dab462c --- /dev/null +++ b/examples/README.md @@ -0,0 +1,12 @@ +AutobahnPython Examples +======================= + +This folder contains complete working code examples that demonstrate various +features of AutobahnPython. + +Since AutobahnPython implements both standard WebSocket and WAMP, which provides asynchronous RPC and PubSub layered on top of WebSocket, the examples are splitted into + + * WebSocket + * WAMP + +subfolders. \ No newline at end of file diff --git a/examples/wamp/README.md b/examples/wamp/README.md new file mode 100644 index 00000000..ffe81c71 --- /dev/null +++ b/examples/wamp/README.md @@ -0,0 +1,4 @@ +RPC/PubSub Programming with AutobahnPython +========================================== + +Couple of examples showing how to do RPC/PubSub (WAMP) programming using AutobahnPython. \ No newline at end of file diff --git a/examples/authentication/client.py b/examples/wamp/authentication/client.py similarity index 100% rename from examples/authentication/client.py rename to examples/wamp/authentication/client.py diff --git a/examples/authentication/index.html b/examples/wamp/authentication/index.html similarity index 100% rename from examples/authentication/index.html rename to examples/wamp/authentication/index.html diff --git a/examples/authentication/server.py b/examples/wamp/authentication/server.py similarity index 100% rename from examples/authentication/server.py rename to examples/wamp/authentication/server.py diff --git a/examples/pubsub/README.md b/examples/wamp/pubsub/README.md similarity index 100% rename from examples/pubsub/README.md rename to examples/wamp/pubsub/README.md diff --git a/examples/pubsub/authorization/README.md b/examples/wamp/pubsub/authorization/README.md similarity index 100% rename from examples/pubsub/authorization/README.md rename to examples/wamp/pubsub/authorization/README.md diff --git a/examples/pubsub/authorization/client.py b/examples/wamp/pubsub/authorization/client.py similarity index 100% rename from examples/pubsub/authorization/client.py rename to examples/wamp/pubsub/authorization/client.py diff --git a/examples/pubsub/authorization/index.html b/examples/wamp/pubsub/authorization/index.html similarity index 100% rename from examples/pubsub/authorization/index.html rename to examples/wamp/pubsub/authorization/index.html diff --git a/examples/pubsub/authorization/server.py b/examples/wamp/pubsub/authorization/server.py similarity index 100% rename from examples/pubsub/authorization/server.py rename to examples/wamp/pubsub/authorization/server.py diff --git a/examples/pubsub/simple/README.md b/examples/wamp/pubsub/simple/README.md similarity index 100% rename from examples/pubsub/simple/README.md rename to examples/wamp/pubsub/simple/README.md diff --git a/examples/pubsub/simple/client.py b/examples/wamp/pubsub/simple/client.py similarity index 100% rename from examples/pubsub/simple/client.py rename to examples/wamp/pubsub/simple/client.py diff --git a/examples/pubsub/simple/index.html b/examples/wamp/pubsub/simple/index.html similarity index 100% rename from examples/pubsub/simple/index.html rename to examples/wamp/pubsub/simple/index.html diff --git a/examples/pubsub/simple/server.py b/examples/wamp/pubsub/simple/server.py similarity index 100% rename from examples/pubsub/simple/server.py rename to examples/wamp/pubsub/simple/server.py diff --git a/examples/rpc/README.md b/examples/wamp/rpc/README.md similarity index 100% rename from examples/rpc/README.md rename to examples/wamp/rpc/README.md diff --git a/examples/rpc/calculator/README.md b/examples/wamp/rpc/calculator/README.md similarity index 100% rename from examples/rpc/calculator/README.md rename to examples/wamp/rpc/calculator/README.md diff --git a/examples/rpc/calculator/index.html b/examples/wamp/rpc/calculator/index.html similarity index 100% rename from examples/rpc/calculator/index.html rename to examples/wamp/rpc/calculator/index.html diff --git a/examples/rpc/calculator/server.py b/examples/wamp/rpc/calculator/server.py similarity index 100% rename from examples/rpc/calculator/server.py rename to examples/wamp/rpc/calculator/server.py diff --git a/examples/rpc/keyvalue/.gitignore b/examples/wamp/rpc/keyvalue/.gitignore similarity index 100% rename from examples/rpc/keyvalue/.gitignore rename to examples/wamp/rpc/keyvalue/.gitignore diff --git a/examples/rpc/keyvalue/README.md b/examples/wamp/rpc/keyvalue/README.md similarity index 100% rename from examples/rpc/keyvalue/README.md rename to examples/wamp/rpc/keyvalue/README.md diff --git a/examples/rpc/keyvalue/client.py b/examples/wamp/rpc/keyvalue/client.py similarity index 100% rename from examples/rpc/keyvalue/client.py rename to examples/wamp/rpc/keyvalue/client.py diff --git a/examples/rpc/keyvalue/index.html b/examples/wamp/rpc/keyvalue/index.html similarity index 100% rename from examples/rpc/keyvalue/index.html rename to examples/wamp/rpc/keyvalue/index.html diff --git a/examples/rpc/keyvalue/server.py b/examples/wamp/rpc/keyvalue/server.py similarity index 100% rename from examples/rpc/keyvalue/server.py rename to examples/wamp/rpc/keyvalue/server.py diff --git a/examples/rpc/simple/README.md b/examples/wamp/rpc/simple/README.md similarity index 100% rename from examples/rpc/simple/README.md rename to examples/wamp/rpc/simple/README.md diff --git a/examples/rpc/simple/client.py b/examples/wamp/rpc/simple/client.py similarity index 100% rename from examples/rpc/simple/client.py rename to examples/wamp/rpc/simple/client.py diff --git a/examples/rpc/simple/client_icb.py b/examples/wamp/rpc/simple/client_icb.py similarity index 100% rename from examples/rpc/simple/client_icb.py rename to examples/wamp/rpc/simple/client_icb.py diff --git a/examples/rpc/simple/index.html b/examples/wamp/rpc/simple/index.html similarity index 100% rename from examples/rpc/simple/index.html rename to examples/wamp/rpc/simple/index.html diff --git a/examples/rpc/simple/server.py b/examples/wamp/rpc/simple/server.py similarity index 100% rename from examples/rpc/simple/server.py rename to examples/wamp/rpc/simple/server.py diff --git a/examples/serial2ws/README.md b/examples/wamp/serial2ws/README.md similarity index 100% rename from examples/serial2ws/README.md rename to examples/wamp/serial2ws/README.md diff --git a/examples/serial2ws/index.html b/examples/wamp/serial2ws/index.html similarity index 100% rename from examples/serial2ws/index.html rename to examples/wamp/serial2ws/index.html diff --git a/examples/serial2ws/serial2ws.ino b/examples/wamp/serial2ws/serial2ws.ino similarity index 100% rename from examples/serial2ws/serial2ws.ino rename to examples/wamp/serial2ws/serial2ws.ino diff --git a/examples/serial2ws/serial2ws.py b/examples/wamp/serial2ws/serial2ws.py similarity index 100% rename from examples/serial2ws/serial2ws.py rename to examples/wamp/serial2ws/serial2ws.py diff --git a/examples/serial2ws/smoothie.js b/examples/wamp/serial2ws/smoothie.js similarity index 100% rename from examples/serial2ws/smoothie.js rename to examples/wamp/serial2ws/smoothie.js diff --git a/examples/websocket/README.md b/examples/websocket/README.md new file mode 100644 index 00000000..b7c63e8d --- /dev/null +++ b/examples/websocket/README.md @@ -0,0 +1,4 @@ +WebSocket Programming with AutobahnPython +========================================= + +Couple of examples showing how to implement WebSocket servers and clients using AutobahnPython. \ No newline at end of file diff --git a/examples/broadcast/client.py b/examples/websocket/broadcast/client.py similarity index 100% rename from examples/broadcast/client.py rename to examples/websocket/broadcast/client.py diff --git a/examples/broadcast/index.html b/examples/websocket/broadcast/index.html similarity index 100% rename from examples/broadcast/index.html rename to examples/websocket/broadcast/index.html diff --git a/examples/broadcast/server.py b/examples/websocket/broadcast/server.py similarity index 100% rename from examples/broadcast/server.py rename to examples/websocket/broadcast/server.py diff --git a/examples/echo/client.py b/examples/websocket/echo/client.py similarity index 100% rename from examples/echo/client.py rename to examples/websocket/echo/client.py diff --git a/examples/echo/client_with_params.py b/examples/websocket/echo/client_with_params.py similarity index 100% rename from examples/echo/client_with_params.py rename to examples/websocket/echo/client_with_params.py diff --git a/examples/echo/index.html b/examples/websocket/echo/index.html similarity index 100% rename from examples/echo/index.html rename to examples/websocket/echo/index.html diff --git a/examples/echo/server.py b/examples/websocket/echo/server.py similarity index 100% rename from examples/echo/server.py rename to examples/websocket/echo/server.py diff --git a/examples/echo_tls/client.html b/examples/websocket/echo_tls/client.html similarity index 100% rename from examples/echo_tls/client.html rename to examples/websocket/echo_tls/client.html diff --git a/examples/echo_tls/client.py b/examples/websocket/echo_tls/client.py similarity index 100% rename from examples/echo_tls/client.py rename to examples/websocket/echo_tls/client.py diff --git a/examples/echo_tls/index.html b/examples/websocket/echo_tls/index.html similarity index 100% rename from examples/echo_tls/index.html rename to examples/websocket/echo_tls/index.html diff --git a/examples/echo_tls/keys/README b/examples/websocket/echo_tls/keys/README similarity index 100% rename from examples/echo_tls/keys/README rename to examples/websocket/echo_tls/keys/README diff --git a/examples/echo_tls/keys/server.crt b/examples/websocket/echo_tls/keys/server.crt similarity index 100% rename from examples/echo_tls/keys/server.crt rename to examples/websocket/echo_tls/keys/server.crt diff --git a/examples/echo_tls/keys/server.csr b/examples/websocket/echo_tls/keys/server.csr similarity index 100% rename from examples/echo_tls/keys/server.csr rename to examples/websocket/echo_tls/keys/server.csr diff --git a/examples/echo_tls/keys/server.key b/examples/websocket/echo_tls/keys/server.key similarity index 100% rename from examples/echo_tls/keys/server.key rename to examples/websocket/echo_tls/keys/server.key diff --git a/examples/echo_tls/keys/server.pem b/examples/websocket/echo_tls/keys/server.pem similarity index 100% rename from examples/echo_tls/keys/server.pem rename to examples/websocket/echo_tls/keys/server.pem diff --git a/examples/echo_tls/keys/server.pub b/examples/websocket/echo_tls/keys/server.pub similarity index 100% rename from examples/echo_tls/keys/server.pub rename to examples/websocket/echo_tls/keys/server.pub diff --git a/examples/echo_tls/server.py b/examples/websocket/echo_tls/server.py similarity index 100% rename from examples/echo_tls/server.py rename to examples/websocket/echo_tls/server.py diff --git a/examples/streaming/frame_based_client.py b/examples/websocket/streaming/frame_based_client.py similarity index 100% rename from examples/streaming/frame_based_client.py rename to examples/websocket/streaming/frame_based_client.py diff --git a/examples/streaming/frame_based_server.py b/examples/websocket/streaming/frame_based_server.py similarity index 100% rename from examples/streaming/frame_based_server.py rename to examples/websocket/streaming/frame_based_server.py diff --git a/examples/streaming/message_based_client.py b/examples/websocket/streaming/message_based_client.py similarity index 100% rename from examples/streaming/message_based_client.py rename to examples/websocket/streaming/message_based_client.py diff --git a/examples/streaming/message_based_server.py b/examples/websocket/streaming/message_based_server.py similarity index 100% rename from examples/streaming/message_based_server.py rename to examples/websocket/streaming/message_based_server.py diff --git a/examples/streaming/ranstring.py b/examples/websocket/streaming/ranstring.py similarity index 100% rename from examples/streaming/ranstring.py rename to examples/websocket/streaming/ranstring.py diff --git a/examples/streaming/streaming_client.py b/examples/websocket/streaming/streaming_client.py similarity index 100% rename from examples/streaming/streaming_client.py rename to examples/websocket/streaming/streaming_client.py diff --git a/examples/streaming/streaming_producer_client.py b/examples/websocket/streaming/streaming_producer_client.py similarity index 100% rename from examples/streaming/streaming_producer_client.py rename to examples/websocket/streaming/streaming_producer_client.py diff --git a/examples/streaming/streaming_server.py b/examples/websocket/streaming/streaming_server.py similarity index 100% rename from examples/streaming/streaming_server.py rename to examples/websocket/streaming/streaming_server.py