[This is preliminary documentation and is subject to change.]
The IrcSharp namespace holds all classes nessecary to communicate with an irc server. It has 2 different layers: the simple layer and the extended layer. The simple layer allows access to basic irc functions and doesn't realy care of the channels, the client is currently in, and what users are in these channels. It can be used to do easy tasks, where this informations aren't needed. All classes for this layer are in the root IrcSharp namespace. To get a managed "extended" connection the extended layer can be used. All classes of the extended layer are in the [IrcSharp.Extended] namespace. There is a thierd namespace called [IrcSharp.Listener]. It contains classes, that help you to collect informations, that come from the irc server in multible lines.
Classes
| Class | Description | |
|---|---|---|
 | BadNickEventArgs |
The EventArgs for the BadNick event.
|
| ConnectEventArgs |
The ConnectEventArgs belongs to the IrcClient..::.ConnectEventHandler and the OnConnect event.
|
| ErrorEventArgs |
The ErrorEventArgs belongs to the IrcClient..::.ErrorEventHandler and the Error event.
|
| FlagDefinition |
Represents a definition for a flag what can be set to a user or channel.
|
| InvalidLineFormatException |
This exception is thrown by an IrcLine if the raw format was not correct.
|
| IrcClient |
Manages a simple irc connection on a low raw level.
|
| IrcEventArgs |
This cöass represents the EventArgs for irc protocol event.
|
| IrcLine |
Represents a raw irc line received over an irc connection.
|
| IrcNetwork |
Represents a network definition for the irc protocol.
|
| IrcProtocol |
Describes the internet relay chat protocol and its parameters.
|
| IrcServerEndPoint |
Represents an irc endpoint for an irc connection.
|
| IrcStandardDefinition |
This class saves the standard, used by a server, the associated IrcClient is connected to.
|
| JoinReceivedEventArgs |
The JoinReceivedEventArgs belongs to the IrcClient..::.JoinReceivedEventHandler and the JoinReceived event.
|
| KickReceivedEventArgs |
Description of KickReceivedEventArgs.
|
| LineReceivedEventArgs |
The LineReceivedEventArgs belongs to the IrcClient..::.LineReceivedEventHandler and the LineReceived event.
|
| LoginEventArgs |
The LoginEventArgs belongs to the IrcClient..::.LoginEventHandler and the OnLogin event.
|
| MessageReceivedEventArgs |
The MessageReceivedEventArgs belongs to the IrcClient..::.MessageReceivedEventHandler and the MessageReceived event.
|
| Mode |
The Mode class represents one mode set in an irc mode line.
|
| ModeReceivedEventArgs |
The ModeReceivedEventArgs belongs to the IrcClient..::.ModeReceivedEventHandler and the ModeReceived event.
|
| NickChangeReceivedEventArgs |
The NickChangeReceivedEventArgs belongs to the
IrcClient..::.NickChangeReceivedEventHandler and the
NickChangeReceived event.
|
| NoticeReceivedEventArgs |
The NoticeReceivedEventArgs belongs to the
IrcClient..::.NoticeReceivedEventHandler and the
NoticeReceived event.
|
| NumericReceivedEventArgs |
The NumericReceivedEventArgs belongs to the
IrcClient..::.NumericReceivedEventHandler and the
NumericReceived event.
|
| PartReceivedEventArgs |
The PartReceivedEventArgs belongs to the
IrcClient..::.PartReceivedEventHandler and the
PartReceived event.
|
| PingReceivedEventArgs |
The PingReceivedEventArgs belongs to the
IrcClient..::.PingReceivedEventHandler and the
PingReceived event.
|
| QuitReceivedEventArgs |
The QuitReceivedEventArgs belongs to the
IrcClient..::.QuitReceivedEventHandler and the
QuitReceived event.
|
| UserInfo |
Holds host informations about a user.
|
Interfaces
| Interface | Description | |
|---|---|---|
 | IIrcObject |
All objects belonging to an IrcClient must implement this interface.
|
Delegates
| Delegate | Description | |
|---|---|---|
 | IrcClient..::.ConnectEventHandler |
The handler for the IrcClient.OnConnect event.
|
| IrcClient..::.ErrorEventHandler |
The handler for the IrcClient.Error event.
|
| IrcClient..::.JoinReceivedEventHandler |
The handler for the IrcClient.JoinReceived event.
|
| IrcClient..::.KickReceivedEventHandler |
The handler for the IrcClient.KickReceived event.
|
| IrcClient..::.LineReceivedEventHandler |
The handler for the IrcClient.LineReceived event.
|
| IrcClient..::.LoginEventHandler |
The handler for the IrcClient.OnLogin event.
|
| IrcClient..::.MessageReceivedEventHandler |
The handler for the IrcClient.MessageReceived event.
|
| IrcClient..::.ModeReceivedEventHandler |
The handler for the IrcClient.ModeReceived event.
|
| IrcClient..::.NickChangeReceivedEventHandler |
The handler for the IrcClient.NickChangeReceived event.
|
| IrcClient..::.NoticeReceivedEventHandler |
The handler for the IrcClient.NoticeReceived event.
|
| IrcClient..::.NumericReceivedEventHandler |
The handler for the IrcClient.NumericReceived event.
|
| IrcClient..::.PartReceivedEventHandler |
The handler for the IrcClient.PartReceived event.
|
| IrcClient..::.PingReceivedEventHandler |
The handler for the IrcClient.PingReceived event.
|
| IrcClient..::.QuitReceivedEventHandler |
The handler for the IrcClient.QuitReceived event.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
 | BadNickReasons |
Represents the reasons why the nickname wasn't accepted by the server.
|
| CtcpCommands |
A listing of all well known ctcp commands.
|
| FlagArt |
Describes if the flag was set or unset.
|
| FlagParameter |
Describes if a flag has a parameter or not.
|
| ModeArt |
The ModeArt describes if a mode can be set to a channel or to a user.
|
