blpapi_sessionoptions.h File Reference

A common interface shared between publish and consumer sessions. More...

Go to the source code of this file.

Classes
class	blpapi::SessionOptions
Namespaces
namespace	blpapi
Functions
BLPAPI_EXPORT blpapi_SessionOptions_t *	blpapi_SessionOptions_create (void)
BLPAPI_EXPORT blpapi_SessionOptions_t *	blpapi_SessionOptions_duplicate (const blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT void	blpapi_SessionOptions_copy (blpapi_SessionOptions_t *lhs, const blpapi_SessionOptions_t *rhs)
BLPAPI_EXPORT void	blpapi_SessionOptions_destroy (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_setServerHost (blpapi_SessionOptions_t *parameters, const char *serverHost)
BLPAPI_EXPORT int	blpapi_SessionOptions_setServerPort (blpapi_SessionOptions_t *parameters, unsigned short serverPort)
BLPAPI_EXPORT int	blpapi_SessionOptions_setServerAddress (blpapi_SessionOptions_t *parameters, const char *serverHost, unsigned short serverPort, size_t index)
BLPAPI_EXPORT int	blpapi_SessionOptions_removeServerAddress (blpapi_SessionOptions_t *parameters, size_t index)
BLPAPI_EXPORT int	blpapi_SessionOptions_setConnectTimeout (blpapi_SessionOptions_t *parameters, unsigned int timeoutInMilliseconds)
BLPAPI_EXPORT int	blpapi_SessionOptions_setDefaultServices (blpapi_SessionOptions_t *parameters, const char *defaultServices)
BLPAPI_EXPORT int	blpapi_SessionOptions_setDefaultSubscriptionService (blpapi_SessionOptions_t *parameters, const char *serviceIdentifier)
BLPAPI_EXPORT void	blpapi_SessionOptions_setDefaultTopicPrefix (blpapi_SessionOptions_t *parameters, const char *prefix)
BLPAPI_EXPORT void	blpapi_SessionOptions_setAllowMultipleCorrelatorsPerMsg (blpapi_SessionOptions_t *parameters, int allowMultipleCorrelatorsPerMsg)
BLPAPI_EXPORT void	blpapi_SessionOptions_setClientMode (blpapi_SessionOptions_t *parameters, int clientMode)
BLPAPI_EXPORT void	blpapi_SessionOptions_setMaxPendingRequests (blpapi_SessionOptions_t *parameters, int maxPendingRequests)
BLPAPI_EXPORT void	blpapi_SessionOptions_setAutoRestartOnDisconnection (blpapi_SessionOptions_t *parameters, int autoRestart)
BLPAPI_EXPORT void	blpapi_SessionOptions_setAutoRestart (blpapi_SessionOptions_t *parameters, int autoRestart)
BLPAPI_EXPORT void	blpapi_SessionOptions_setAuthenticationOptions (blpapi_SessionOptions_t *parameters, const char *authOptions)
BLPAPI_EXPORT void	blpapi_SessionOptions_setNumStartAttempts (blpapi_SessionOptions_t *parameters, int numStartAttempts)
BLPAPI_EXPORT void	blpapi_SessionOptions_setMaxEventQueueSize (blpapi_SessionOptions_t *parameters, size_t maxEventQueueSize)
BLPAPI_EXPORT int	blpapi_SessionOptions_setSlowConsumerWarningHiWaterMark (blpapi_SessionOptions_t *parameters, float hiWaterMark)
BLPAPI_EXPORT int	blpapi_SessionOptions_setSlowConsumerWarningLoWaterMark (blpapi_SessionOptions_t *parameters, float loWaterMark)
BLPAPI_EXPORT int	blpapi_SessionOptions_setDefaultKeepAliveInactivityTime (blpapi_SessionOptions_t *parameters, int inactivityMsecs)
BLPAPI_EXPORT int	blpapi_SessionOptions_setDefaultKeepAliveResponseTimeout (blpapi_SessionOptions_t *parameters, int timeoutMsecs)
BLPAPI_EXPORT int	blpapi_SessionOptions_setKeepAliveEnabled (blpapi_SessionOptions_t *parameters, int isEnabled)
BLPAPI_EXPORT void	blpapi_SessionOptions_setRecordSubscriptionDataReceiveTimes (blpapi_SessionOptions_t *parameters, int shouldRecord)
BLPAPI_EXPORT int	blpapi_SessionOptions_setServiceCheckTimeout (blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT int	blpapi_SessionOptions_setServiceDownloadTimeout (blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT void	blpapi_SessionOptions_setTlsOptions (blpapi_SessionOptions_t *paramaters, const blpapi_TlsOptions_t *tlsOptions)
BLPAPI_EXPORT int	blpapi_SessionOptions_setFlushPublishedEventsTimeout (blpapi_SessionOptions_t *paramaters, int timeoutMsecs)
BLPAPI_EXPORT const char *	blpapi_SessionOptions_serverHost (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT unsigned int	blpapi_SessionOptions_serverPort (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_numServerAddresses (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_getServerAddress (blpapi_SessionOptions_t *parameters, const char **serverHost, unsigned short *serverPort, size_t index)
BLPAPI_EXPORT unsigned int	blpapi_SessionOptions_connectTimeout (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char *	blpapi_SessionOptions_defaultServices (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char *	blpapi_SessionOptions_defaultSubscriptionService (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char *	blpapi_SessionOptions_defaultTopicPrefix (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_allowMultipleCorrelatorsPerMsg (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_clientMode (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_maxPendingRequests (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_autoRestartOnDisconnection (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_autoRestart (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT const char *	blpapi_SessionOptions_authenticationOptions (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_numStartAttempts (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT size_t	blpapi_SessionOptions_maxEventQueueSize (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT float	blpapi_SessionOptions_slowConsumerWarningHiWaterMark (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT float	blpapi_SessionOptions_slowConsumerWarningLoWaterMark (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_defaultKeepAliveInactivityTime (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_defaultKeepAliveResponseTimeout (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_keepAliveEnabled (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_recordSubscriptionDataReceiveTimes (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_serviceCheckTimeout (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_serviceDownloadTimeout (blpapi_SessionOptions_t *parameters)
BLPAPI_EXPORT int	blpapi_SessionOptions_print (blpapi_SessionOptions_t *parameters, blpapi_StreamWriter_t streamWriter, void *stream, int indentLevel, int spacesPerLevel)
BLPAPI_EXPORT int	blpapi_SessionOptions_flushPublishedEventsTimeout (blpapi_SessionOptions_t *parameters)
std::ostream &	blpapi::operator<< (std::ostream &stream, const SessionOptions &sessionOptions)

---

Detailed Description

A common interface shared between publish and consumer sessions.

---

Function Documentation

BLPAPI_EXPORT blpapi_SessionOptions_t* blpapi_SessionOptions_create

(

void

)

BLPAPI_EXPORT blpapi_SessionOptions_t* blpapi_SessionOptions_duplicate

(

const blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT void blpapi_SessionOptions_copy	(	blpapi_SessionOptions_t *	lhs,
		const blpapi_SessionOptions_t *	rhs
	)

BLPAPI_EXPORT void blpapi_SessionOptions_destroy

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_setServerHost	(	blpapi_SessionOptions_t *	parameters,
		const char *	serverHost
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setServerPort	(	blpapi_SessionOptions_t *	parameters,
		unsigned short	serverPort
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setServerAddress	(	blpapi_SessionOptions_t *	parameters,
		const char *	serverHost,
		unsigned short	serverPort,
		size_t	index
	)

BLPAPI_EXPORT int blpapi_SessionOptions_removeServerAddress	(	blpapi_SessionOptions_t *	parameters,
		size_t	index
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setConnectTimeout	(	blpapi_SessionOptions_t *	parameters,
		unsigned int	timeoutInMilliseconds
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultServices	(	blpapi_SessionOptions_t *	parameters,
		const char *	defaultServices
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultSubscriptionService	(	blpapi_SessionOptions_t *	parameters,
		const char *	serviceIdentifier
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setDefaultTopicPrefix	(	blpapi_SessionOptions_t *	parameters,
		const char *	prefix
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setAllowMultipleCorrelatorsPerMsg	(	blpapi_SessionOptions_t *	parameters,
		int	allowMultipleCorrelatorsPerMsg
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setClientMode	(	blpapi_SessionOptions_t *	parameters,
		int	clientMode
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setMaxPendingRequests	(	blpapi_SessionOptions_t *	parameters,
		int	maxPendingRequests
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setAutoRestartOnDisconnection	(	blpapi_SessionOptions_t *	parameters,
		int	autoRestart
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setAutoRestart	(	blpapi_SessionOptions_t *	parameters,
		int	autoRestart
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setAuthenticationOptions	(	blpapi_SessionOptions_t *	parameters,
		const char *	authOptions
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setNumStartAttempts	(	blpapi_SessionOptions_t *	parameters,
		int	numStartAttempts
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setMaxEventQueueSize	(	blpapi_SessionOptions_t *	parameters,
		size_t	maxEventQueueSize
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setSlowConsumerWarningHiWaterMark	(	blpapi_SessionOptions_t *	parameters,
		float	hiWaterMark
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setSlowConsumerWarningLoWaterMark	(	blpapi_SessionOptions_t *	parameters,
		float	loWaterMark
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultKeepAliveInactivityTime	(	blpapi_SessionOptions_t *	parameters,
		int	inactivityMsecs
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setDefaultKeepAliveResponseTimeout	(	blpapi_SessionOptions_t *	parameters,
		int	timeoutMsecs
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setKeepAliveEnabled	(	blpapi_SessionOptions_t *	parameters,
		int	isEnabled
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setRecordSubscriptionDataReceiveTimes	(	blpapi_SessionOptions_t *	parameters,
		int	shouldRecord
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setServiceCheckTimeout	(	blpapi_SessionOptions_t *	paramaters,
		int	timeoutMsecs
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setServiceDownloadTimeout	(	blpapi_SessionOptions_t *	paramaters,
		int	timeoutMsecs
	)

BLPAPI_EXPORT void blpapi_SessionOptions_setTlsOptions	(	blpapi_SessionOptions_t *	paramaters,
		const blpapi_TlsOptions_t *	tlsOptions
	)

BLPAPI_EXPORT int blpapi_SessionOptions_setFlushPublishedEventsTimeout	(	blpapi_SessionOptions_t *	paramaters,
		int	timeoutMsecs
	)

BLPAPI_EXPORT const char* blpapi_SessionOptions_serverHost

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT unsigned int blpapi_SessionOptions_serverPort

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_numServerAddresses

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_getServerAddress	(	blpapi_SessionOptions_t *	parameters,
		const char **	serverHost,
		unsigned short *	serverPort,
		size_t	index
	)

BLPAPI_EXPORT unsigned int blpapi_SessionOptions_connectTimeout

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT const char* blpapi_SessionOptions_defaultServices

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT const char* blpapi_SessionOptions_defaultSubscriptionService

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT const char* blpapi_SessionOptions_defaultTopicPrefix

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_allowMultipleCorrelatorsPerMsg

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_clientMode

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_maxPendingRequests

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_autoRestartOnDisconnection

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_autoRestart

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT const char* blpapi_SessionOptions_authenticationOptions

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_numStartAttempts

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT size_t blpapi_SessionOptions_maxEventQueueSize

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT float blpapi_SessionOptions_slowConsumerWarningHiWaterMark

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT float blpapi_SessionOptions_slowConsumerWarningLoWaterMark

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_defaultKeepAliveInactivityTime

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_defaultKeepAliveResponseTimeout

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_keepAliveEnabled

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_recordSubscriptionDataReceiveTimes

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_serviceCheckTimeout

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_serviceDownloadTimeout

(

blpapi_SessionOptions_t *

parameters

)

BLPAPI_EXPORT int blpapi_SessionOptions_print	(	blpapi_SessionOptions_t *	parameters,
		blpapi_StreamWriter_t	streamWriter,
		void *	stream,
		int	indentLevel,
		int	spacesPerLevel
	)

BLPAPI_EXPORT int blpapi_SessionOptions_flushPublishedEventsTimeout

(

blpapi_SessionOptions_t *

parameters

)