API Functions for Managing Session State

The C/C++ SDK provides functions that enable you to store and retrieve session state information.

The session state of an RPC plugin is analogous to the session state of an in-process adapter. An RPC Plugin's execute() function is typically called many times. Some plugins need to carry over information from one invocation to the next. We refer to this carried over information as "session state". Session state information is not carried over if the server crashes or is restarted. Unlike in-process adapters, RPC plugins do not allow you to set and get persistent state.

• void C8RpcSetSessionState(C8Rpc *rpcctx, void *state); – Purpose: Sets the plugin's session state. The state is a contiguous piece of memory containing whatever information the plugin wants to store. When you set the state in the initialize() function or the execute() function, the server stores a copy of the pointer to this memory. When you call the C8RpcGetSessionState() function, the server returns that same pointer.

  Parameters:

  • rpcctx: A pointer to the context for this particular instance of the plugin.

  • state: A pointer to a user-defined structure.

  Returns: Nothing.

• void *C8RpcGetSessionState(C8Rpc *rpcctx); – Purpose: Gets the plugin's session state. Returns NULL if no state was set.

  Parameters:

  • rpcctx: A pointer to the context for this particular instance of the plugin.

  Returns: A pointer to the session state information. See the description of the C8RpcSetSessionState() function for more information about this pointer.