FilesExpand file tree

master

/

WebSocketServiceHost.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

238 lines (205 loc) · 5.49 KB

master

/

WebSocketServiceHost.cs

Copy path

Top

File metadata and controls

• Code
• Blame

238 lines (205 loc) · 5.49 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

#region License

/*

* WebSocketServiceHost.cs

*

* The MIT License

*

* Copyright (c) 2012-2017 sta.blockhead

* Copyright © 2017 Nivloc Enterprises Ltd

*

* Permission is hereby granted, free of charge, to any person obtaining a copy

* of this software and associated documentation files (the "Software"), to deal

* in the Software without restriction, including without limitation the rights

* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

* copies of the Software, and to permit persons to whom the Software is

* furnished to do so, subject to the following conditions:

*

* The above copyright notice and this permission notice shall be included in

* all copies or substantial portions of the Software.

*

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

* THE SOFTWARE.

*/

#endregion

#region Contributors

/*

* Contributors:

* - Juan Manuel Lallana <juan.manuel.lallana@gmail.com>

*/

#endregion

using System;

using WebSocketSharp.Net.WebSockets;

namespace WebSocketSharp.Server

{

/// <summary>

/// Exposes the methods and properties used to access the information in

/// a WebSocket service provided by the <see cref="WebSocketServer"/> or

/// <see cref="HttpServer"/>.

/// </summary>

/// <remarks>

/// This class is an abstract class.

/// </remarks>

public abstract class WebSocketServiceHost

{

#region Private Fields

private Logger _log;

private string _path;

private WebSocketSessionManager _sessions;

#endregion

#region Protected Constructors

/// <summary>

/// Initializes a new instance of the <see cref="WebSocketServiceHost"/> class

/// with the specified <paramref name="path"/> and <paramref name="log"/>.

/// </summary>

/// <param name="path">

/// A <see cref="string"/> that represents the absolute path to the service.

/// </param>

/// <param name="log">

/// A <see cref="Logger"/> that represents the logging function for the service.

/// </param>

protected WebSocketServiceHost (string path, Logger log)

{

_path = path;

_log = log;

_sessions = new WebSocketSessionManager (log);

}

#endregion

#region Internal Properties

internal ServerState State

{

get

{

return _sessions.State;

}

}

#endregion

#region Protected Properties

/// <summary>

/// Gets the logging function for the service.

/// </summary>

/// <value>

/// A <see cref="Logger"/> that provides the logging function.

/// </value>

protected Logger Log

{

get

{

return _log;

}

}

#endregion

#region Public Properties

/// <summary>

/// Gets or sets a value indicating whether the service cleans up

/// the inactive sessions periodically.

/// </summary>

/// <remarks>

/// The set operation does nothing if the service has already started or

/// it is shutting down.

/// </remarks>

/// <value>

/// <c>true</c> if the service cleans up the inactive sessions every 60

/// seconds; otherwise, <c>false</c>.

/// </value>

public bool KeepClean

{

get

{

return _sessions.KeepClean;

}

set

{

_sessions.KeepClean = value;

}

}

/// <summary>

/// Gets the path to the service.

/// </summary>

/// <value>

/// A <see cref="string"/> that represents the absolute path to the service.

/// </value>

public string Path

{

get

{

return _path;

}

}

/// <summary>

/// Gets the management function for the sessions in the service.

/// </summary>

/// <value>

/// A <see cref="WebSocketSessionManager"/> that manages the sessions in

/// the service.

/// </value>

public WebSocketSessionManager Sessions

{

get

{

return _sessions;

}

}

/// <summary>

/// Gets the <see cref="Type"/> of the behavior of the service.

/// </summary>

/// <value>

/// A <see cref="Type"/> that represents the type of the behavior of

/// the service.

/// </value>

public abstract Type BehaviorType { get; }

/// <summary>

/// Gets or sets the time to wait for the response to the WebSocket Ping or

/// </summary>

/// <remarks>

/// The set operation does nothing if the service has already started or

/// it is shutting down.

/// </remarks>

/// <value>

/// A <see cref="TimeSpan"/> to wait for the response.

/// </value>

/// <exception cref="ArgumentOutOfRangeException">

/// The value specified for a set operation is zero or less.

/// </exception>

public TimeSpan WaitTime

{

get

{

return _sessions.WaitTime;

}

set

{

_sessions.WaitTime = value;

}

}

#endregion

#region Internal Methods

internal void Start ()

{

_sessions.Start ();

}

internal void StartSession (WebSocketContext context)

{

CreateSession ().Start (context, _sessions);

}

internal void Stop (ushort code, string reason)

{

_sessions.Stop (code, reason);

}

#endregion

#region Protected Methods

/// <summary>

/// Creates a new session for the service.

/// </summary>

/// <returns>

/// A <see cref="WebSocketBehavior"/> instance that represents

/// the new session.

/// </returns>

protected abstract WebSocketBehavior CreateSession ();

#endregion

}

}