blpapi_service.h File Reference

A service which provides access to API data (provide or consume). More...

Go to the source code of this file.

Classes
class	blpapi::Operation
class	blpapi::Service
Namespaces
namespace	blpapi
Functions
BLPAPI_EXPORT const char *	blpapi_Operation_name (blpapi_Operation_t *service)
BLPAPI_EXPORT const char *	blpapi_Operation_description (blpapi_Operation_t *service)
BLPAPI_EXPORT int	blpapi_Operation_requestDefinition (blpapi_Operation_t *service, blpapi_SchemaElementDefinition_t **requestDefinition)
BLPAPI_EXPORT int	blpapi_Operation_numResponseDefinitions (blpapi_Operation_t *service)
BLPAPI_EXPORT int	blpapi_Operation_responseDefinition (blpapi_Operation_t *service, blpapi_SchemaElementDefinition_t **responseDefinition, size_t index)
BLPAPI_EXPORT const char *	blpapi_Service_name (blpapi_Service_t *service)
BLPAPI_EXPORT const char *	blpapi_Service_description (blpapi_Service_t *service)
BLPAPI_EXPORT int	blpapi_Service_numOperations (blpapi_Service_t *service)
BLPAPI_EXPORT int	blpapi_Service_numEventDefinitions (blpapi_Service_t *service)
BLPAPI_EXPORT int	blpapi_Service_addRef (blpapi_Service_t *service)
BLPAPI_EXPORT void	blpapi_Service_release (blpapi_Service_t *service)
BLPAPI_EXPORT const char *	blpapi_Service_authorizationServiceName (blpapi_Service_t *service)
BLPAPI_EXPORT int	blpapi_Service_getOperation (blpapi_Service_t *service, blpapi_Operation_t **operation, const char *nameString, const blpapi_Name_t *name)
BLPAPI_EXPORT int	blpapi_Service_getOperationAt (blpapi_Service_t *service, blpapi_Operation_t **operation, size_t index)
BLPAPI_EXPORT int	blpapi_Service_getEventDefinition (blpapi_Service_t *service, blpapi_SchemaElementDefinition_t **result, const char *nameString, const blpapi_Name_t *name)
BLPAPI_EXPORT int	blpapi_Service_getEventDefinitionAt (blpapi_Service_t *service, blpapi_SchemaElementDefinition_t **result, size_t index)
BLPAPI_EXPORT int	blpapi_Service_createRequest (blpapi_Service_t *service, blpapi_Request_t **request, const char *operation)
BLPAPI_EXPORT int	blpapi_Service_createAuthorizationRequest (blpapi_Service_t *service, blpapi_Request_t **request, const char *operation)
BLPAPI_EXPORT int	blpapi_Service_createPublishEvent (blpapi_Service_t *service, blpapi_Event_t **event)
BLPAPI_EXPORT int	blpapi_Service_createAdminEvent (blpapi_Service_t *service, blpapi_Event_t **event)
BLPAPI_EXPORT int	blpapi_Service_createResponseEvent (blpapi_Service_t *service, const blpapi_CorrelationId_t *correlationId, blpapi_Event_t **event)
BLPAPI_EXPORT int	blpapi_Service_print (const blpapi_Service_t *service, blpapi_StreamWriter_t streamWriter, void *stream, int level, int spacesPerLevel)
std::ostream &	blpapi::operator<< (std::ostream &stream, const Service &service)

---

Detailed Description

A service which provides access to API data (provide or consume).

---

Function Documentation

BLPAPI_EXPORT const char* blpapi_Operation_name

(

blpapi_Operation_t *

service

)

BLPAPI_EXPORT const char* blpapi_Operation_description

(

blpapi_Operation_t *

service

)

BLPAPI_EXPORT int blpapi_Operation_requestDefinition	(	blpapi_Operation_t *	service,
		blpapi_SchemaElementDefinition_t **	requestDefinition
	)

BLPAPI_EXPORT int blpapi_Operation_numResponseDefinitions

(

blpapi_Operation_t *

service

)

BLPAPI_EXPORT int blpapi_Operation_responseDefinition	(	blpapi_Operation_t *	service,
		blpapi_SchemaElementDefinition_t **	responseDefinition,
		size_t	index
	)

BLPAPI_EXPORT const char* blpapi_Service_name

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT const char* blpapi_Service_description

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT int blpapi_Service_numOperations

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT int blpapi_Service_numEventDefinitions

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT int blpapi_Service_addRef

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT void blpapi_Service_release

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT const char* blpapi_Service_authorizationServiceName

(

blpapi_Service_t *

service

)

BLPAPI_EXPORT int blpapi_Service_getOperation	(	blpapi_Service_t *	service,
		blpapi_Operation_t **	operation,
		const char *	nameString,
		const blpapi_Name_t *	name
	)

BLPAPI_EXPORT int blpapi_Service_getOperationAt	(	blpapi_Service_t *	service,
		blpapi_Operation_t **	operation,
		size_t	index
	)

BLPAPI_EXPORT int blpapi_Service_getEventDefinition	(	blpapi_Service_t *	service,
		blpapi_SchemaElementDefinition_t **	result,
		const char *	nameString,
		const blpapi_Name_t *	name
	)

BLPAPI_EXPORT int blpapi_Service_getEventDefinitionAt	(	blpapi_Service_t *	service,
		blpapi_SchemaElementDefinition_t **	result,
		size_t	index
	)

BLPAPI_EXPORT int blpapi_Service_createRequest	(	blpapi_Service_t *	service,
		blpapi_Request_t **	request,
		const char *	operation
	)

BLPAPI_EXPORT int blpapi_Service_createAuthorizationRequest	(	blpapi_Service_t *	service,
		blpapi_Request_t **	request,
		const char *	operation
	)

BLPAPI_EXPORT int blpapi_Service_createPublishEvent	(	blpapi_Service_t *	service,
		blpapi_Event_t **	event
	)

BLPAPI_EXPORT int blpapi_Service_createAdminEvent	(	blpapi_Service_t *	service,
		blpapi_Event_t **	event
	)

BLPAPI_EXPORT int blpapi_Service_createResponseEvent	(	blpapi_Service_t *	service,
		const blpapi_CorrelationId_t *	correlationId,
		blpapi_Event_t **	event
	)

BLPAPI_EXPORT int blpapi_Service_print	(	const blpapi_Service_t *	service,
		blpapi_StreamWriter_t	streamWriter,
		void *	stream,
		int	level,
		int	spacesPerLevel
	)