Type:
Class
Constants:
DEFAULT_HOST : "127.0.0.1"

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.

The above methods are only called if auditing is enabled, via audit=.

You can also override log and error if, for example, you wish to use a more sophisticated logging system.

new

new(port, host = DEFAULT_HOST, maxConnections = 4, stdlog = $stderr, audit = false, debug = false) Class Public methods

2015-04-11 20:08:31
shutdown

shutdown() Instance Public methods Schedule a shutdown for the server

2015-04-11 20:27:46
starting

starting() Instance Protected methods Called when the server is starting up

2015-04-11 21:02:57
start

start(maxConnections = -1) Instance Public methods Start the server if it isn't

2015-04-11 20:35:10
join

join() Instance Public methods Join with the server thread

2015-04-11 20:15:35
stop 2

stop() Instance Public methods Stop the server

2015-04-11 20:39:45
connections

connections() Instance Public methods Return the current number of connected

2015-04-11 20:12:39
connecting

connecting(client) Instance Protected methods Called when a client connects

2015-04-11 20:46:44
disconnecting

disconnecting(clientPort) Instance Protected methods Called when a client disconnects

2015-04-11 20:48:35
stop

stop(port, host = DEFAULT_HOST) Class Public methods Stop the server running

2015-04-11 20:10:49