WormbotReporter.WIR_IRCConnection

Extends

WIR_IRCBase

Modifiers

config

Copyright (c) 2005-2007 by Wormbo $Id$

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.InternetInfo
         |   
         +-- IpDrv.InternetLink
            |   
            +-- IpDrv.TcpLink
               |   
               +-- WormbotReporter.WIR_IRCBase
                  |   
                  +-- WormbotReporter.WIR_IRCConnection

Delegates Summary
		OnChat (string Nick, string Message)
		OnMode (EModeType Type, string Nick, optional string Message)
		OnTimeout ()))

Functions Summary
		BeginState ())) ConnectionEstablished
		BeginState ())) InChannel
	string	Chomp (string S))
		ClearTimeout ()))
		Closed ())) ConnectionEstablished
		Connect ()
		Connect ())) NotConnected
		DebugLog (string S))
		Disconnect (bool bReconnect, string QuitMessage)
		Disconnect (bool bReconnect, string QuitMessage)) ConnectionEstablished
		Disconnect (bool bReconnect, string QuitMessage)) InChannel
		Disconnect (bool bReconnect, string QuitMessage)) NotConnected
	bool	GetNetworkParameter (string Key, out string Value))
		HandleCommand (string Command, string Parameters))
		HandleNumericReply (int Command, string Server, string Target, string Parameters))
		HandleNumericReply (int Command, string Server, string Target, string Parameters)) ConnectionEstablished
		HandleStringReply (string Command, string Server, string Target, string Parameters))
		HandleStringReply (string Command, string Server, string Target, string Parameters)) InChannel
		HandleStringReply (string Command, string Server, string Target, string Parameters)) RegisterationComplete
	bool	ImportantMessagesQueued ()))
	bool	IsFlooding (int LenNextCommand))
	bool	IsTargetChannel (string Target))
		JoinChannel (string Channel, string Key))
		JoinChannel (string Channel, string Key)) InChannel
		JoinChannel (string Channel, string Key)) RegisterationComplete
		Opened ())) NotConnected
		PartChannel ()))
		PartChannel ())) InChannel
		PostBeginPlay ()))
		ReceivedLine (string Line))
		Registered ()
		Registered ())) LoggedIn
		Registered ())) RegisterationComplete
		Resolved (IpAddr Address)) NotConnected
		ResolveFailed ())) NotConnected
		SendCommand (string Command, bool bIsCommand, optional bool bImportant))
		SendMessage (string Message, optional bool bImportant))
	int	SendText (string Line))
		SetConnection (string Server, int Port, string Password, string Nick, string Ident))
		SetNick (string NewNick))
		SetNick (string NewNick)) ConnectionEstablished
		SetRegistrationDetails (class<WIR_RegistrationHandler> HandlerClass, string RegistrationDetails))
		SetTimeout (float TimeoutSeconds))
		Tick (float DeltaTime))
		Tick (float DeltaTime)) ConnectionEstablished
		Tick (float DeltaTime)) InChannel
		UpdateTopic (optional bool bLeaving))

MILLISECONDS_PER_WEEK Source code

Number of milliseconds per week. Used to handle time intervals at Level.DayOfWeek wrap-around

bAutoReconnect Source code

bAutoRejoin Source code

bDebugStartMatch Source code

bNoChannelCodes Source code

bNoChannelColor Source code

bRegistered Source code

Whether this client already registered on the server.

ChannelJoinTime Source code

Timestamp when the channel was joined to delay the first message.

ChannelKey Source code

Password required to join the channel.

ChannelName Source code

Name of the channel to join after login and registration.

ChannelTopic Source code

Channel topic received from the server.

CommandQueue Source code

Holds the commands to be sent as soon as the flood protection allows.

ConnectTimeout Source code

DebugLogFileName Source code

FloodProtectBytes Source code

FloodProtectBytesDuration Source code

FloodProtectCommandPenalty Source code

FloodProtectMaxPenalty Source code

FloodProtectMessagePenalty Source code

LastTopicTemplate Source code

LogFile Source code

Log file handle

MaxLenMessageQueue Source code

MessageQueue Source code

Holds other messages to be sent when no commands are queued.

MsgBotFlooding Source code

MsgBotJoinChat Source code

MsgBotJoinChatTwoWay Source code

MsgBotJoinReport Source code

MsgBotJoinReportChat Source code

MsgBotJoinReportChatTwoWay Source code

MyMutator Source code

NetworkParameters Source code

Parameters used by this server.

RealServerName Source code

DNS name of IRC server as reported by the server itself.

