Merge pull request TooTallNate#649 from marci4/master

marci4 · web-flow · commit f2596956c2ef · 2018-01-14T20:13:52.000+01:00
Update Readme and examples
diff --git a/README.markdown b/README.markdown
@@ -83,6 +83,7 @@ server-side of the
 A WebSocket server by itself doesn't do anything except establish socket
 connections though HTTP. After that it's up to **your** subclass to add purpose.
 
+An example for a WebSocketServer can be found in both the [wiki](https://github.com/TooTallNate/Java-WebSocket/wiki#server-example) and the [example](https://github.com/TooTallNate/Java-WebSocket/tree/master/src/main/example) folder.
 
 Writing your own WebSocket Client
 ---------------------------------
@@ -93,6 +94,8 @@ connect to. Important events `onOpen`, `onClose`, `onMessage` and `onError`
 get fired throughout the life of the WebSocketClient, and must be implemented 
 in **your** subclass.
 
+An example for a WebSocketClient can be found in both the [wiki](https://github.com/TooTallNate/Java-WebSocket/wiki#client-example) and the [example](https://github.com/TooTallNate/Java-WebSocket/tree/master/src/main/example) folder.
+
 WSS Support
 ---------------------------------
 This library supports wss.
diff --git a/src/main/example/ChatServer.java b/src/main/example/ChatServer.java
@@ -51,7 +51,8 @@ public ChatServer( InetSocketAddress address ) {
 
 	@Override
 	public void onOpen( WebSocket conn, ClientHandshake handshake ) {
-		broadcast( "new connection: " + handshake.getResourceDescriptor() );
+		conn.send("Welcome to the server!"); //This method sends a message to the new client
+		broadcast( "new connection: " + handshake.getResourceDescriptor() ); //This method sends a message to all clients connected
 		System.out.println( conn.getRemoteSocketAddress().getAddress().getHostAddress() + " entered the room!" );
 	}
 
diff --git a/src/main/example/ChatServerAttachmentExample.java b/src/main/example/ChatServerAttachmentExample.java
@@ -38,6 +38,9 @@
 
 /**
  * A simple WebSocketServer implementation. Keeps track of a "chatroom".
+ *
+ * Shows how to use the attachment for a WebSocket. This example just uses a simple integer as ID.
+ * Setting an attachment also works in the WebSocketClient
  */
 public class ChatServerAttachmentExample extends WebSocketServer {
 	Integer index = 0;
@@ -52,13 +55,15 @@ public ChatServerAttachmentExample( InetSocketAddress address ) {
 
 	@Override
 	public void onOpen( WebSocket conn, ClientHandshake handshake ) {
-		conn.setAttachment( index );
+		conn.setAttachment( index ); //Set the attachment to the current index
 		index++;
+		// Get the attachment of this connection as Integer
 		System.out.println( conn.getRemoteSocketAddress().getAddress().getHostAddress() + " entered the room! ID: " + conn.<Integer>getAttachment() );
 	}
 
 	@Override
 	public void onClose( WebSocket conn, int code, String reason, boolean remote ) {
+		// Get the attachment of this connection as Integer
 		System.out.println( conn + " has left the room! ID: " + conn.<Integer>getAttachment() );
 	}
 
diff --git a/src/main/example/ExampleClient.java b/src/main/example/ExampleClient.java
@@ -45,6 +45,7 @@ public ExampleClient( URI serverURI ) {
 
 	@Override
 	public void onOpen( ServerHandshake handshakedata ) {
+		send("Hello, it is me. Mario :)");
 		System.out.println( "opened connection" );
 		// if you plan to refuse connection based on ip or httpfields overload: onWebsocketHandshakeReceivedAsClient
 	}

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,8 @@ public ChatServer( InetSocketAddress address ) {`
`51`	`51`
`52`	`52`	`@Override`
`53`	`53`	`public void onOpen( WebSocket conn, ClientHandshake handshake ) {`
`54`		`- broadcast( "new connection: " + handshake.getResourceDescriptor() );`
	`54`	`+ conn.send("Welcome to the server!"); //This method sends a message to the new client`
	`55`	`+ broadcast( "new connection: " + handshake.getResourceDescriptor() ); //This method sends a message to all clients connected`
`55`	`56`	`System.out.println( conn.getRemoteSocketAddress().getAddress().getHostAddress() + " entered the room!" );`
`56`	`57`	`}`
`57`	`58`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ public ExampleClient( URI serverURI ) {`
`45`	`45`
`46`	`46`	`@Override`
`47`	`47`	`public void onOpen( ServerHandshake handshakedata ) {`
	`48`	`+ send("Hello, it is me. Mario :)");`
`48`	`49`	`System.out.println( "opened connection" );`
`49`	`50`	`// if you plan to refuse connection based on ip or httpfields overload: onWebsocketHandshakeReceivedAsClient`
`50`	`51`	`}`