Class: GServer
Overview
GServer implements a generic server, featuring thread pool management, simple logging, and multi-server management. See HttpServer in xmlrpc/httpserver.rb
in the Ruby standard library for an example of GServer in action.
Any kind of application-level server can be implemented using this class. It accepts multiple simultaneous connections from clients, up to an optional maximum number. Several services (i.e. one service per TCP port) can be run simultaneously, and stopped at any time through the class method GServer.stop(port)
. All the threading issues are handled, saving you the effort. All events are optionally logged, but you can provide your own event handlers if you wish.
Example
Using GServer is simple. Below we implement a simple time server, run it, query it, and shut it down. Try this code in irb
:
require 'gserver'
#
# A server that returns the time in seconds since 1970.
#
class TimeServer < GServer
def initialize(port=10001, *args)
super(port, *args)
end
def serve(io)
io.puts(Time.now.to_i)
end
end
# Run the server with logging enabled (it's a separate thread).
server = TimeServer.new
server.audit = true # Turn logging on.
server.start
# *** Now point your browser to http://localhost:10001 to see it working ***
# See if it's still running.
GServer.in_service?(10001) # -> true
server.stopped? # -> false
# Shut the server down gracefully.
server.shutdown
# Alternatively, stop it immediately.
GServer.stop(10001)
# or, of course, "server.stop".
All the business of accepting connections and exception handling is taken care of. All we have to do is implement the method that actually serves the client.
Advanced
As the example above shows, the way to use GServer is to subclass it to create a specific server, overriding the serve
method. You can override other methods as well if you wish, perhaps to collect statistics, or emit more detailed logging.
connecting
disconnecting
starting
stopping
The above methods are only called if auditing is enabled.
You can also override log
and error
if, for example, you wish to use a more sophisticated logging system.
Direct Known Subclasses
Constant Summary collapse
- DEFAULT_HOST =
"127.0.0.1"
- @@services =
Hash of opened ports, i.e. services
{}
- @@servicesMutex =
DangoMutex.new(:gServer_servicesMutex)
Instance Attribute Summary collapse
-
#audit ⇒ Object
Returns the value of attribute audit.
-
#debug ⇒ Object
Returns the value of attribute debug.
-
#host ⇒ Object
readonly
Returns the value of attribute host.
-
#maxConnections ⇒ Object
readonly
Returns the value of attribute maxConnections.
-
#port ⇒ Object
readonly
Returns the value of attribute port.
-
#stdlog ⇒ Object
Returns the value of attribute stdlog.
Class Method Summary collapse
Instance Method Summary collapse
- #connections ⇒ Object
-
#initialize(port, host = DEFAULT_HOST, maxConnections = 4, stdlog = $stderr, audit = false, debug = false) ⇒ GServer
constructor
A new instance of GServer.
- #join ⇒ Object
- #serve(io) ⇒ Object
- #shutdown ⇒ Object
-
#start(maxConnections = -1,, backlog = nil) ⇒ Object
この部分を改造.
- #stop ⇒ Object
- #stopped? ⇒ Boolean
Constructor Details
#initialize(port, host = DEFAULT_HOST, maxConnections = 4, stdlog = $stderr, audit = false, debug = false) ⇒ GServer
Returns a new instance of GServer.
178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/dango/dango_g_server.rb', line 178 def initialize(port, host = DEFAULT_HOST, maxConnections = 4, stdlog = $stderr, audit = false, debug = false) @tcpServerThread = nil @port = port @host = host @maxConnections = maxConnections @connections = [] @connectionsMutex = DangoMutex.new(:gServer_connectionsMutex) @connectionsCV = ConditionVariable.new @stdlog = stdlog @audit = audit @debug = debug end |
Instance Attribute Details
#audit ⇒ Object
Returns the value of attribute audit.
139 140 141 |
# File 'lib/dango/dango_g_server.rb', line 139 def audit @audit end |
#debug ⇒ Object
Returns the value of attribute debug.
139 140 141 |
# File 'lib/dango/dango_g_server.rb', line 139 def debug @debug end |
#host ⇒ Object (readonly)
Returns the value of attribute host.
138 139 140 |
# File 'lib/dango/dango_g_server.rb', line 138 def host @host end |
#maxConnections ⇒ Object (readonly)
Returns the value of attribute maxConnections.
138 139 140 |
# File 'lib/dango/dango_g_server.rb', line 138 def maxConnections @maxConnections end |
#port ⇒ Object (readonly)
Returns the value of attribute port.
138 139 140 |
# File 'lib/dango/dango_g_server.rb', line 138 def port @port end |
#stdlog ⇒ Object
Returns the value of attribute stdlog.
139 140 141 |
# File 'lib/dango/dango_g_server.rb', line 139 def stdlog @stdlog end |
Class Method Details
.in_service?(port, host = DEFAULT_HOST) ⇒ Boolean
109 110 111 112 |
# File 'lib/dango/dango_g_server.rb', line 109 def GServer.in_service?(port, host = DEFAULT_HOST) @@services.has_key?(host) and @@services[host].has_key?(port) end |
.stop(port, host = DEFAULT_HOST) ⇒ Object
103 104 105 106 107 |
# File 'lib/dango/dango_g_server.rb', line 103 def GServer.stop(port, host = DEFAULT_HOST) @@servicesMutex.timeout_sync(10, :GServer_stop) { @@services[host][port].stop } end |
Instance Method Details
#connections ⇒ Object
130 131 132 |
# File 'lib/dango/dango_g_server.rb', line 130 def connections @connections.size end |
#join ⇒ Object
134 135 136 |
# File 'lib/dango/dango_g_server.rb', line 134 def join @tcpServerThread.join if @tcpServerThread end |
#serve(io) ⇒ Object
97 98 |
# File 'lib/dango/dango_g_server.rb', line 97 def serve(io) end |
#shutdown ⇒ Object
126 127 128 |
# File 'lib/dango/dango_g_server.rb', line 126 def shutdown @shutdown = true end |
#start(maxConnections = -1,, backlog = nil) ⇒ Object
この部分を改造
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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/dango/dango_g_server.rb', line 192 def start(maxConnections = -1, backlog = nil) # この部分を改造 raise "running" if !stopped? @shutdown = false @maxConnections = maxConnections if maxConnections > 0 @@servicesMutex.synchronize { if GServer.in_service?(@port,@host) raise "Port already in use: #{host}:#{@port}!" end @tcpServer = TCPServer.new(@host,@port) @tcpServer.listen(backlog) if backlog # この部分を改造 @port = @tcpServer.addr[1] @@services[@host] = {} unless @@services.has_key?(@host) @@services[@host][@port] = self; } @tcpServerThread = Thread.new { Thread.current[:_name] = "thread gserver tcpServerThread" begin starting if @audit while !@shutdown @connectionsMutex.synchronize { while @connections.size >= @maxConnections @connectionsCV.wait(@connectionsMutex) end } client = @tcpServer.accept @connections << Thread.new(client) { |myClient| begin myPort = myClient.peeraddr[1] serve(myClient) if !@audit or connecting(myClient) rescue => detail error(detail) if @debug ensure begin myClient.close rescue end @connectionsMutex.synchronize { @connections.delete(Thread.current) @connectionsCV.signal } disconnecting(myPort) if @audit end } end rescue => detail error(detail) if @debug ensure begin @tcpServer.close rescue end if @shutdown @connectionsMutex.synchronize { while @connections.size > 0 @connectionsCV.wait(@connectionsMutex) end } else @connections.each { |c| c.raise "stop" } end @tcpServerThread = nil @@servicesMutex.timeout_sync(10, :stopping) { @@services[@host].delete(@port) } stopping if @audit end } self end |
#stop ⇒ Object
114 115 116 117 118 119 120 |
# File 'lib/dango/dango_g_server.rb', line 114 def stop @connectionsMutex.timeout_sync(10, :stop) { if @tcpServerThread @tcpServerThread.raise "stop. " end } end |
#stopped? ⇒ Boolean
122 123 124 |
# File 'lib/dango/dango_g_server.rb', line 122 def stopped? @tcpServerThread == nil end |