Acting a source of data (legacy API)

Macros
#define	PROVIDER_DENY   -1
	Return value to indicate that the callback can't satisfy this request. More...
#define	PROVIDER_OK   0
	Return value to indicate that the callback can satisfy this request - data will follow. More...

Typedefs
typedef int(*	provider_cb) (int peer, char *name, int isrequest)
	Definition of the function type used for provider callbacks. More...

Functions
void	deregister_provider (const char *pattern, provider_cb provider_fn)
	Deregisters the data provider with the Transformer core for the specified object name pattern. The data provider will no longer be informed of any requests for objects with names that match the pattern. More...
void	register_provider (const char *pattern, provider_cb provider_fn)
	Registers the specified data provider with the Transformer core for the specified object name pattern. The data provider will be informed of any requests for objects with names that match the pattern. More...

Detailed Description

The old Transformer API is still supported, but we recommend that any new development use the new provider API instead of the legacy equivalents.

Macro Definition Documentation

#define PROVIDER_DENY   -1

Return value to indicate that the callback can't satisfy this request.

Deprecated:

This is part of the legacy interface

#define PROVIDER_OK   0

Return value to indicate that the callback can satisfy this request - data will follow.

Deprecated:

This is part of the legacy interface

Typedef Documentation

typedef int(* provider_cb) (int peer, char *name, int isrequest)

Definition of the function type used for provider callbacks.

Parameters

peer	- Peer number that is making this request
name	- Object name that is being requested
isrequest	- If set then this is a request

This function should return either PROVIDER_OK or PROVIDER_DENY dependent on whether it could satisfy the request.

If isrequest is not 0 then the symbol is being requested, otherwise it is being discarded

Deprecated:

This is part of the legacy interface

Function Documentation

void deregister_provider	(	const char *	pattern,
		provider_cb	provider_fn
	)

Deregisters the data provider with the Transformer core for the specified object name pattern. The data provider will no longer be informed of any requests for objects with names that match the pattern.

Parameters

pattern	The object name pattern the provider can provide.
provider_fn	The callback to call when the specified pattern is requested by a DataSource peer

Deprecated:

The use of filename-style wildcards is being deprecated throughout the Caplin platform in favour of standard regular expressions. The replacement API fully supports regular expressions.

Note

The callbacks generated by registrations of this type on single threaded.

void register_provider	(	const char *	pattern,
		provider_cb	provider_fn
	)

Registers the specified data provider with the Transformer core for the specified object name pattern. The data provider will be informed of any requests for objects with names that match the pattern.

Parameters

pattern	The object name pattern the provider can provide.
provider_fn	The callback to call when the specified pattern is requested by a DataSource peer

Deprecated:

The use of filename-style wildcards is being deprecated throughout the Caplin platform in favour of standard regular expressions. The replacement API fully supports regular expressions.

Note

The callbacks generated by registrations of this type on single threaded.