webkitpy.thirdparty.irc.irclib.ServerConnection Class Reference

Inheritance diagram for webkitpy.thirdparty.irc.irclib.ServerConnection:

Public Member Functions
def	__init__ (self, irclibobj)
def	connect (self, server, port, nickname, password=None, username=None, ircname=None, localaddress="", localport=0, ssl=False, ipv6=False)
def	close (self)
def	get_server_name (self)
def	get_nickname (self)
def	process_data (self)
def	is_connected (self)
def	add_global_handler (self, args)
def	remove_global_handler (self, args)
def	action (self, target, action)
def	admin (self, server="")
def	ctcp (self, ctcptype, target, parameter="")
def	ctcp_reply (self, target, parameter)
def	disconnect (self, message="")
def	globops (self, text)
def	info (self, server="")
def	invite (self, nick, channel)
def	ison (self, nicks)
def	join (self, channel, key="")
def	kick (self, channel, nick, comment="")
def	links (self, remote_server="", server_mask="")
def	list (self, channels=None, server="")
def	lusers (self, server="")
def	mode (self, target, command)
def	motd (self, server="")
def	names (self, channels=None)
def	nick (self, newnick)
def	notice (self, target, text)
def	oper (self, nick, password)
def	part (self, channels, message="")
def	pass_ (self, password)
def	ping (self, target, target2="")
def	pong (self, target, target2="")
def	privmsg (self, target, text)
def	privmsg_many (self, targets, text)
def	quit (self, message="")
def	send_raw (self, string)
def	squit (self, server, comment="")
def	stats (self, statstype, server="")
def	time (self, server="")
def	topic (self, channel, new_topic=None)
def	trace (self, target="")
def	user (self, username, realname)
def	userhost (self, nicks)
def	users (self, server="")
def	version (self, server="")
def	wallops (self, text)
def	who (self, target="", op="")
def	whois (self, targets)
def	whowas (self, nick, max="", server="")
Public Member Functions inherited from webkitpy.thirdparty.irc.irclib.Connection
def	__init__ (self, irclibobj)
def	execute_at (self, at, function, arguments=())
	Convenience wrappers. More...
def	execute_delayed (self, delay, function, arguments=())

Public Attributes
	connected
	socket
	ssl
	previous_buffer
	handlers
	real_server_name
	real_nickname
	server
	port
	nickname
	username
	ircname
	password
	localaddress
	localport
	localhost
Public Attributes inherited from webkitpy.thirdparty.irc.irclib.Connection
	irclibobj

Detailed Description

This class represents an IRC server connection.

ServerConnection objects are instantiated by calling the server
method on an IRC object.

Constructor & Destructor Documentation

__init__()

def webkitpy.thirdparty.irc.irclib.ServerConnection.__init__	(		self,
			irclibobj
	)

Member Function Documentation

action()

def webkitpy.thirdparty.irc.irclib.ServerConnection.action	(		self,
			target,
			action
	)

Send a CTCP ACTION command.

add_global_handler()

def webkitpy.thirdparty.irc.irclib.ServerConnection.add_global_handler	(		self,
			args
	)

Add global handler.

See documentation for IRC.add_global_handler.

admin()

def webkitpy.thirdparty.irc.irclib.ServerConnection.admin	(		self,
			server = ""
	)

Send an ADMIN command.

close()

def webkitpy.thirdparty.irc.irclib.ServerConnection.close

(

self

)

Close the connection.

This method closes the connection permanently; after it has
been called, the object is unusable.

connect()

def webkitpy.thirdparty.irc.irclib.ServerConnection.connect	(		self,
			server,
			port,
			nickname,
			password = None,
			username = None,
			ircname = None,
			localaddress = "",
			localport = 0,
			ssl = False,
			ipv6 = False
	)

Connect/reconnect to a server.

Arguments:

    server -- Server name.

    port -- Port number.

    nickname -- The nickname.

    password -- Password (if any).

    username -- The username.

    ircname -- The IRC name ("realname").

    localaddress -- Bind the connection to a specific local IP address.

    localport -- Bind the connection to a specific local port.

    ssl -- Enable support for ssl.

    ipv6 -- Enable support for ipv6.

This function can be called to reconnect a closed connection.

Returns the ServerConnection object.

ctcp()

