C# Class Nexus.Client.MessagerServer

This class enables communication between different instance of the mod manager.

Only one instance of the client can be running per game mode. This class listens for messages sent from other instances of the mod manager to be processed.

Inheritance: System.MarshalByRefObject, IMessager

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
AddMod ( string p_strFilePath ) : void	Adds the specified mod to the mod manager.
BringToFront ( ) : void	Brings the currently running client to the front.
Dispose ( ) : void	Disposes of the object. This shuts down any open IPC channels.
InitializeLifetimeService ( ) : object	Creates the liftime object that determines how long the object lives.
InitializeListener ( EnvironmentInfo p_eifEnvironmentInfo, IGameModeDescriptor p_gmdGameModeInfo, ModManager p_mmgModManager, MainForm p_frmMainForm ) : IMessager	Starts up the IPC listner channel to wait for message from other instances.
Post ( ) : void	Used as a simple Power On Self Test method. This method can be called to ensure a Messager is alive.

Protected Methods

Method	Description
ConfirmFileOverwrite ( string p_strOldFilePath, string &p_strNewFilePath ) : bool	The callback that confirm a file overwrite.

Private Methods

Method	Description
ConfirmModFileOverwrite ( string p_strFileName, string p_strNewFileName ) : string	This asks the use to confirm the overwriting of the specified mod file.
DoBringToFront ( ) : void	Brings the currently running client to the front.
MessagerServer ( ModManager p_mmgModManager, MainForm p_frmMainForm ) : System	A simple constructor the initializes the object with the required dependencies.

Method Details

AddMod() public method

Adds the specified mod to the mod manager.

public AddMod ( string p_strFilePath ) : void
p_strFilePath	string	The path or URL of the mod to add to the mod manager.
return	void

BringToFront() public method

Brings the currently running client to the front.

public BringToFront ( ) : void
return	void

ConfirmFileOverwrite() protected method

The callback that confirm a file overwrite.

protected ConfirmFileOverwrite ( string p_strOldFilePath, string &p_strNewFilePath ) : bool
p_strOldFilePath	string	The path to the file that is to be overwritten.
p_strNewFilePath	string	An out parameter specifying the file to to which to /// write the file.
return	bool

Dispose() public method

Disposes of the object.

This shuts down any open IPC channels.

public Dispose ( ) : void
return	void

InitializeLifetimeService() public method

Creates the liftime object that determines how long the object lives.

public InitializeLifetimeService ( ) : object
return	object

InitializeListener() public static method

Starts up the IPC listner channel to wait for message from other instances.

public static InitializeListener ( EnvironmentInfo p_eifEnvironmentInfo, IGameModeDescriptor p_gmdGameModeInfo, ModManager p_mmgModManager, MainForm p_frmMainForm ) : IMessager
p_eifEnvironmentInfo	EnvironmentInfo	The application's envrionment info.
p_gmdGameModeInfo	IGameModeDescriptor	The descriptor of the game mode for which mods are being managed.
p_mmgModManager	Nexus.Client.ModManagement.ModManager	The mod manager to use to manage mods.
p_frmMainForm	MainForm	The main application form.
return	IMessager

Post() public method

Used as a simple Power On Self Test method.

This method can be called to ensure a Messager is alive.

public Post ( ) : void
return	void