- Writing an SSE Plugin
- Protocol Description (API reference)
- Documentation and tutorials for gRPC and protobuf
The interface between the Qlik Engine acting as a client and the Server-side extension acting as server is defined in the file ServerSideExtension.proto.
The RPC methods implemented in the Basic example are GetCapabilities and ExecuteFunction. There is no script support.
The GetCapabilities method returns a Capabilities object, describing the operations supported by the plugin.
The ExecuteFunction method switches over the numeric function identifier sent in the qlik-functionrequestheader-bin header. Each case construct then iterates over the BundledRows elements packed into the request stream and writes the results to the output stream. There are five functions implemented in the Go example plugin:
- EchoString (echoes the supplied string back to Qlik)
- SumOfRow (summarizes two columns, in a row-wise manner)
- SumOfColumn (summarizes one column)
- Cache (example of SSE caching)
- NoCache (example of disabling SSE cache)