ServiceDiscovery.h File Reference

Go to the source code of this file.

Data Structures
struct	SDServiceData
struct	SDServiceDataList
struct	SDVOList
struct	SDService
struct	SDServiceList
struct	SDServiceDetails
struct	SDServiceDetailsList
struct	SDException
Functions
SDService *	SD_getService (const char serviceName, SDException exception)
SDServiceDetails *	SD_getServiceDetails (const char serviceName, SDException exception)
SDServiceDataList *	SD_getServiceData (const char serviceName, SDException exception)
char *	SD_getServiceDataItem (const char serviceName, const char key, SDException *exception)
char *	SD_getServiceSite (const char serviceName, SDException exception)
char *	SD_getServiceWSDL (const char serviceName, SDException exception)
SDServiceList *	SD_listAssociatedServices (const char serviceName, const char type, const char site, const SDVOList vos, SDException *exception)
SDServiceList *	SD_listServices (const char type, const char site, const SDVOList vos, SDException exception)
SDServiceList *	SD_listServicesByData (const SDServiceDataList data, const char type, const char site, const SDVOList vos, SDException *exception)
SDServiceList *	SD_listServicesByHost (const char type, const char host, const SDVOList vos, SDException exception)
void	SD_freeServiceDataList (SDServiceDataList *serviceDataList)
void	SD_freeService (SDService *service)
void	SD_freeServiceList (SDServiceList *serviceList)
void	SD_freeServiceDetails (SDServiceDetails *serviceDetails)
void	SD_freeException (SDException *exception)

Function Documentation

SDService* SD_getService	(	const char *	serviceName,
		SDException *	exception
	)

The SD_getService function returns basic details about the requested service.

You can dispose of any data returned by calling SD_freeService. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	exception	If not NULL, receives status of API call.

Returns:: Basic service details, or NULL if service cannot be found or if the API call fails.

SDServiceDetails* SD_getServiceDetails	(	const char *	serviceName,
		SDException *	exception
	)

The SD_getServiceDetails function returns full details about the requested service.

You can dispose of any data returned by calling SD_freeServiceDetails. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	exception	If not NULL, receives status of API call.

Returns:: Full service details, or NULL if service cannot be found or if the API call fails.

SDServiceDataList* SD_getServiceData	(	const char *	serviceName,
		SDException *	exception
	)

The SD_getServiceData function returns all service keyword/value data for the requested service.

You can dispose of any data returned by calling SD_freeServiceData. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	exception	If not NULL, receives status of API call.

Returns:: Service data list or NULL if the API call fails. Service data list will be empty if the service cannot be found, or doesn't have any keyword/value data.

char* SD_getServiceDataItem	(	const char *	serviceName,
		const char *	key,
		SDException *	exception
	)

The SD_getServiceDataItem function returns the value of the requested service parameter.

You can dispose of any data returned by calling free(). You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	key	Parameter name.
	exception	If not NULL, receives status of API call.

Returns:: Parameter value or NULL if the service cannot be found, doesn't contain the requested data, or if the API call fails.

char* SD_getServiceSite	(	const char *	serviceName,
		SDException *	exception
	)

The SD_getServiceSite function returns the name of the site where a service runs.

You can dispose of any data returned by calling free(). You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	exception	If not NULL, receives status of API call.

Returns:: Site name or NULL if the service cannot be found, or if the API call fails.

char* SD_getServiceWSDL	(	const char *	serviceName,
		SDException *	exception
	)

The SD_getServiceWSDL function returns the URL to the service WSDL (if any).

You can dispose of any data returned by calling free(). You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Unique name of service.
	exception	If not NULL, receives status of API call.

Returns:: WSDL string or NULL if the service cannot be found, is not a Web Service, or if the API call fails.

SDServiceList* SD_listAssociatedServices	(	const char *	serviceName,
		const char *	type,
		const char *	site,
		const SDVOList *	vos,
		SDException *	exception
	)

The SD_listAssociatedServices function returns a list of services that are are associated with the requested service and that match the specified type, site and VOs (services with no VO affiliation match any VO specified by the user).

You can dispose of any data returned by calling SD_freeServiceList. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	serviceName	Name of service with which others are associated.
	type	Type of services required (NULL => any).
	site	Site of services required (NULL => any).
	vos	List of VOs from which services may come (NULL => any).
	exception	If not NULL, receives status of API call.

Returns:: List of matching services or NULL if the API call fails. List will be empty if no services are found.

SDServiceList* SD_listServices	(	const char *	type,
		const char *	site,
		const SDVOList *	vos,
		SDException *	exception
	)

The SD_listServices function returns a list of services that match the specified type, site and VOs (services with no VO affiliation match any VO specified by the user).

You can dispose of any data returned by calling SD_freeServiceList. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	type	Type of services required (NULL => any).
	site	Site of services required (NULL => any).
	vos	List of VOs from which services may come (NULL => any).
	exception	If not NULL, receives status of API call.

Returns:: List of matching services or NULL if the API call fails. List will be empty if no services are found.

SDServiceList* SD_listServicesByData	(	const SDServiceDataList *	data,
		const char *	type,
		const char *	site,
		const SDVOList *	vos,
		SDException *	exception
	)

The SD_listServicesByData function returns a list of services that match the specified keyword/value data, type, site and VOs (services with no VO affiliation match any VO specified by the user).

You can dispose of any data returned by calling SD_freeServiceList. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	data	List of keyword/value data to match.
	type	Type of services required (NULL => any).
	site	Site of services required (NULL => any).
	vos	List of VOs from which services may come (NULL => any).
	exception	If not NULL, receives status of API call.

Returns:: List of matching services or NULL if the API call fails. List will be empty if no services are found.

SDServiceList* SD_listServicesByHost	(	const char *	type,
		const char *	host,
		const SDVOList *	vos,
		SDException *	exception
	)

The SD_listServicesByHost function returns a list of services that match the specified type, the given host and port and VOs (services with no VO affiliation match any VO specified by the user).

The host:port is looked up in the service endpoint and a string match is applied in the query (this is more efficient than performing this search on the client side)

You can dispose of any data returned by calling SD_freeServiceList. You can dispose of exception data (on failure) by calling SD_freeException.

Parameters:

	type	Type of services required (NULL => any).
	host	Host name of services required (NULL => any).
	vos	List of VOs from which services may come (NULL => any).
	exception	If not NULL, receives status of API call.

Returns:: List of matching services or NULL if the API call fails. List will be empty if no services are found.

void SD_freeServiceDataList ( SDServiceDataList * serviceDataList )

Frees all memory associated with an SDServiceDataList structure.

Parameters:

serviceDataList