SM_SessionInterface.h

Go to the documentation of this file.

#ifndef _AP_SESSION_MANAGERINTERFACE_H
#define _AP_SESSION_MANAGERINTERFACE_H

/* The timestamp tags are tempararily allocated 
   These corresponding space should be allocated in the AP_TimestampSet.h

 AP_TIMESTAMP_UPSTREAM_SESSION_ENTRY 19851
 AP_TIMESTAMP_UPSTREAM_SESSION_EXIT  19800

 AP_TIMESTAMP_DOWNSTREAM_SESSION_ENTRY 1151
 AP_TIMESTAMP_DOWNSTREAM_SESSION_EXIT  1200
*/

//Apama includes
#include <CHashMap.h>
#include <EventTransport.h>
#include <limits.h>
#if defined(_APBUILD_WIN32_ALL__) || defined(__WIN32__) || defined(WIN32)
/*
 * DLL import/export symbols for Win32 builds.  Everything will work correctly
 * as long as the following symbols are *not* defined when this file is
 * included (These symbols are for Apama internal use only):
 *    AP_SESSION_BACKEND
 *        
 */

#ifndef _APBUILD_WIN32_ALL__
#define _APBUILD_WIN32_ALL__ 
#endif

#ifdef AP_SESSION_BACKEND
#define AP_SESSION_API __declspec(dllexport)
#define AP_SESSION_CALL __stdcall
#else
#define AP_SESSION_API __declspec(dllimport)
#define AP_SESSION_CALL __stdcall
#endif

#elif defined(_APBUILD_UNIX_ALL__) || defined(__unix__)

#define AP_SESSION_API 
#define AP_SESSION_CALL
#else 
#error "Can't determine platform: try #define _APBUILD_WIN32_ALL__ or _APBUILD_UNIX_ALL__"

#endif

#define STREAMTYPE_BBA          ("com.apama.md.BBA")    
#define STREAMTYPE_TRADE        ("com.apama.md.T")      
#define STREAMTYPE_MBP          ("com.apama.md.D")      
#define STREAMTYPE_MBO          ("com.apama.md.O")      
#define STREAMTYPE_EP           ("com.apama.md.EP")     
#define STREAMTYPE_QUOTEBOOK    ("com.apama.md.QB")     
#define STREAMTYPE_NEWS         ("com.apama.md.N")       // end of session_capabilities

typedef struct 
{
    void (*onCorrelatorWatchDogTimedOut)(void* transportInternals);

    void (*onSessionRegistrationSuccess)(void* transportInternals, const char* sessionName, AP_int64 sourceId, AP_TimestampSet *tss);

    void (*onSessionRegistrationError)(void* transportInternals, const char* sessionName, AP_TimestampSet *tss);
    
    void (*onSessionStart)(void* transportInternals, AP_int64 sourceId, HashMap* configParams, AP_TimestampSet *tss);

    void (*onSessionStop) (void* transportInternals, AP_int64 sourceId, AP_TimestampSet *tss);

    void (*onSessionReconfigure)(void* transportInternals, AP_int64 sourceId, HashMap* configParams, AP_TimestampSet *tss);

    void (*onSessionReset)(void* transportInternals, const char* transportName, AP_TimestampSet* tss);
}
AP_SESSION_AdapterInterface;

typedef struct 
{
    AP_SESSION_AdapterInterface *adapterInterface;      
    void                        *transportInternals;    
    void                        *reserved;              
}
AP_SESSION_Interface;

typedef enum
{
    /* Maintain sequence */
    SESSION_UNKNOWN,        
    SESSION_INITIAL,        
    SESSION_REGISTERED,     
    SESSION_DISCONNECTED,   
    SESSION_CONNECTED,      
    SESSION_LOGGEDOUT,      
    SESSION_LOGGEDIN        
}
AP_SESSION_State;