def webkitpy.thirdparty.irc.irclib.ServerConnection.ctcp	(		self,
			ctcptype,
			target,
			parameter = ""
	)

Send a CTCP command.

ctcp_reply()

def webkitpy.thirdparty.irc.irclib.ServerConnection.ctcp_reply	(		self,
			target,
			parameter
	)

Send a CTCP REPLY command.

disconnect()

def webkitpy.thirdparty.irc.irclib.ServerConnection.disconnect	(		self,
			message = ""
	)

Hang up the connection.

Arguments:

    message -- Quit message.

get_nickname()

def webkitpy.thirdparty.irc.irclib.ServerConnection.get_nickname

(

self

)

Get the (real) nick name.

This method returns the (real) nickname.  The library keeps
track of nick changes, so it might not be the nick name that
was passed to the connect() method.  

get_server_name()

def webkitpy.thirdparty.irc.irclib.ServerConnection.get_server_name

(

self

)

Get the (real) server name.

This method returns the (real) server name, or, more
specifically, what the server calls itself.

globops()

def webkitpy.thirdparty.irc.irclib.ServerConnection.globops	(		self,
			text
	)

Send a GLOBOPS command.

info()

def webkitpy.thirdparty.irc.irclib.ServerConnection.info	(		self,
			server = ""
	)

Send an INFO command.

invite()

def webkitpy.thirdparty.irc.irclib.ServerConnection.invite	(		self,
			nick,
			channel
	)

Send an INVITE command.

is_connected()

def webkitpy.thirdparty.irc.irclib.ServerConnection.is_connected

(

self

)

Return connection status.

Returns true if connected, otherwise false.

ison()

def webkitpy.thirdparty.irc.irclib.ServerConnection.ison	(		self,
			nicks
	)

Send an ISON command.

Arguments:

    nicks -- List of nicks.

join()

def webkitpy.thirdparty.irc.irclib.ServerConnection.join	(		self,
			channel,
			key = ""
	)

Send a JOIN command.

kick()

def webkitpy.thirdparty.irc.irclib.ServerConnection.kick	(		self,
			channel,
			nick,
			comment = ""
	)

Send a KICK command.

links()

def webkitpy.thirdparty.irc.irclib.ServerConnection.links	(		self,
			remote_server = "",
			server_mask = ""
	)

Send a LINKS command.

list()

def webkitpy.thirdparty.irc.irclib.ServerConnection.list	(		self,
			channels = None,
			server = ""
	)

Send a LIST command.

lusers()

def webkitpy.thirdparty.irc.irclib.ServerConnection.lusers	(		self,
			server = ""
	)

Send a LUSERS command.

mode()

def webkitpy.thirdparty.irc.irclib.ServerConnection.mode	(		self,
			target,
			command
	)

Send a MODE command.

motd()

def webkitpy.thirdparty.irc.irclib.ServerConnection.motd	(		self,
			server = ""
	)

Send an MOTD command.

names()

def webkitpy.thirdparty.irc.irclib.ServerConnection.names	(		self,
			channels = None
	)

Send a NAMES command.

nick()

def webkitpy.thirdparty.irc.irclib.ServerConnection.nick	(		self,
			newnick
	)

Send a NICK command.

notice()

def webkitpy.thirdparty.irc.irclib.ServerConnection.notice	(		self,
			target,
			text
	)

Send a NOTICE command.

oper()

def webkitpy.thirdparty.irc.irclib.ServerConnection.oper	(		self,
			nick,
			password
	)

Send an OPER command.

part()

def webkitpy.thirdparty.irc.irclib.ServerConnection.part	(		self,
			channels,
			message = ""
	)

Send a PART command.

pass_()

def webkitpy.thirdparty.irc.irclib.ServerConnection.pass_	(		self,
			password
	)

Send a PASS command.

ping()

def webkitpy.thirdparty.irc.irclib.ServerConnection.ping	(		self,
			target,
			target2 = ""
	)

Send a PING command.

pong()

def webkitpy.thirdparty.irc.irclib.ServerConnection.pong	(		self,
			target,
			target2 = ""
	)

Send a PONG command.

privmsg()

def webkitpy.thirdparty.irc.irclib.ServerConnection.privmsg	(		self,
			target,
			text
	)

Send a PRIVMSG command.

privmsg_many()

