Class deprecated or moved

This class is deprecated or moved on the latest stable version. The last existing version (v2_1_10) is shown here.

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.


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)
  def serve(io)

# Run the server with logging enabled (it's a separate thread).
server = TimeServer.new
server.audit = true                  # Turn logging on.

# *** 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.

# Alternatively, stop it immediately.
# 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.


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.




[RW] debug

Set to true to show more detailed logging

[RW] audit

Set to true to cause the callbacks #connecting, #disconnecting, #starting, and #stopping to be called during the server’s lifecycle

[RW] stdlog

IO Device on which log messages should be written

[R] maxConnections

Maximum number of connections to accept at a time, as a Fixnum

[R] host

Host on which to bind, as a String

[R] port

Port on which to listen, as a Fixnum

Show files where this class is defined (1 file)
Register or log in to add new notes.