#if defined( __cplusplus )
extern "C"{
#endif

    AP_SESSION_API void AP_SESSION_Init(AP_SESSION_AdapterInterface* adapterInterface, void* transportInternals, AP_SESSION_Interface** smi);

    AP_SESSION_API void AP_SESSION_DeInit(AP_SESSION_Interface* smi);
 // end of session_init_api

    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); // end of session_add_api

    AP_SESSION_API void AP_SESSION_AddCapabilities(AP_SESSION_Interface* smi, const char* sessionName, const char *const capabilities[], size_t capsSize);

    AP_SESSION_API void AP_SESSION_AddCapabilityParams(
        AP_SESSION_Interface *  smi,
        const char*             sessionName,
        const char*             streamName,
        const char*             key,
        const char*             type,
        const char*             defaultValue,
        const char* const       allowedValues[],
        size_t                  allowsize,
        const char*             description, 
        AP_bool                 required);

    AP_SESSION_API void AP_SESSION_AddCapabilitiesById(AP_SESSION_Interface* smi, AP_int64 sourceId, const char *const capabilities[], size_t capsSize);

    AP_SESSION_API void AP_SESSION_AddCapabilityParamsById(
        AP_SESSION_Interface *  smi,
        AP_int64                sourceId,
        const char*             streamName,
        const char*             key,
        const char*             type,
        const char*             defaultValue,
        const char* const       allowedValues[],
        size_t                  allowsize,
        const char*             description, 
        AP_bool                 required);

    AP_SESSION_API AP_bool AP_SESSION_HasCapability(AP_SESSION_Interface* smi, const AP_int64 sourceId, const char* capability); // end of session_register_api

    AP_SESSION_API void AP_SESSION_RegisterSessions(AP_SESSION_Interface* smi);
    
    AP_SESSION_API void AP_SESSION_RegisterSession(AP_SESSION_Interface* smi, const char* sessionName); // end of session_register_api

    AP_SESSION_API void AP_SESSION_DeleteSessionByName(AP_SESSION_Interface* smi, const char* sessionName);

    AP_SESSION_API void AP_SESSION_DeleteSessionById(AP_SESSION_Interface* smi, AP_int64 sourceId);

    AP_SESSION_API void AP_SESSION_Clear(AP_SESSION_Interface* smi); // end of session_delete_api

    /* Manipulate the session states */

    AP_SESSION_API void AP_SESSION_SetSessionStateByName(AP_SESSION_Interface* smi, const char* sessionName, AP_SESSION_State state, bool generateNewId = false);

    AP_SESSION_API void AP_SESSION_SetSessionStateById(AP_SESSION_Interface* smi, AP_int64 sourceId, AP_SESSION_State state, bool generateNewId = false);

    AP_SESSION_API AP_SESSION_State AP_SESSION_GetSessionStateByName(AP_SESSION_Interface* smi, const char* sessionName);

    AP_SESSION_API AP_SESSION_State AP_SESSION_GetSessionStateById(AP_SESSION_Interface* smi, AP_int64 sourceId);

    AP_SESSION_API HashMap * AP_SESSION_GetAllSessionStates(AP_SESSION_Interface* smi); // end of session_state_api

    AP_SESSION_API void AP_SESSION_SetCorrelatorHBTimeout(AP_SESSION_Interface* smi, int timeoutInterval);

    AP_SESSION_API void AP_SESSION_GenerateIAFStatus(AP_SESSION_Interface* smi, AP_NormalisedEvent *nevent);

    AP_SESSION_API int  AP_SESSION_ProcessEvent(AP_SESSION_Interface* smi, AP_TransportEvent event, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SetDecoder(AP_SESSION_Interface* smi, AP_EventDecoder* decoder);

    AP_SESSION_API void AP_SESSION_SessionStartSuccess(AP_SESSION_Interface* smi, AP_int64 sourceId, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SessionStartError(AP_SESSION_Interface* smi, AP_int64 sourceId, const char* errMsg, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SessionStopSuccess(AP_SESSION_Interface* smi, AP_int64 sourceId, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SessionStopError(AP_SESSION_Interface* smi, AP_int64 sourceId, const char* errMsg, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SessionReconfigureSuccess(AP_SESSION_Interface* smi, AP_int64 sourceId, AP_TimestampSet* tss);

    AP_SESSION_API void AP_SESSION_SessionReconfigureError(AP_SESSION_Interface* smi, AP_int64 sourceId, const char* errMsg, AP_TimestampSet* tss); // end of session_callbacks_api

    AP_SESSION_API const char* AP_SESSION_GetSessionName(AP_SESSION_Interface* smi, AP_int64 sourceId);

    AP_SESSION_API AP_int64 AP_SESSION_GetSessionId(AP_SESSION_Interface* smi, const char* sessionName);

    AP_SESSION_API void AP_SESSION_LogLatency(AP_SESSION_Interface* smi, IAF_TimestampConfig* config);

    AP_SESSION_API void AP_SESSION_Stop(AP_SESSION_Interface* smi);

    AP_SESSION_API void AP_SESSION_Start(AP_SESSION_Interface* smi);

#if defined( __cplusplus )
} // extern "C"
#endif


#endif //_AP_SESSION_MANAGERINTERFACE_H