C# Class CommonServices.BasicCommandHandler

Provides a basic implementation for a CommandHandler. It manages the event registering in Start & Stop and the link to the Command Manager.

Inheritance: IPlugin

Mostrar archivo Open project: Invenietis/ck-certified

Private Properties

Property	Type	Description
StartListenCommandManager	void
StopListenCommandManager	void

Public Methods

Method	Description
Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
Start ( ) : void
Stop ( ) : void
Teardown ( ) : void

Protected Methods

Method	Description
OnCommandSending ( object sender, CommandSendingEventArgs e ) : void	Method reacting from Command Sending event. Here, you can parse the command you want to listen before the command is really launches and do some stuff about it.
OnCommandSent ( object sender, CommandSentEventArgs e ) : void	Method reacting from the Command Sent event. Here, you can parse the command you want to listen and do some stuff about it.

Private Methods

Method	Description
StartListenCommandManager ( ) : void	When the Optional CommandManager is set we listen its CommandSent event.
StopListenCommandManager ( ) : void	When the Optional CommandManager is unset we stop to listen its CommandSent event.

Method Details

OnCommandSending() protected method

Method reacting from Command Sending event. Here, you can parse the command you want to listen before the command is really launches and do some stuff about it.

protected OnCommandSending ( object sender, CommandSendingEventArgs e ) : void
sender	object
e	CommandSendingEventArgs	containing data about the command which /// is about to be send.
return	void

OnCommandSent() protected method

Method reacting from the Command Sent event. Here, you can parse the command you want to listen and do some stuff about it.

protected OnCommandSent ( object sender, CommandSentEventArgs e ) : void
sender	object
e	CommandSentEventArgs	containing data about the sent command.
return	void

Setup() public method

public Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
info	CK.Plugin.IPluginSetupInfo
return	bool

Start() public method

public Start ( ) : void
return	void

Stop() public method

public Stop ( ) : void
return	void

Teardown() public method

public Teardown ( ) : void
return	void