Package com.inductiveautomation.ignition.common.rpc

Annotation Interface RpcInterface

@Retention(RUNTIME) @Target(TYPE) public @interface RpcInterface
Marks an interface as an RPC interface.
  1. Apply this to your common-scoped interface that defines the RPC methods.
  2. Implement the interface on the gateway
  3. Pass your implementation to an RpcDelegate or GatewayRpcImplementation factory method
This will automatically expose all methods of this interface as RPC functions.

NOTE: Method overloads are not allowed and the first encountered method will be used resulting in unpredictable behavior.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    @NotNull String
    packageId
    An arbitrary identifier that should be used for grouping RPC methods within your module.

  • Element Details

    • packageId

      @NotNull @NotNull String packageId
      An arbitrary identifier that should be used for grouping RPC methods within your module. For example, the Ignition platform might use "images" and "tags" as package IDs for different subsystems. There is no need to use a full Java package name, but any value you provide must be unique within your module.
      Returns:
      A non-null, not empty package ID for this particular RPC interface.