def webkitpy.thirdparty.irc.irclib.ServerConnection.privmsg_many	(		self,
			targets,
			text
	)

Send a PRIVMSG command to multiple targets.

process_data()

def webkitpy.thirdparty.irc.irclib.ServerConnection.process_data

(

self

)

[Internal]

quit()

def webkitpy.thirdparty.irc.irclib.ServerConnection.quit	(		self,
			message = ""
	)

Send a QUIT command.

remove_global_handler()

def webkitpy.thirdparty.irc.irclib.ServerConnection.remove_global_handler	(		self,
			args
	)

Remove global handler.

See documentation for IRC.remove_global_handler.

send_raw()

def webkitpy.thirdparty.irc.irclib.ServerConnection.send_raw	(		self,
			string
	)

Send raw string to the server.

The string will be padded with appropriate CR LF.

squit()

def webkitpy.thirdparty.irc.irclib.ServerConnection.squit	(		self,
			server,
			comment = ""
	)

Send an SQUIT command.

stats()

def webkitpy.thirdparty.irc.irclib.ServerConnection.stats	(		self,
			statstype,
			server = ""
	)

Send a STATS command.

time()

def webkitpy.thirdparty.irc.irclib.ServerConnection.time	(		self,
			server = ""
	)

Send a TIME command.

topic()

def webkitpy.thirdparty.irc.irclib.ServerConnection.topic	(		self,
			channel,
			new_topic = None
	)

Send a TOPIC command.

trace()

def webkitpy.thirdparty.irc.irclib.ServerConnection.trace	(		self,
			target = ""
	)

Send a TRACE command.

user()

def webkitpy.thirdparty.irc.irclib.ServerConnection.user	(		self,
			username,
			realname
	)

Send a USER command.

userhost()

def webkitpy.thirdparty.irc.irclib.ServerConnection.userhost	(		self,
			nicks
	)

Send a USERHOST command.

users()

def webkitpy.thirdparty.irc.irclib.ServerConnection.users	(		self,
			server = ""
	)

Send a USERS command.

version()

def webkitpy.thirdparty.irc.irclib.ServerConnection.version	(		self,
			server = ""
	)

Send a VERSION command.

wallops()

def webkitpy.thirdparty.irc.irclib.ServerConnection.wallops	(		self,
			text
	)

Send a WALLOPS command.

who()

def webkitpy.thirdparty.irc.irclib.ServerConnection.who	(		self,
			target = "",
			op = ""
	)

Send a WHO command.

whois()

def webkitpy.thirdparty.irc.irclib.ServerConnection.whois	(		self,
			targets
	)

Send a WHOIS command.

whowas()

def webkitpy.thirdparty.irc.irclib.ServerConnection.whowas	(		self,
			nick,
			max = "",
			server = ""
	)

Send a WHOWAS command.

Member Data Documentation

connected

webkitpy.thirdparty.irc.irclib.ServerConnection.connected

handlers

webkitpy.thirdparty.irc.irclib.ServerConnection.handlers

ircname

webkitpy.thirdparty.irc.irclib.ServerConnection.ircname

localaddress

webkitpy.thirdparty.irc.irclib.ServerConnection.localaddress

localhost

webkitpy.thirdparty.irc.irclib.ServerConnection.localhost

localport

webkitpy.thirdparty.irc.irclib.ServerConnection.localport

nickname

webkitpy.thirdparty.irc.irclib.ServerConnection.nickname

password

webkitpy.thirdparty.irc.irclib.ServerConnection.password

port

webkitpy.thirdparty.irc.irclib.ServerConnection.port

previous_buffer

webkitpy.thirdparty.irc.irclib.ServerConnection.previous_buffer

real_nickname

webkitpy.thirdparty.irc.irclib.ServerConnection.real_nickname

real_server_name

webkitpy.thirdparty.irc.irclib.ServerConnection.real_server_name

server

webkitpy.thirdparty.irc.irclib.ServerConnection.server

socket

webkitpy.thirdparty.irc.irclib.ServerConnection.socket

ssl

webkitpy.thirdparty.irc.irclib.ServerConnection.ssl

username

webkitpy.thirdparty.irc.irclib.ServerConnection.username

---

The documentation for this class was generated from the following file:

• Tools/Scripts/webkitpy/thirdparty/irc/irclib.py