DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Modified README.md

Browse Source
This commit is contained in:
sta 2013-07-01 12:18:26 +09:00
parent 11c576a8c7
commit d2e8ed5f12
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,11 +1,11 @@
<!-- # websocket-sharp # --> <!-- # websocket-sharp # -->
![Logo](websocket-sharp.png) ![Logo](websocket-sharp.png)
**websocket-sharp** is a C# implementation of the WebSocket protocol client & server. **websocket-sharp** is a C# implementation of the **WebSocket** protocol client & server.
## Usage ## ## Usage ##
### WebSocket client ### ### WebSocket Client ###
```cs ```cs
using System; using System;
@ -45,7 +45,7 @@ The `WebSocket` class exists in the `WebSocketSharp` namespace.
#### Step 2 #### #### Step 2 ####
Creating a instance of the `WebSocket` class. Creating a instance of the `WebSocket` class with the specified WebSocket URL.
```cs ```cs
using (var ws = new WebSocket("ws://example.com")) using (var ws = new WebSocket("ws://example.com"))
@ -118,7 +118,7 @@ The `e.Message` (`WebSocketSharp.ErrorEventArgs.Message`, its type is `string`)
##### WebSocket.OnClose event ##### ##### WebSocket.OnClose event #####
The `WebSocket.OnClose` event occurs when the `WebSocket` receives a Close frame or the `Close` method is called. The `WebSocket.OnClose` event occurs when the `WebSocket` connection has been closed.
```cs ```cs
ws.OnClose += (sender, e) => ws.OnClose += (sender, e) =>
@ -147,7 +147,7 @@ ws.Send(data);
The `Send` method is overloaded. The `Send` method is overloaded.
The types of `data` are `string`, `byte[]` or `FileInfo` class. The types of `data` are `string`, `byte[]` and `FileInfo` class.
#### Step 6 #### #### Step 6 ####
@ -165,7 +165,7 @@ The types of `code` are `WebSocketSharp.CloseStatusCode` and `ushort`, the type
In addition, the `Close()` and `Close(code)` methods exist. In addition, the `Close()` and `Close(code)` methods exist.
### WebSocket server ### ### WebSocket Server ###
```cs ```cs
using System; using System;
@ -310,7 +310,7 @@ Stopping the server.
wssv.Stop(); wssv.Stop();
``` ```
### HTTP server with the WebSocket ### ### HTTP Server with the WebSocket ###
I modified the `System.Net.HttpListener`, `System.Net.HttpListenerContext` and some other classes of [Mono] to create the HTTP server that can upgrade the connection to the WebSocket connection when receives a WebSocket request. I modified the `System.Net.HttpListener`, `System.Net.HttpListenerContext` and some other classes of [Mono] to create the HTTP server that can upgrade the connection to the WebSocket connection when receives a WebSocket request.
@ -321,7 +321,11 @@ var httpsv = new HttpServer(4649);
httpsv.AddWebSocketService<Echo>("/"); httpsv.AddWebSocketService<Echo>("/");
``` ```
For more information, please refer to the [Example3]. For more information, could you see **[Example3]**?
## Required Environment ##
C# **3.0**, .NET **3.5** compatible or later.
## Examples ## ## Examples ##