C# Class NetIRC.Client

Datei anzeigen Open project: kevin-brown/NetIRC Class Usage Examples

Private Properties

Property	Type	Description
ReadStream	void
RegisterMessages	void
RegisterWriters	void
TriggerOnAction	void
TriggerOnChannelJoin	void
TriggerOnChannelLeave	void
TriggerOnConnect	void
TriggerOnDisconnect	void
TriggerOnNotice	void
TriggerOnUserMode	void
TriggerOnVersion	void
TriggerOnVersionReply	void
TriggerOnWelcome	void
TriggerOnWho	void

Public Methods

Method	Description
Away ( string message ) : Away
Client ( ) : System
Connect ( string server, int port, bool ssl, User user ) : void	Connect to a specified server.
Disconnect ( ) : void	Disconnects the connected user forcefully.
JoinChannel ( Channel channel ) : void	Join a specified channel based on the given Channel object.
JoinChannel ( string name ) : void	Join a channel specified by the name.
LeaveChannel ( Channel channel ) : void	Leave a specified channel based on the given Channel object.
LeaveChannel ( string name ) : void	Leave a channel specified by the name.
NotAway ( ) : NotAway
Quit ( ) : Quit
Quit ( string reason ) : Quit
RegisterMessage ( Type type ) : void	Registers a message that will be checked when new messages are received.
RegisterWriter ( Type type ) : void
Send ( Messages message ) : void	Send a message to the connected server.
TriggerOnMessage ( User source, string message ) : void
UnregisterMessage ( Type type ) : void
UnregisterWriter ( Type type ) : void

Protected Methods

Method	Description
TriggerOnSend ( SendMessageEventArgs e ) : void

Private Methods

Method	Description
ReadStream ( ) : void
RegisterMessages ( ) : void
RegisterWriters ( ) : void
TriggerOnAction ( User user, string action ) : void
TriggerOnChannelJoin ( Channel channel ) : void
TriggerOnChannelLeave ( Channel channel ) : void
TriggerOnConnect ( ) : void
TriggerOnDisconnect ( ) : void
TriggerOnNotice ( User user, string notice ) : void
TriggerOnUserMode ( string modes ) : void
TriggerOnVersion ( User source ) : void
TriggerOnVersionReply ( User source, string version ) : void
TriggerOnWelcome ( string message ) : void
TriggerOnWho ( User user, string message ) : void

Method Details

Away() public method

public Away ( string message ) : Away
message	string
return	NetIRC.Messages.Send.Away

Client() public method

public Client ( ) : System
return	System

Connect() public method

Connect to a specified server.

public Connect ( string server, int port, bool ssl, User user ) : void
server	string	The host of the server to connect to.
port	int	The port to connect to on the server.
ssl	bool	True for SSL, false if not.
user	User	The NetIRC.User to use for connecting to the server.
return	void

Disconnect() public method

Disconnects the connected user forcefully.

public Disconnect ( ) : void
return	void

JoinChannel() public method

Join a specified channel based on the given Channel object.

public JoinChannel ( Channel channel ) : void
channel	Channel	The Channel to be used for connecting.
return	void

JoinChannel() public method

Join a channel specified by the name.

public JoinChannel ( string name ) : void
name	string	The name of the channel.
return	void

LeaveChannel() public method

Leave a specified channel based on the given Channel object.

public LeaveChannel ( Channel channel ) : void
channel	Channel
return	void

LeaveChannel() public method

Leave a channel specified by the name.

public LeaveChannel ( string name ) : void
name	string	The name of the channel.
return	void

NotAway() public method

public NotAway ( ) : NotAway
return	NetIRC.Messages.Send.NotAway

Quit() public method

public Quit ( ) : Quit
return	NetIRC.Messages.Send.Quit

Quit() public method

public Quit ( string reason ) : Quit
reason	string
return	NetIRC.Messages.Send.Quit

RegisterMessage() public method

Registers a message that will be checked when new messages are received.

public RegisterMessage ( Type type ) : void
type	System.Type	The type of the Message object that messages will be checked against.
return	void

RegisterWriter() public method

public RegisterWriter ( Type type ) : void
type	System.Type
return	void

Send() public method

Send a message to the connected server.

public Send ( Messages message ) : void
message	Messages	The NetIRC.SendMessage instance to be sent.
return	void

TriggerOnMessage() public method

public TriggerOnMessage ( User source, string message ) : void
source	User
message	string
return	void

TriggerOnSend() protected method

protected TriggerOnSend ( SendMessageEventArgs e ) : void
e	SendMessageEventArgs
return	void

UnregisterMessage() public method

public UnregisterMessage ( Type type ) : void
type	System.Type
return	void

UnregisterWriter() public method

public UnregisterWriter ( Type type ) : void
type	System.Type
return	void