forked from chronoxor/NetCoreServer
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIWebSocket.cs
More file actions
92 lines (82 loc) · 3.84 KB
/
Copy pathIWebSocket.cs
File metadata and controls
92 lines (82 loc) · 3.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
using System.Net.Sockets;
namespace NetCoreServer
{
public interface IWebSocket
{
/// <summary>
/// Handle WebSocket client connecting notification
/// </summary>
/// <remarks>Notification is called when WebSocket client is connecting to the server. You can handle the connection and change WebSocket upgrade HTTP request by providing your own headers.</remarks>
/// <param name="request">WebSocket upgrade HTTP request</param>
void OnWsConnecting(HttpRequest request) {}
/// <summary>
/// Handle WebSocket client connected notification
/// </summary>
/// <param name="response">WebSocket upgrade HTTP response</param>
void OnWsConnected(HttpResponse response) {}
/// <summary>
/// Handle WebSocket server session validating notification
/// </summary>
/// <remarks>Notification is called when WebSocket client is connecting to the server. You can handle the connection and validate WebSocket upgrade HTTP request.</remarks>
/// <param name="request">WebSocket upgrade HTTP request</param>
/// <param name="response">WebSocket upgrade HTTP response</param>
/// <returns>return 'true' if the WebSocket update request is valid, 'false' if the WebSocket update request is not valid</returns>
bool OnWsConnecting(HttpRequest request, HttpResponse response) { return true; }
/// <summary>
/// Handle WebSocket server session connected notification
/// </summary>
/// <param name="request">WebSocket upgrade HTTP request</param>
void OnWsConnected(HttpRequest request) {}
/// <summary>
/// Handle WebSocket client disconnecting notification
/// </summary>
void OnWsDisconnecting() {}
/// <summary>
/// Handle WebSocket client disconnected notification
/// </summary>
void OnWsDisconnected() {}
/// <summary>
/// Handle WebSocket received notification
/// </summary>
/// <param name="buffer">Received buffer</param>
/// <param name="offset">Received buffer offset</param>
/// <param name="size">Received buffer size</param>
void OnWsReceived(byte[] buffer, long offset, long size) {}
/// <summary>
/// Handle WebSocket client close notification
/// </summary>
/// <param name="buffer">Received buffer</param>
/// <param name="offset">Received buffer offset</param>
/// <param name="size">Received buffer size</param>
void OnWsClose(byte[] buffer, long offset, long size) {}
/// <summary>
/// Handle WebSocket ping notification
/// </summary>
/// <param name="buffer">Received buffer</param>
/// <param name="offset">Received buffer offset</param>
/// <param name="size">Received buffer size</param>
void OnWsPing(byte[] buffer, long offset, long size) {}
/// <summary>
/// Handle WebSocket pong notification
/// </summary>
/// <param name="buffer">Received buffer</param>
/// <param name="offset">Received buffer offset</param>
/// <param name="size">Received buffer size</param>
void OnWsPong(byte[] buffer, long offset, long size) {}
/// <summary>
/// Handle WebSocket error notification
/// </summary>
/// <param name="error">Error message</param>
void OnWsError(string error) {}
/// <summary>
/// Handle socket error notification
/// </summary>
/// <param name="error">Socket error</param>
void OnWsError(SocketError error) {}
/// <summary>
/// Send WebSocket server upgrade response
/// </summary>
/// <param name="response">WebSocket upgrade HTTP response</param>
void SendUpgrade(HttpResponse response) {}
}
}