Apama Capital Markets Foundation  10.11.0.0
Session and Parameter addition API

Functions

AP_SESSION_API void AP_SESSION_AddSession (AP_SESSION_Interface *smi, const char *transportName, const char *sessionName, const char *channelName, const char *description)
 
AP_SESSION_API void AP_SESSION_AddSessionParams (AP_SESSION_Interface *smi, const char *sessionName, const char *paramName, const char *type, const char *defaultValue, const char *const allowValues[], size_t allowsize, const char *description, AP_bool required, AP_bool referenceOnly)
 

Detailed Description

Session and Parameter addition API

Function Documentation

◆ AP_SESSION_AddSession()

AP_SESSION_API void AP_SESSION_AddSession ( AP_SESSION_Interface smi,
const char *  transportName,
const char *  sessionName,
const char *  channelName,
const char *  description 
)

Add session for registration.

AP_SESSION_RegisterSession() or AP_SESSION_RegisterSessions() has to be called to actually register any added sessions.

Parameters
smiThe AP_SESSION_Interface to use.
transportNameThe name of the transport to be added.
sessionNameThe name of the session to be added.
channelNameThe name of the channel to use for this session.
descriptionThe description of the session to be added.
See also
AP_SESSION_RegisterSession
AP_SESSION_RegisterSessions

◆ AP_SESSION_AddSessionParams()

AP_SESSION_API void AP_SESSION_AddSessionParams ( AP_SESSION_Interface smi,
const char *  sessionName,
const char *  paramName,
const char *  type,
const char *  defaultValue,
const char *const  allowValues[],
size_t  allowsize,
const char *  description,
AP_bool  required,
AP_bool  referenceOnly 
)

Add control parameters for a session.

Parameters
smiThe AP_SESSION_Interface to use.
sessionNameThe name of the session this parameter is for.
paramNameThe name of the parameter to add.
typeThe type of this parameter (i.e. "float", "string").
defaultValueThe default value for this parameter.
allowValuesAn array of allowed values for this parameter.
allowsizeThe size of the allowValues array.
descriptionThe description of the parameter to be added.
required'true' if this parameter is required, else 'false'.
referenceOnly'true' if this parameter is for reference only, else 'false'.
See also
AP_SESSION_AddSession
AP_SESSION_RegisterSession
AP_SESSION_RegisterSessions