IrcClient

An IRC client class.

class IrcClient {}

Constructors

this
this(IConnection c)
Undocumented in source.

Members

Functions

action
void action(string name, string text)

Perform an action for the target.

canonicalChannelName
string canonicalChannelName(string channel)

Get a channel's canonical name, using the observed name if known.

canonicalName
string canonicalName(string name)

Get a user or channel's canonical name, using the observed name if known.

canonicalUserName
string canonicalUserName(string user)

Get a user's canonical name, using the observed name if known.

disconnect
void disconnect(string reason, DisconnectType type)

Cancel a connection.

getUserChannels
string[] getUserChannels(string name)

Get the list of channels that we can see a user in.

join
void join(string channel, string password)

Join a channel on the network.

message
void message(string name, string text)

Send a regular message to the target.

mode
void mode(string[] params)

Get/set IRC mode

notice
void notice(string name, string text)

Send a notice to the target.

onEnter
void onEnter(string nick, string username, string hostname, string realname)
Undocumented in source. Be warned that the author may not have intended to support it.
onLeave
void onLeave(string nick)
Undocumented in source. Be warned that the author may not have intended to support it.
onMessage
void onMessage(string from, string to, string message, IrcMessageType type)
Undocumented in source. Be warned that the author may not have intended to support it.
onNick
void onNick(string oldNick, string newNick)
Undocumented in source. Be warned that the author may not have intended to support it.
requestChannelList
void requestChannelList()

Get a list of channels on the server

sendRaw
void sendRaw(char[] message)

Send raw string to server.

who
void who(string mask)

Get a list of logged on users

Properties

connected
bool connected [@property getter]

Returns true if the connection was successfully established, and we have authorized ourselves to the server (and can thus join channels, send private messages, etc.)

nickname
string nickname [@property getter]

Refers to currentNickname when connected, connectNickname otherwise.

Structs

Channel
struct Channel

An IRC channel.

User
struct User

A user that we know of.

Variables

autoWho
bool autoWho;

Whether to automatically send WHO requests

canonicalChannelNames
string[string] canonicalChannelNames;
canonicalUserNames
string[string] canonicalUserNames;

Canonical names

channelList
string[] channelList;

Channel list for LIST command

channels
Channel[string] channels;

A list of joined channels.

connectNickname
string connectNickname;

The nickname to identify with.

currentNickname
string currentNickname;

The nickname we are logged in with. May be different from connectNickname if exactNickname is false.

decoder
string function(in char[]) decoder;
encoder
string function(in char[]) encoder;

How to convert the IRC 8-bit data to and from UTF-8 (D strings must be valid UTF-8).

exactNickname
bool exactNickname;

Fail to connect if the specified nickname is taken.

handleBanned
void delegate(string channel, string reason) handleBanned;

Callback for when we're banned from a channel.

handleChannelFull
void delegate(string channel, string reason) handleChannelFull;

Callback for when a channel is full.

handleChannelKey
void delegate(string channel, string reason) handleChannelKey;

Callback for when a channel needs a key.

handleChannelList
void delegate(string[] channelList) handleChannelList;

Callback for when the channel list was retreived

handleConnect
void delegate() handleConnect;

Callback for when we have succesfully logged in.

handleDisconnect
void delegate(string reason, DisconnectType type) handleDisconnect;

Callback for when the socket was closed.

handleEnter
void delegate(string nick) handleEnter;

Callback for when a user enters our sight.

handleInvite
void delegate(string nick, string channel) handleInvite;

Callback for an INVITE command.

handleInviteOnly
void delegate(string channel, string reason) handleInviteOnly;

Callback for when a channel is invite only.

handleJoin
void delegate(string channel, string nick) handleJoin;

Callback for when someone has joined a channel.

handleKick
void delegate(string channel, string nick, string op, string reason) handleKick;

Callback for when someone was kicked from a channel.

handleLeave
void delegate(string nick) handleLeave;

Callback for when a user leaves our sight.

handleMessage
void delegate(string from, string to, string message, IrcMessageType type) handleMessage;

Callback for when a message has been received.

handlePart
void delegate(string channel, string nick, string reason) handlePart;

Callback for when someone has left a channel.

handleQuit
void delegate(string nick, string reason, string[] channels) handleQuit;

Callback for when someone has quit from the network.

handleRaw
void delegate(ref string s) handleRaw;

Callback for received data before it's processed.

handleUnavailable
void delegate(string what, string reason) handleUnavailable;

Callback for when a nick/channel is unavailable.

handleWho
void delegate(string channel, string username, string host, string server, string name, string flags, int hopcount, string realname) handleWho;

Callback for a WHO result line

handleWhoEnd
void delegate(string mask) handleWhoEnd;

Callback for a WHO listing end

log
Logger log;

Log all input/output to this logger.

password
string password;

The password used when logging in.

realname
string realname;

The user's information.

username
string username;

Username field (shown before the @ in the hostmask). If not set, defaults to the nickname.

users
User[string] users;

Known user info

Meta