Class: Irc::IrcSocket

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

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

Methods

clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq clearq

Public Class methods

new(server, port, host, sendfreq=2, maxburst=4)

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

set_sendq(newfreq)

set_maxburst(newburst)

get_maxburst()

get_sendq()

puts(message)

used to send lines to the remote IRCd message: IRC message to send

gets()

get the next line from the server (blocks)

queue(msg)

spooler()

spool()

pop a message off the queue, send it

clearq()

flush()

flush the TCPSocket

select(timeout)

Wraps Kernel.select on the socket

shutdown(how=2)

shutdown the connection to the server

Private Instance methods

puts_critical(message)

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