C# Class SIL.FieldWorks.Common.FwUtils.FLExBridgeHelper

Utility methods for FLExBridge interaction
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
AlertFlex ( ) : void

Acquire the lock on, and then pulse the wait object

DoesProjectHaveFlexRepo ( string projectFolderPath ) : bool

Answer whether the project appears to have a FLEx repo. This is currently determined by its having a .hg folder.

FullFieldWorksBridgePath ( ) : string

Returns the full path and filename of the FieldWorksBridge executable

IsFlexBridgeInstalled ( ) : bool

Determines if FLExBridge is installed.

Private Methods

Method Description
AddArg ( string &extant, string flag, string value ) : void
BeginEmergencyExitChute ( string pipeID ) : void
CleanupHost ( ) : void Called when the connection with FLExBridge terminates (currently ~15 seconds after the user closes the FB window)
KillTheHost ( IIPCHost host ) : void
LaunchFieldworksBridge ( string projectFolder, string userName, string command, string projectGuid, int fwmodelVersionNumber, string liftModelVersionNumber, string writingSystemId, System.Action onNonBlockerCommandComplete, bool &changesReceived, string &projectName ) : bool
LaunchFlexBridge ( IIPCHost host, string command, string args, System.Action onNonBlockerCommandComplete, bool &changesReceived, string &projectName ) : void
SignalCompletion ( ) : void

Method Details

AlertFlex() public static method

Acquire the lock on, and then pulse the wait object
public static AlertFlex ( ) : void
return void

DoesProjectHaveFlexRepo() public static method

Answer whether the project appears to have a FLEx repo. This is currently determined by its having a .hg folder.
public static DoesProjectHaveFlexRepo ( string projectFolderPath ) : bool
projectFolderPath string Path to the project folder
return bool

FullFieldWorksBridgePath() public static method

Returns the full path and filename of the FieldWorksBridge executable
public static FullFieldWorksBridgePath ( ) : string
return string

IsFlexBridgeInstalled() public static method

Determines if FLExBridge is installed.
public static IsFlexBridgeInstalled ( ) : bool
return bool