public interface IRCEventListener extends java.util.EventListener, IRCConstants
The IRCEventListener
is used by the
IRCConnection.addEventListener(IRCEventListener)
method to add
a listener which listens to the connection for incoming IRC events like
PRIVMSG
s or numeric replies.
Supported events:
For other, unkown events there's the unknown
-method.
IRCEventAdapter
,
IRCConnection
ACTION_INDICATOR, BOLD_INDICATOR, COLOR_END_INDICATOR, COLOR_INDICATOR, COLOR_REVERSE_INDICATOR, ERR_ALREADYREGISTRED, ERR_BADCHANMASK, ERR_BADCHANNELKEY, ERR_BANNEDFROMCHAN, ERR_CANNOTSENDTOCHAN, ERR_CANTKILLSERVER, ERR_CHANNELISFULL, ERR_CHANOPRIVSNEEDED, ERR_ERRONEUSNICKNAME, ERR_FILEERROR, ERR_INVITEONLYCHAN, ERR_KEYSET, ERR_NEEDMOREPARAMS, ERR_NICKCOLLISION, ERR_NICKNAMEINUSE, ERR_NOADMININFO, ERR_NOLOGIN, ERR_NOMOTD, ERR_NONICKNAMEGIVEN, ERR_NOOPERHOST, ERR_NOORIGIN, ERR_NOPERMFORHOST, ERR_NOPRIVILEGES, ERR_NORECIPIENT, ERR_NOSERVICEHOST, ERR_NOSUCHCHANNEL, ERR_NOSUCHNICK, ERR_NOSUCHSERVER, ERR_NOTEXTTOSEND, ERR_NOTONCHANNEL, ERR_NOTOPLEVEL, ERR_NOTREGISTERED, ERR_PASSWDMISMATCH, ERR_SUMMONDISABLED, ERR_TOOMANYCHANNELS, ERR_TOOMANYTARGETS, ERR_UMODEUNKNOWNFLAG, ERR_UNKNOWNCOMMAND, ERR_UNKNOWNMODE, ERR_USERNOTINCHANNEL, ERR_USERONCHANNEL, ERR_USERSDISABLED, ERR_USERSDONTMATCH, ERR_WASNOSUCHNICK, ERR_WILDTOPLEVEL, ERR_YOUREBANNEDCREEP, ERR_YOUWILLBEBANNED, RPL_ADMINEMAIL, RPL_ADMINLOC1, RPL_ADMINLOC2, RPL_ADMINME, RPL_AUTHNAME, RPL_AWAY, RPL_BANLIST, RPL_CHANNELMODEIS, RPL_CLOSEEND, RPL_CLOSING, RPL_CREATED, RPL_ENDOFBANLIST, RPL_ENDOFINFO, RPL_ENDOFLINKS, RPL_ENDOFMOTD, RPL_ENDOFNAMES, RPL_ENDOFSERVICES, RPL_ENDOFSTATS, RPL_ENDOFUSERS, RPL_ENDOFWHO, RPL_ENDOFWHOIS, RPL_ENDOFWHOWAS, RPL_INFO, RPL_INFOSTART, RPL_INVITING, RPL_ISON, RPL_ISUPPORT, RPL_KILLDONE, RPL_LINKS, RPL_LIST, RPL_LISTEND, RPL_LISTSTART, RPL_LUSERCHANNELS, RPL_LUSERCLIENT, RPL_LUSERME, RPL_LUSEROP, RPL_LUSERUNKNOWN, RPL_MOTD, RPL_MOTDSTART, RPL_MYINFO, RPL_MYPORTIS, RPL_NAMREPLY, RPL_NONE, RPL_NOTOPIC, RPL_NOUSERS, RPL_NOWAWAY, RPL_REHASHING, RPL_SERVICE, RPL_SERVICEINFO, RPL_SERVLIST, RPL_SERVLISTEND, RPL_STATSCLINE, RPL_STATSCOMMANDS, RPL_STATSHLINE, RPL_STATSILINE, RPL_STATSKLINE, RPL_STATSLINKINFO, RPL_STATSLLINE, RPL_STATSNLINE, RPL_STATSOLINE, RPL_STATSQLINE, RPL_STATSUPTIME, RPL_STATSYLINE, RPL_SUMMONING, RPL_TIME, RPL_TOPIC, RPL_TOPICINFO, RPL_TRACECLASS, RPL_TRACECONNECTING, RPL_TRACEHANDSHAKE, RPL_TRACELINK, RPL_TRACELOG, RPL_TRACENEWTYPE, RPL_TRACEOPERATOR, RPL_TRACESERVER, RPL_TRACEUNKNOWN, RPL_TRACEUSER, RPL_UMODEIS, RPL_UNAWAY, RPL_USERHOST, RPL_USERS, RPL_USERSSTART, RPL_VERSION, RPL_WELCOME, RPL_WHOISCHANNELS, RPL_WHOISCHANOP, RPL_WHOISIDLE, RPL_WHOISOPERATOR, RPL_WHOISSERVER, RPL_WHOISUSER, RPL_WHOREPLY, RPL_WHOWASUSER, RPL_YOUREOPER, RPL_YOURHOST, UNDERLINE_INDICATOR
Modifier and Type | Method and Description |
---|---|
void |
onDisconnected()
Fired when the own connection is broken.
|
void |
onError(int num,
java.lang.String msg)
Fired when a numeric error is received.
|
void |
onError(java.lang.String msg)
Fired when an
ERROR command is received. |
void |
onInvite(java.lang.String chan,
IRCUser user,
java.lang.String passiveNick)
Fired when somebody is invited to a channel.
|
void |
onJoin(java.lang.String chan,
IRCUser user)
Fired when somebody joins a channel.
|
void |
onKick(java.lang.String chan,
IRCUser user,
java.lang.String passiveNick,
java.lang.String msg)
Fired when somebody is kicked from a channel.
|
void |
onMode(IRCUser user,
java.lang.String passiveNick,
java.lang.String mode)
Fired when somebody changes somebody's usermodes.
|
void |
onMode(java.lang.String chan,
IRCUser user,
IRCModeParser modeParser)
Fired when an operator changes the modes of a channel.
|
void |
onNick(IRCUser user,
java.lang.String newNick)
Fired when somebody changes his nickname successfully.
|
void |
onNotice(java.lang.String target,
IRCUser user,
java.lang.String msg)
Fired when somebody sends a
NOTICE to a user or a group. |
void |
onPart(java.lang.String chan,
IRCUser user,
java.lang.String msg)
Fired when somebody parts from a channel.
|
void |
onPing(java.lang.String ping)
Fired when a
PING comes in. |
void |
onPrivmsg(java.lang.String target,
IRCUser user,
java.lang.String msg)
Fired when a user sends a
PRIVMSG to a user or to a
group. |
void |
onQuit(IRCUser user,
java.lang.String msg)
Fired when somebody quits from the network.
|
void |
onRegistered()
Fired when the own connection is successfully established.
|
void |
onReply(int num,
java.lang.String value,
java.lang.String msg)
Fired when a numeric reply is received.
|
void |
onTopic(java.lang.String chan,
IRCUser user,
java.lang.String topic)
Fired when the topic is changed by operators.
|
void |
unknown(java.lang.String prefix,
java.lang.String command,
java.lang.String middle,
java.lang.String trailing)
This event is fired when the incoming line can not be identified as a known
event.
|
void onRegistered()
NOTICE
s. And if your nickname is invalid or in use or
anything else is wrong with your nickname, it asks you for a new one.void onDisconnected()
void onError(java.lang.String msg)
ERROR
command is received.msg
- The message of the error.void onError(int num, java.lang.String msg)
msg
's format is different for every reply. All replies'
formats are described in the IRCUtil
.num
- The identifier (usually a 3-digit number).msg
- The message of the error.void onInvite(java.lang.String chan, IRCUser user, java.lang.String passiveNick)
chan
- The channel the user is invited to.user
- The user who invites another. Contains nick, username and host.passiveNick
- The nickname of the user who is invited by another user
(passive).void onJoin(java.lang.String chan, IRCUser user)
chan
- The channel the person joins.user
- The user who joins. Contains nick, username and host.void onKick(java.lang.String chan, IRCUser user, java.lang.String passiveNick, java.lang.String msg)
chan
- The channel somebody is kicked from.user
- The user who kicks another user from a channel.
Contains nick, username and host.passiveNick
- The nickname of the user who is kicked from a channel
(passive).msg
- The message the active user has set. This is ""
if
no message was set.void onMode(java.lang.String chan, IRCUser user, IRCModeParser modeParser)
chan
- The channel in which the modes are changed.user
- The user who changes the modes.
Contains nick, username and host.modeParser
- The IRCModeParser
object which contains the
parsed information about the modes which are changed.void onMode(IRCUser user, java.lang.String passiveNick, java.lang.String mode)
user
- The user who changes the modes of another user or himself.
Contains nick, username and host.passiveNick
- The nickname of the person whose modes are changed by
another user or himself.mode
- The changed modes which are set.void onNick(IRCUser user, java.lang.String newNick)
user
- The user who changes his nickname.
Contains nick, username and host.newNick
- The new nickname of the user who changes his nickname.void onNotice(java.lang.String target, IRCUser user, java.lang.String msg)
NOTICE
to a user or a group.target
- The channel or nickname the user sent a NOTICE
to.user
- The user who notices another person or a group.
Contains nick, username and host.msg
- The message.void onPart(java.lang.String chan, IRCUser user, java.lang.String msg)
chan
- The channel somebody parts from.user
- The user who parts from a channel.
Contains nick, username and host.msg
- The part-message which is optionally.
If it's empty, msg is ""
.void onPing(java.lang.String ping)
PING
comes in.
The IRC server tests in different periods if the client is still there by
sending PING <ping>. The client must response PONG <ping>.ping
- The ping which is received from the server.void onPrivmsg(java.lang.String target, IRCUser user, java.lang.String msg)
PRIVMSG
to a user or to a
group.target
- The channel or nickname the user sent a PRIVMSG
to.user
- The user who sent the PRIVMSG
.
Contains nick, username and host.msg
- The message the user transmits.void onQuit(IRCUser user, java.lang.String msg)
user
- The user who quits. Contains nick, username and host.msg
- The optional message. ""
if no message is set by
the user.void onReply(int num, java.lang.String value, java.lang.String msg)
WHOIS
queries are answered by the server with
numeric replies.
The msg
's format is different for every reply. All replies'
formats are described in the IRCUtil
.
The first word in the value
is always your own nickname!num
- The numeric reply.value
- The first part of the message.msg
- The main part of the message.void onTopic(java.lang.String chan, IRCUser user, java.lang.String topic)
onReply
when you join a channel.chan
- The channel where the topic is changed.user
- The user who changes the topic.
Contains nick, username and host.topic
- The new topic.void unknown(java.lang.String prefix, java.lang.String command, java.lang.String middle, java.lang.String trailing)
prefix
- The prefix of the incoming line.command
- The command of the incoming line.middle
- The part until the colon (:
).trailing
- The part behind the colon (:
).