C# Class PleaseIgnore.IntelMap.IntelChannel

Inheritance: System.ComponentModel.Component

Show file Open project: EtherealWake/test-intel Class Usage Examples

Private Properties

Property	Type	Description
ObjectInvariant	void
OnPropertyChanged	void
timer_Callback	void
watcher_Changed	void
watcher_Created	void

Public Methods

Method	Description
IntelChannel ( ) : System	Initializes a new instance of the IntelChannel class.
IntelChannel ( IContainer container ) : System	Initializes a new instance of the IntelChannel class with the specified Container.
IntelChannel ( string name ) : System	Initializes a new instance of the IntelChannel class with the specified Name.
IntelChannel ( string name, IContainer container ) : System	Initializes a new instance of the IntelChannel class with the specified Name and Container.
Start ( ) : void	Initiate the acquisition of log entries from the EVE chat logs. This method enables IntelReported events.
Stop ( ) : void	Stops the IntelChannel from monitoring for new log entries.
ToString ( ) : string	Returns a System.String that represents this instance of IntelChannel.

Protected Methods

Method	Description
CloseFile ( ) : void	Closes the log file we are currently monitoring (if any).
CreateFileSystemWatcher ( ) : FileSystemWatcher	Creates the instance of FileSystemWatcher used to monitor the file system. CreateFileSystemWatcher will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the IntelChannel and optionally releases the managed resources.
OnFileChanged ( FileSystemEventArgs e ) : void	Called when a log file associated with the channel we are monitoring has been modified. OnFileChanged will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnFileCreated ( FileSystemEventArgs e ) : void	Called when a new log file is created for the channel we are monitoring. OnFileCreated will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnIntelReported ( IntelEventArgs e ) : void	Raises the IntelReported event. OnIntelReported will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnPropertyChanged ( PropertyChangedEventArgs e ) : void	Raises the PropertyChanged event. OnPropertyChanged(PropertyChangedEventArgs) will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnStart ( ) : void	Called after Start has been called. OnStart will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnStop ( ) : void	Called after Stop has been called. OnStop will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OnTick ( ) : void	Called every couple of seconds to sweep the log file for new entries. OnTick will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.
OpenFile ( FileInfo fileInfo ) : bool	Closes the existing log file and opens a new log file.
ScanFiles ( ) : bool	Rescans the active directory looking for valid log files

Private Methods

Method	Description
ObjectInvariant ( ) : void
OnPropertyChanged ( string propertyName ) : void	Raises the PropertyChanged event.
timer_Callback ( object state ) : void	Callback for logTimer.
watcher_Changed ( object sender, FileSystemEventArgs e ) : void	Handler for FileSystemWatcher.Created event.
watcher_Created ( object sender, FileSystemEventArgs e ) : void	Handler for FileSystemWatcher.Created event.

Method Details

CloseFile() protected method

Closes the log file we are currently monitoring (if any).

protected CloseFile ( ) : void
return	void

CreateFileSystemWatcher() protected method

Creates the instance of FileSystemWatcher used to monitor the file system.

CreateFileSystemWatcher will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected CreateFileSystemWatcher ( ) : FileSystemWatcher
return	System.IO.FileSystemWatcher

Dispose() protected method

Releases the unmanaged resources used by the IntelChannel and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	/// to release both managed and unmanaged /// resources; to release only unmanaged /// resources. ///
return	void

IntelChannel() public method

Initializes a new instance of the IntelChannel class.

public IntelChannel ( ) : System
return	System

IntelChannel() public method

Initializes a new instance of the IntelChannel class with the specified Container.

public IntelChannel ( IContainer container ) : System
container	IContainer	Optional parent .
return	System

IntelChannel() public method

Initializes a new instance of the IntelChannel class with the specified Name.

public IntelChannel ( string name ) : System
name	string	The initial value for .
return	System

IntelChannel() public method

Initializes a new instance of the IntelChannel class with the specified Name and Container.

public IntelChannel ( string name, IContainer container ) : System
name	string	The initial value for .
container	IContainer	Optional parent .
return	System

OnFileChanged() protected method

Called when a log file associated with the channel we are monitoring has been modified.

OnFileChanged will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnFileChanged ( FileSystemEventArgs e ) : void
e	System.IO.FileSystemEventArgs	Instance of /// describing the modified file. ///
return	void

OnFileCreated() protected method

Called when a new log file is created for the channel we are monitoring.

OnFileCreated will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnFileCreated ( FileSystemEventArgs e ) : void
e	System.IO.FileSystemEventArgs	/// Instance of describing the /// new file. ///
return	void

OnIntelReported() protected method

Raises the IntelReported event.

OnIntelReported will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnIntelReported ( IntelEventArgs e ) : void
e	IntelEventArgs	Arguments for the event being raised.
return	void

OnPropertyChanged() protected method

Raises the PropertyChanged event.

OnPropertyChanged(PropertyChangedEventArgs) will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnPropertyChanged ( PropertyChangedEventArgs e ) : void
e	System.ComponentModel.PropertyChangedEventArgs	Arguments for the event being raised.
return	void

OnStart() protected method

Called after Start has been called.

OnStart will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnStart ( ) : void
return	void

OnStop() protected method

Called after Stop has been called.

OnStop will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnStop ( ) : void
return	void

OnTick() protected method

Called every couple of seconds to sweep the log file for new entries.

OnTick will be called from within a synchronized context so derived classes should not attempt to perform any additional synchronization themselves.

protected OnTick ( ) : void
return	void

OpenFile() protected method

Closes the existing log file and opens a new log file.

protected OpenFile ( FileInfo fileInfo ) : bool
fileInfo	System.IO.FileInfo	The new log file to track.
return	bool

ScanFiles() protected method

Rescans the active directory looking for valid log files

protected ScanFiles ( ) : bool
return	bool

Start() public method

Initiate the acquisition of log entries from the EVE chat logs. This method enables IntelReported events.

public Start ( ) : void
return	void

Stop() public method

Stops the IntelChannel from monitoring for new log entries.

public Stop ( ) : void
return	void

ToString() public method

Returns a System.String that represents this instance of IntelChannel.

public ToString ( ) : string
return	string