ReconnectDelay Source code

RegistrationHandler Source code

Handles the registration on the IRC server.

SendLimitTime Source code

Simple flood protection. If this is more than 10s ahead of the current timestamp, nothing is sent this tick.

SentBytes Source code

Bytes sent in the last few seconds.

ServerAddress Source code

Resolved server address and port.

ServerName Source code

DNS name of IRC server.

ServerPassword Source code

Password required to connect to the server.

TimestampNow Source code

Current timestamp.

TimestampTimeout Source code

Tracks timeouts.

UserIdent Source code

User ident

UserNick Source code

User's current nick name

EModeType Source code

TKeyValuePair Source code

TMessage Source code

TSentBytes Source code

OnChat Source code

Called when someone in the channel talks.

OnMode Source code

Called when something in the channel changes.

OnTimeout Source code

Called on timeout. Used internally.

BeginState ConnectionEstablished Source code

Clear the queues and network info.

BeginState InChannel Source code

Clear the queues and network info.

Chomp Source code

Removes a leading ":" from a string.

ClearTimeout Source code

Clears a timeout delay.

Closed ConnectionEstablished Source code

The server connection has been closed.

Connect Source code

Try to establish a connection to the IRC server.

Connect NotConnected Source code

Already disconnected. Try to reconnect if desired.

DebugLog Source code

Log debug information.

Disconnect Source code

Disconnect from the currently used IRC server.

Disconnect ConnectionEstablished Source code

Disconnect from the server.

Disconnect InChannel Source code

Disconnect from the server.

Disconnect NotConnected Source code

Already disconnected. Try to reconnect if desired.

GetNetworkParameter Source code

Returns true if the specified parameter is set on this network and sets Value.

HandleCommand Source code

Handles a string command received from the server.

HandleNumericReply Source code

Handles a numeric message received from the server.

HandleNumericReply ConnectionEstablished Source code

Detects numeric 001 as confirmation for login.

HandleStringReply Source code

Handles a string message received from the server.

HandleStringReply InChannel Source code

Detects when the client joined the channel.

HandleStringReply RegisterationComplete Source code

Detects when the client joined the channel.

ImportantMessagesQueued Source code

Returns whether there are currently important messages in the queue.

IsFlooding Source code

Returns whether the client is flodding the server with messages.

IsTargetChannel Source code

Return, whether the channel is a target channel.

JoinChannel Source code

Join a channel.

JoinChannel InChannel Source code

Join a channel.

JoinChannel RegisterationComplete Source code

Join a channel.

Opened NotConnected Source code

The server connection has been opened successfully.

PartChannel Source code

Parts the channel.

PartChannel InChannel Source code

Parts the channel.

PostBeginPlay Source code

Initializes the IRC socket.

ReceivedLine Source code

Logs the received text.

Registered Source code

Called when registration was completed.

Registered LoggedIn Source code

Called when registeration was successful.

Registered RegisterationComplete Source code

Use the global non-state inplementation.

Resolved NotConnected Source code

Server address resolved. Try to connect.

ResolveFailed NotConnected Source code

Resolving server address failed.

SendCommand Source code

Queues a command for sending.

SendMessage Source code

Sends a message to the channel.

SendText Source code

Logs the sent text.

SetConnection Source code

Sets the registration handler class.

SetNick Source code

changes the client's nick name.

SetNick ConnectionEstablished Source code

Changes the client's nick name.

SetRegistrationDetails Source code

Sets the registration handler class.

SetTimeout Source code

Sets a timeout delay.

Tick Source code

Updates the current timestamp.

Tick ConnectionEstablished Source code

Send commands when flood protection allows it.

Tick InChannel Source code

Send commands and messages to the channel when flood protection allows it.

UpdateTopic Source code

Updates the channel topic.

defaultproperties
{
  bAlwaysTick = True
  
  MsgBotJoinChat              = "[^B]%m[^B] - relaying chat from [^B]%s[^B]"
  MsgBotJoinChatTwoWay        = "[^B]%m[^B] - relaying chat from and to [^B]%s[^B]"
  MsgBotJoinReport            = "[^B]%m[^B] - reporting from [^B]%s[^B]"
  MsgBotJoinReportChat        = "[^B]%m[^B] - reporting and relaying chat from [^B]%s[^B]"
  MsgBotJoinReportChatTwoWay  = "[^B]%m[^B] - reporting and relaying chat from and to [^B]%s[^B]"
  
  MsgBotFlooding = "[^B]I had to drop some messages to catch up.[^B]"
}