The ICallGateProvider interface is used to expose methods to other plugins via RPC (Remote Procedure Call), as well as to allow other plugins to subscribe to notifications from this plugin. This is the server-side interface for inter-plugin communication.
Interface Hierarchy
The ICallGateProvider interface has multiple generic variants to support different numbers of parameters:
ICallGateProvider - Base interface with common functionalityICallGateProvider<TRet> - No parametersICallGateProvider<T1, TRet> - One parameterICallGateProvider<T1, T2, TRet> - Two parametersICallGateProvider<T1, T2, T3, TRet> - Three parametersICallGateProvider<T1, T2, T3, T4, TRet> - Four parametersICallGateProvider<T1, T2, T3, T4, T5, TRet> - Five parametersICallGateProvider<T1, T2, T3, T4, T5, T6, TRet> - Six parametersICallGateProvider<T1, T2, T3, T4, T5, T6, T7, TRet> - Seven parametersICallGateProvider<T1, T2, T3, T4, T5, T6, T7, T8, TRet> - Eight parameters
Type Parameters
The type of the first parameter
The type of the second parameter
The type of the third parameter
The type of the fourth parameter
The type of the fifth parameter
The type of the sixth parameter
The type of the seventh parameter
The type of the eighth parameter
The return type of the function. Use object for void-like behavior
Properties
Gets the count of subscribers listening for messages through this call gate. This can be used to determine if messages should be sent through the gate.
Methods
UnregisterAction
Removes the associated Action from this call gate, effectively disabling RPC calls.
UnregisterFunc
Removes the associated Function from this call gate.
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.
Returns the current IPC context, or null if not called from within an IPC handler
RegisterAction
void RegisterAction(Action action)
void RegisterAction(Action<T1> action)
void RegisterAction(Action<T1, T2> action)
void RegisterAction(Action<T1, T2, T3> action)
void RegisterAction(Action<T1, T2, T3, T4> action)
void RegisterAction(Action<T1, T2, T3, T4, T5> action)
void RegisterAction(Action<T1, T2, T3, T4, T5, T6> action)
void RegisterAction(Action<T1, T2, T3, T4, T5, T6, T7> action)
void RegisterAction(Action<T1, T2, T3, T4, T5, T6, T7, T8> action)
Action to register. The Action’s parameters must match the generic type parameters of the interface
RegisterFunc
void RegisterFunc(Func<TRet> func)
void RegisterFunc(Func<T1, TRet> func)
void RegisterFunc(Func<T1, T2, TRet> func)
void RegisterFunc(Func<T1, T2, T3, TRet> func)
void RegisterFunc(Func<T1, T2, T3, T4, TRet> func)
void RegisterFunc(Func<T1, T2, T3, T4, T5, TRet> func)
void RegisterFunc(Func<T1, T2, T3, T4, T5, T6, TRet> func)
void RegisterFunc(Func<T1, T2, T3, T4, T5, T6, T7, TRet> func)
void RegisterFunc(Func<T1, T2, T3, T4, T5, T6, T7, T8, TRet> func)
Func to register. The Func’s parameters and return type must match the generic type parameters of the interface
SendMessage
void SendMessage()
void SendMessage(T1 arg1)
void SendMessage(T1 arg1, T2 arg2)
void SendMessage(T1 arg1, T2 arg2, T3 arg3)
void SendMessage(T1 arg1, T2 arg2, T3 arg3, T4 arg4)
void SendMessage(T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5)
void SendMessage(T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)
void SendMessage(T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7)
void SendMessage(T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8)
First argument to pass to subscribers
Second argument to pass to subscribers
Third argument to pass to subscribers
Fourth argument to pass to subscribers
Fifth argument to pass to subscribers
Sixth argument to pass to subscribers
Seventh argument to pass to subscribers
Eighth argument to pass to subscribers
Usage Examples
Providing a simple function
// Create a provider for a function that takes a string and returns an int
var provider = pluginInterface.GetIpcProvider<string, int>("MyPlugin.GetLength");
// Register the function implementation
provider.RegisterFunc((string input) => input.Length);
Providing an action with no return value
// Create a provider for an action that takes two parameters
var provider = pluginInterface.GetIpcProvider<string, int, object>("MyPlugin.LogMessage");
// Register the action implementation
provider.RegisterAction((string message, int level) =>
{
Log.Information($"[Level {level}] {message}");
});
Sending notifications to subscribers
// Create a provider for broadcasting events
var provider = pluginInterface.GetIpcProvider<string, object>("MyPlugin.OnDataUpdated");
// Register a notification action
provider.RegisterAction((string data) => { });
// Later, notify all subscribers
if (provider.SubscriptionCount > 0)
{
provider.SendMessage("New data available");
}
Checking caller context
var provider = pluginInterface.GetIpcProvider<string, object>("MyPlugin.RestrictedAction");
provider.RegisterAction((string data) =>
{
var context = provider.GetContext();
if (context?.SourcePlugin != null)
{
Log.Information($"Called by plugin: {context.SourcePlugin.Name}");
}
});
Unregistering handlers
var provider = pluginInterface.GetIpcProvider<string, int>("MyPlugin.Calculate");
// Register a function
provider.RegisterFunc((string input) => int.Parse(input));
// Later, when your plugin is being disposed
provider.UnregisterFunc();
Notes
- All IPC calls execute on the same thread as the caller
- Complex data types are serialized when passed between plugins
- Primitive data types are passed as-is
- Only one Action or Func can be registered at a time per call gate
- Use
SubscriptionCount to check if any plugins are listening before sending messages