Class: GenericServer

Inherits:
Object
  • Object
show all
Defined in:
lib/generic_server.rb

Overview

This class starts a generic server, accepting connections on options

When extending this class make sure you:

  • def greet(client)

  • def process(client, command, full_data)

  • client.close when you’re done

You can respond to the client using:

  • respond(client, text)

The command given to process equals the first word of full_data in upcase, e.g. QUIT or LIST

It’s possible for multiple clients to connect at the same time, so use client.object_id when storing local data

Direct Known Subclasses

POPServer, SMTPServer

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ GenericServer

Returns a new instance of GenericServer.



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
 
# File 'lib/generic_server.rb', line 25

def initialize(options)
  @port = options[:port]
  server = TCPServer.open(@port)
  $log.info "#{self.class.to_s} listening on port #{@port}"

  # Try to increase the buffer to give us some more time to parse incoming data
  begin
    server.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVBUF, 1024 * 1024)
  rescue
    # then try it using our available buffer
  end

  # Accept connections until infinity and beyond
  loop do
    Thread.start(server.accept) do |client|
      begin
        client_addr = client.addr
        $log.info "#{self.class.to_s} accepted connection #{client.object_id} from #{client_addr.inspect}"
        greet client

        # Keep processing commands until somebody closed the connection
        begin
          input = client.gets

          # The first word of a line should contain the command
          command = input.to_s.gsub(/ .*/,"").upcase.gsub(/[\r\n]/,"")

          $log.debug "#{client.object_id}:#{@port} < #{input}"

          process(client, command, input)

        end until client.closed?
        $log.info "#{self.class.to_s} closed connection #{client.object_id} with #{client_addr.inspect}"
      rescue => detail
        $log.error "#{client.object_id}:#{@port} ! #{$!}"
        client.close
      end
    end
  end
end

Instance Method Details

#respond(client, text) ⇒ Object

Respond to client by sending back text



67
68
69
70
71
72
73
 
# File 'lib/generic_server.rb', line 67

def respond(client, text)
  $log.debug "#{client.object_id}:#{@port} > #{text}"
  client.write text
rescue
  $log.error "#{client.object_id}:#{@port} ! #{$!}"
  client.close
end