7 # wrapped TCPSocket for communication with the server.
8 # emulates a subset of TCPSocket functionality
10 # total number of lines sent to the irc server
11 attr_reader :lines_sent
13 # total number of lines received from the irc server
14 attr_reader :lines_received
16 # delay between lines sent
17 attr_reader :sendq_delay
20 attr_reader :sendq_burst
22 # server:: server to connect to
24 # host:: optional local host to bind to (ruby 1.7+ required)
25 # create a new IrcSocket
26 def initialize(server, port, host, sendq_delay=2, sendq_burst=4)
27 @timer = Timer::Timer.new
39 @sendq_delay = sendq_delay.to_f
43 @last_send = Time.new - @sendq_delay
46 @sendq_burst = sendq_burst.to_i
56 # open a TCP connection to the server
63 @sock=TCPSocket.new(@server, @port, @host)
64 rescue ArgumentError => e
65 $stderr.puts "Your version of ruby does not support binding to a "
66 $stderr.puts "specific local address, please upgrade if you wish "
67 $stderr.puts "to use HOST = foo"
68 $stderr.puts "(this option has been disabled in order to continue)"
69 @sock=TCPSocket.new(@server, @port)
72 @sock=TCPSocket.new(@server, @port)
79 def sendq_delay=(newfreq)
80 debug "changing sendq frequency to #{newfreq}"
81 @qmutex.synchronize do
82 @sendq_delay = newfreq
92 def sendq_burst=(newburst)
93 @qmutex.synchronize do
94 @sendq_burst = newburst
98 # used to send lines to the remote IRCd
99 # message: IRC message to send
101 @qmutex.synchronize do
102 # debug "In puts - got mutex"
103 puts_critical(message)
107 # get the next line from the server (blocks)
112 reply.strip! if reply
113 debug "RECV: #{reply.inspect}"
116 debug "socket get failed: #{e}"
123 @qmutex.synchronize do
128 # just send it if queueing is disabled
133 # pop a message off the queue, send it
140 if (now >= (@last_send + @sendq_delay))
141 # reset burst counter after @sendq_delay has passed
143 debug "in spool, resetting @burst"
144 elsif (@burst >= @sendq_burst)
145 # nope. can't send anything, come back to us next tick...
149 @qmutex.synchronize do
150 debug "(can send #{@sendq_burst - @burst} lines, there are #{@sendq.length} to send)"
151 (@sendq_burst - @burst).times do
152 break if @sendq.empty?
153 puts_critical(@sendq.shift)
163 @qmutex.synchronize do
169 # flush the TCPSocket
174 # Wraps Kernel.select on the socket
175 def select(timeout=nil)
176 Kernel.select([@sock], nil, nil, timeout)
179 # shutdown the connection to the server
181 @sock.shutdown(how) unless @sock.nil?
187 # same as puts, but expects to be called with a mutex held on @qmutex
188 def puts_critical(message)
189 # debug "in puts_critical"
190 debug "SEND: #{message.inspect}"
191 @sock.send(message + "\n",0)
192 @last_send = Time.new