Connectivity_SessionDefs.h File Reference

All the session related definitions and constants. More...

#include <string>
#include <list>
#include <map>
#include <algorithm>
#include <iterator>
#include <sag_connectivity_plugins.hpp>

Go to the source code of this file.

Classes
struct	Param
struct	SessionParam
struct	SessionParams
struct	CapabilityParam
struct	CapabilityParams
struct	Capability
struct	SessionConfigs

Macros
#define	SESSION_CONFIG_SCHEMA   ("configSchema")
#define	SESSION_CONFIG_PARAMS   ("SCP")
#define	SESSION_CONFIG_KEY   ("SessionConfigParams")
#define	SESSION_CAPABILITIES   ("sessionCapabilities")
#define	CTRL_PARAMS   ("CtrlParams")
#define	CTRL_PARAMS_CP   ("CP")
#define	CTRL_PARAMS_SCHEMA   ("CtrlParamsSchema")

Typedefs
typedef std::map< std::string, CapabilityParams >	Capabilities

Enumerations
enum	AP_SESSION_State {   SESSION_UNKNOWN, SESSION_INITIAL, SESSION_REGISTERED, SESSION_DISCONNECTED,   SESSION_CONNECTED, SESSION_LOGGEDOUT, SESSION_LOGGEDIN, SESSION_UNKNOWN,   SESSION_INITIAL, SESSION_REGISTERED, SESSION_DISCONNECTED, SESSION_CONNECTED,   SESSION_LOGGEDOUT, SESSION_LOGGEDIN }

Detailed Description

All the session related definitions and constants.

Copyright

$Copyright (c) 2017 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$ Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG

Macro Definition Documentation

CTRL_PARAMS

#define CTRL_PARAMS   ("CtrlParams")

CtrlParams event name, which is received by the adapter

CTRL_PARAMS_CP

#define CTRL_PARAMS_CP   ("CP")

Cp event name, which is contained by CtrlParamsSchema

CTRL_PARAMS_SCHEMA

#define CTRL_PARAMS_SCHEMA   ("CtrlParamsSchema")

CtrlParamsSchema event name, which is contained by CapabilityProvidesDatastream event

SESSION_CAPABILITIES

#define SESSION_CAPABILITIES   ("sessionCapabilities")

Session Capabilities event name, which is contained by SessionRegistration event

SESSION_CONFIG_KEY

#define SESSION_CONFIG_KEY   ("SessionConfigParams")

Session config param key recieved in the upstream event

SESSION_CONFIG_PARAMS

#define SESSION_CONFIG_PARAMS   ("SCP")

Each session config param

SESSION_CONFIG_SCHEMA

#define SESSION_CONFIG_SCHEMA   ("configSchema")

ConfigParamsSchema event name, which is contained by SessionRegistration event

Typedef Documentation

Capabilities

typedef std::map<std::string, CapabilityParams> Capabilities

Map definition for param name vs CapabilityParams

Enumeration Type Documentation

AP_SESSION_State

enum AP_SESSION_State

Session state enum

Enumerator
SESSION_UNKNOWN	Maintain sequence State Unknown
SESSION_INITIAL	Initial State
SESSION_REGISTERED	Registered
SESSION_DISCONNECTED	Disconnected
SESSION_CONNECTED	Connected
SESSION_LOGGEDOUT	Logged Out
SESSION_LOGGEDIN	Logged In
SESSION_UNKNOWN	State Unknown
SESSION_INITIAL	Initial State
SESSION_REGISTERED	Registered
SESSION_DISCONNECTED	Disconnected
SESSION_CONNECTED	Connected
SESSION_LOGGEDOUT	Logged Out
SESSION_LOGGEDIN	Logged In