DolphinTCPConnector

A connector for the Dolphin GameCube/Wii emulator using the Crowd Control TCP bridge.

Kind: Class

Namespace: ConnectorLib

Inheritance: ConnectorBase → I16BitConnector → I32BitConnector → I64BitConnector → I8BitConnector → IAddressableConnector → IConsoleConnector → IDisposable → IDomainMappableConnector → IDomainMappableConnector\<DolphinTCPConnector\> → IGCNConnector → IGameConnector → IGeckoConnector → IROMProcessor → IWiiConnector

Public Constructors

DolphinTCPConnector()

Creates a new instance of the ConnectorLib.DolphinTCPConnector class.

Public Member Functions

virtual override

Task>

Connect()

virtual override

Task>

Connect(uint retryCount, SITimeSpan retryInterval)

virtual override

Task

Disconnect(string message)

virtual override

void

KeepAlive()

bool

Read(ulong address, Span buffer, int offset, int length)

bool

Write(ulong address, ReadOnlySpan buffer, int offset, int length)

bool

Read(ulong address, string domain, Span buffer, int offset, int length)

bool

Write(ulong address, string domain, ReadOnlySpan buffer, int offset, int length)

bool

Read8(ulong address, byte out value)

bool

Read16(ulong address, ushort out value)

bool

Read32(ulong address, uint out value)

bool

Read64(ulong address, ulong out value)

bool

Write8(ulong address, byte value)

bool

Write16(ulong address, ushort value)

bool

Write32(ulong address, uint value)

bool

Write64(ulong address, ulong value)

bool

Read8(ulong address, string domain, byte out value)

bool

Write8(ulong address, string domain, byte value)

bool

SetBits(ulong address, byte mask, byte out orig)

bool

UnsetBits(ulong address, byte mask, byte out orig)

bool

SetBits(ulong address, string domain, byte mask, byte out orig)

bool

UnsetBits(ulong address, string domain, byte mask, byte out orig)

bool

CompareSwap(ulong chkAddress, byte test, byte newVal, byte out orig)

bool

Freeze8(ulong address, byte value)

bool

Freeze16(ulong address, ushort value)

bool

Freeze32(ulong address, uint value)

bool

Freeze64(ulong address, ulong value)

bool

Freeze(ulong address, ulong value, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType condition)

bool

Freeze(ulong address, ulong value, ulong mask, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType condition)

bool

Unfreeze(ulong address)

bool

UnfreezeAll()

Removes all freezes registered in Dolphin.

bool

Freeze(ulong address, string domain, ulong value, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType cmpType)

bool

Freeze(ulong address, string domain, ulong value, ulong mask, byte size, WriteType writeType, ulong cmpAddress, ulong cmpValue, byte cmpSize, CompareType cmpType)

bool

Unfreeze(ulong address, string domain)

bool

UncacheJIT()

Clears the JIT (Just-In-Time) compiler cache of the Dolphin emulator.

bool

UncacheJIT(uint address, uint size)

Clears the JIT (Just-In-Time) compiler cache of the Dolphin emulator.

bool

PushState()

Pushes the current state of the emulator to the save state stack.

bool

PopState()

Restores the last saved state of the emulator from the save state stack.

bool

InvertControls(bool invert)

Inverts/restores the main stick of the emulated GameCube controllers.

bool

SwapButtons(bool swap)

Swaps/restores the face buttons of the emulated GameCube controllers.

string

GetGameID()

Gets the game ID (e.g. "GZLE01") of the game currently running in Dolphin.

virtual override

bool

SendMessage(string message)

string

GetROMPath()

bool

OpenROM(string path)

bool

CloseROM()

bool

PatchROM(IROMPatch patch)

bool

PatchROM(byte[] data)

bool

ResetConsole()

Public Attributes

string

DEFAULT_HOST

The default host on which the Dolphin TCP bridge listens.

int

DEFAULT_PORT

The default port (0xCC00) of the Dolphin TCP bridge ("CrowdControlPort" in Dolphin.ini).

uint

PROTOCOL_VERSION

The wire protocol version this connector implements.

Properties

static

string

Host

[get, set]

The host to connect to. Change before connecting if Dolphin is configured differently.

static

int

Port

[get, set]

The port to connect to. Change before connecting if Dolphin is configured differently.

Endianness

Endianness

[get, ]

PointerFormat

PointerFormat

[get, ]

IFeatureAware

Features

[get, ]

bool

Connected

[get, ]

Events

Action<string>

UserStateLoad

Action<string>

UserStateSave

Action<string>

UserStateDelete