Skip to main content

Interface ICallGateProvider

The backing interface for the provider ("server") half of an IPC channel. This interface is used to expose methods to other plugins via RPC, as well as to allow other plugins to subscribe to notifications from this plugin.

Assembly: Dalamud.dll​
Declaration
public interface ICallGateProvider

Properties​

SubscriptionCount​

Gets the count of subscribers listening for messages through this call gate. Only exposed to Dalamud.Plugin.Ipc.ICallGateProviders, and can be used to determine if messages should be sent through the gate.

Declaration
int SubscriptionCount { get; }

Methods​

UnregisterAction()​

Removes the associated Action from this call gate, effectively disabling RPC calls.

Declaration
void UnregisterAction()

UnregisterFunc()​

Removes the associated Function from this call gate.

Declaration
void UnregisterFunc()

GetContext()​

Gets the current context for this IPC call. This will only be present when called from within an IPC action or function handler, and will be null otherwise.

Declaration
IpcContext? GetContext()
Returns​

Dalamud.Plugin.Ipc.IpcContext: Returns a potential IPC context.