Class Irc::IrcSocket
In: lib/rbot/ircsocket.rb
Parent: Object

wrapped TCPSocket for communication with the server. emulates a subset of TCPSocket functionality

Methods

byterate   byterate=   clearq   connect   connected?   emergency_puts   flush   gets   new   puts_critical   queue   run_throttle   select   sendq_burst=   sendq_delay=   setbyterate   shutdown   spool  

Attributes

bytes_per  [R]  byterate components
bytes_received  [R]  total number of bytes received from the irc server
bytes_sent  [R]  total number of bytes sent to the irc server
lines_received  [R]  total number of lines received from the irc server
lines_sent  [R]  total number of lines sent to the irc server
seconds_per  [R] 
sendq_burst  [R]  max lines to burst
sendq_delay  [R]  delay between lines sent
throttle_bytes  [R]  accumulator for the throttle

Public Class methods

new(server, port, host, sendq_delay=2, sendq_burst=4, brt="400/2")
server:server to connect to
port:IRCd port
host:optional local host to bind to (ruby 1.7+ required)

create a new IrcSocket

Public Instance methods

connect()

open a TCP connection to the server

emergency_puts(message)

used to send lines to the remote IRCd by skipping the queue message: IRC message to send it should only be used for stuff that *must not* be queued, i.e. the initial PASS, NICK and USER command or the final QUIT message

flush()

flush the TCPSocket

gets()

get the next line from the server (blocks)

select(timeout=nil)

Wraps Kernel.select on the socket

shutdown(how=2)

shutdown the connection to the server

spool()

pop a message off the queue, send it

Private Instance methods

puts_critical(message)

same as puts, but expects to be called with a mutex held on @qmutex

[Validate]