SpringCard.SpringCore.Direct.SharedStatus Class Reference

IPC component to prevent concurrent access to the SpringCore devices (sinces WinUSB does not allow it at all). More...

Static Public Member Functions
static string	Read ()
	Read the IPC object. More...
static void	Publish (string message)
	Publish an information into the IPC object. More...
static void	Cleanup ()
	Clear the IPC object. More...
static bool	AnotherInstanceRunning ()
	Is another SpringCore-related application already running? More...
static bool	AnotherInstanceRunning (out string message)
	Does another application already owns the mutex? More...
static string	GetMode ()
	If another application is already running, what is its mode? More...
static string	GetVersion ()
	If another application is already running, what is its version? More...
static string	GetProcessUser ()
	If another application is already running, under which user identity is it running? More...
static string	GetProcessBinary ()
	If another application is already running, what is the name of the process? More...
static string	GetRestUri ()
	If another application is already running, could it be connected as REST server? More...
static string	GetWebSocketUri ()
	If another application is already running, could it be connected as WebSocket server? More...

Static Public Attributes
const string	MutexName = @"Global\SpringCoreDirectStatus"
	Name of the global mutex. More...
const string	MappedFileGlobal = @"Global\SpringCoreDirectStatus"
	Name of the global (system-wide) IPC object. More...
const string	MappedFileLocal = @"SpringCoreDirectStatus"
	Name of the local (session-wide) IPC object. More...

Detailed Description

IPC component to prevent concurrent access to the SpringCore devices (sinces WinUSB does not allow it at all).

Member Function Documentation

AnotherInstanceRunning() [1/2]

static bool SpringCard.SpringCore.Direct.SharedStatus.AnotherInstanceRunning ( )

static

Is another SpringCore-related application already running?

AnotherInstanceRunning() [2/2]

static bool SpringCard.SpringCore.Direct.SharedStatus.AnotherInstanceRunning ( out string  message )

static

Does another application already owns the mutex?

Cleanup()

static void SpringCard.SpringCore.Direct.SharedStatus.Cleanup ( )

static

Clear the IPC object.

GetMode()

static string SpringCard.SpringCore.Direct.SharedStatus.GetMode ( )

static

If another application is already running, what is its mode?

GetProcessBinary()

static string SpringCard.SpringCore.Direct.SharedStatus.GetProcessBinary ( )

static

If another application is already running, what is the name of the process?

GetProcessUser()

static string SpringCard.SpringCore.Direct.SharedStatus.GetProcessUser ( )

static

If another application is already running, under which user identity is it running?

GetRestUri()

static string SpringCard.SpringCore.Direct.SharedStatus.GetRestUri ( )

static

If another application is already running, could it be connected as REST server?

GetVersion()

static string SpringCard.SpringCore.Direct.SharedStatus.GetVersion ( )

static

If another application is already running, what is its version?

GetWebSocketUri()

static string SpringCard.SpringCore.Direct.SharedStatus.GetWebSocketUri ( )

static

If another application is already running, could it be connected as WebSocket server?

Publish()

static void SpringCard.SpringCore.Direct.SharedStatus.Publish ( string  message )

static

Publish an information into the IPC object.

Read()

static string SpringCard.SpringCore.Direct.SharedStatus.Read ( )

static

Read the IPC object.

Member Data Documentation

MappedFileGlobal

const string SpringCard.SpringCore.Direct.SharedStatus.MappedFileGlobal = @"Global\SpringCoreDirectStatus"

static

Name of the global (system-wide) IPC object.

MappedFileLocal

const string SpringCard.SpringCore.Direct.SharedStatus.MappedFileLocal = @"SpringCoreDirectStatus"

static

Name of the local (session-wide) IPC object.

MutexName

const string SpringCard.SpringCore.Direct.SharedStatus.MutexName = @"Global\SpringCoreDirectStatus"

static

Name of the global mutex.

---

The documentation for this class was generated from the following file:

• D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/SharedStatus.cs