Interface IEmulatedPortStore

A global store that persists controller settings for a set of emulated ports.

Namespace: Snowflake.Orchestration.Extensibility

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IEmulatedPortStore

Methods

ClearPort(IEmulatorOrchestrator, PlatformId, Int32)

Clears the given port for the given IEmulatorOrchestrator for the given platform.

Declaration

void ClearPort(IEmulatorOrchestrator orchestrator, PlatformId platform, int portNumber)

Parameters

Type	Name	Description
IEmulatorOrchestrator	orchestrator	The IEmulatorOrchestrator to clear the port for.
PlatformId	platform	The PlatformId of the platform to clear the port for.
System.Int32	portNumber	The port number to clear.

EnumeratePorts(IEmulatorOrchestrator, PlatformId)

Retrieves all IEmulatedPortDeviceEntry for a given PlatformId, for a given IEmulatorOrchestrator.

Declaration

IEnumerable<IEmulatedPortDeviceEntry> EnumeratePorts(IEmulatorOrchestrator orchestrator, PlatformId platform)

Parameters

Type	Name	Description
IEmulatorOrchestrator	orchestrator	The IEmulatorOrchestrator to retrieve the set of port entries for.
PlatformId	platform	The PlatformId of the platform to retrieve the set of port entries for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IEmulatedPortDeviceEntry>	All IEmulatedPortDeviceEntry relevant for the given orchestrator and platform.

GetPort(IEmulatorOrchestrator, PlatformId, Int32)

Gets the saved IEmulatedPortDeviceEntry for the given IEmulatorOrchestrator, platform, and port number combination.

Declaration

IEmulatedPortDeviceEntry GetPort(IEmulatorOrchestrator orchestrator, PlatformId platform, int portNumber)

Parameters

Type	Name	Description
IEmulatorOrchestrator	orchestrator	The IEmulatorOrchestrator for the entry.
PlatformId	platform	The Stone PlatformId that specifies the platform for this set of ports.
System.Int32	portNumber	The port number.

Returns

Type	Description
IEmulatedPortDeviceEntry

SetPort(IEmulatorOrchestrator, PlatformId, Int32, ControllerId, Guid, InputDriver, Guid)

Sets the saved IEmulatedPortDeviceEntry for the given IEmulatorOrchestrator, platform, and port number combination.

Use ClearPort(IEmulatorOrchestrator, PlatformId, Int32) to "disconnect" or unassign a port entry.

Declaration

void SetPort(IEmulatorOrchestrator orchestrator, PlatformId platform, int portNumber, ControllerId controller, Guid deviceInstanceGuid, InputDriver instanceDriver, Guid inputProfile)

Parameters

Type	Name	Description
IEmulatorOrchestrator	orchestrator	The IEmulatorOrchestrator to save this port entry for.
PlatformId	platform	The PlatformId to assign this port to.
System.Int32	portNumber	The port number to assign.
ControllerId	controller	The ControllerId of the virtual controller to assign this port to.
System.Guid	deviceInstanceGuid	The real IInputDevice that this port originates from.
InputDriver	instanceDriver	The InputDriver of the IInputDeviceInstance of the device to use for this port.
System.Guid	inputProfile	The Profile GUID of the input profile to use.