Skip to main content
Version: 14.x (API 14) [Legacy]

Interface ICallGateSubscriber<TRet>

This class facilitates inter-plugin communication.

Assembly: Dalamud.dll​
Declaration
public interface ICallGateSubscriber<TRet> : ICallGateSubscriber

Methods​

Subscribe(Action)​

Registers a System.Delegate (of type System.Action1) that will be called when the providing plugin calls Dalamud.Plugin.Ipc.ICallGateProvider1.SendMessage. This method can be used to receive notifications of events or data updates from a specific plugin.

Declaration
void Subscribe(Action action)
Parameters​
TypeNameDescription
System.ActionactionAction to subscribe.
See Also​
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.Unsubscribe(System.Delegate)

Unsubscribe(Action)​

Removes a subscription created through Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.Subscribe(System.Delegate). Note that the System.Delegate to be unsubscribed must be the same instance as the one passed in.

Declaration
void Unsubscribe(Action action)
Parameters​
TypeNameDescription
System.ActionactionAction to unsubscribe.
See Also​
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.Subscribe(System.Delegate)

InvokeAction()​

Executes the Action registered for this IPC call gate via Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.RegisterAction(System.Delegate). This method is intended to be called by plugins wishing to access another plugin via RPC. The parameters passed to this method will be passed to the owning plugin, with appropriate serialization for complex data types. Primitive data types will be passed as-is. The target Action will be called on the same thread as the caller.

Declaration
void InvokeAction()
Exceptions​

Dalamud.Plugin.Ipc.Exceptions.IpcNotReadyError
This is thrown when the IPC publisher has not registered an action for calling yet.

See Also​
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.RegisterAction(System.Delegate)
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.UnregisterAction

InvokeFunc()​

Executes the Function registered for this IPC call gate via Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.RegisterFunc(System.Delegate). This method is intended to be called by plugins wishing to access another plugin via RPC. The parameters passed to this method will be passed to the owning plugin, with appropriate serialization for complex data types. Primitive data types will be passed as-is. The target Action will be called on the same thread as the caller.

Declaration
TRet InvokeFunc()
Returns​

<TRet>: The return value.

Exceptions​

Dalamud.Plugin.Ipc.Exceptions.IpcNotReadyError
This is thrown when the IPC publisher has not registered a func for calling yet.

See Also​
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.RegisterFunc(System.Delegate)
  • Dalamud.Plugin.Ipc.Internal.CallGatePubSubBase.UnregisterFunc