Transformer Pipeline Module API Reference  6.2.11.309924
Autopub Module: Pipeline Functions

Functions

 autopub_enable_symbol (var symbolname, var id)
 Enable publishing for a symbol. More...
 
 autopub_disable_symbol (var symbolname, var id)
 Disable publishing for a symbol. More...
 
 autopub_handle_update (var dsdata, var id)
 Pass an update directly to the autopub module. More...
 
 autopub_disable_group (var id)
 Disable publishing for a whole autopub group. More...
 
 autopub_enable_group (var id)
 Enable publishing for a whole autopub group. More...
 

Detailed Description

The autopub module if loaded exposes some methods to pipelines to enable control of symbol publishing.

Note
The methods in this package are only available if the autopub module is loaded.

Function Documentation

autopub_disable_group ( var  id)

Disable publishing for a whole autopub group.

Parameters
id- The id of the autopub group to disable
Return values
0- Success
-1- Unknown group
autopub_disable_symbol ( var  symbolname,
var  id 
)

Disable publishing for a symbol.

Parameters
symbolname- The name of the symbol to disable
id(optional) - The id of the autopub group to disable publishing of this symbol on. If not provided the symbol will not be published on all matching groups.
Return values
0- Always
Note
The supplied symbolname must exist in the autopub configuration file.

No further updates will be published for the named symbol to the peers listed in the specified group (or all matching groups).

autopub_enable_group ( var  id)

Enable publishing for a whole autopub group.

Parameters
id- The id of the autopub group to enable
Return values
0- Success
-1- Unknown group
autopub_enable_symbol ( var  symbolname,
var  id 
)

Enable publishing for a symbol.

Parameters
symbolname- The name of the symbol to enable
id(optional) - The id of the autopub group to enable publishing of this symbol on. If not provided the symbol will be published on all matching groups.
Return values
0- Always
Note
The named symbol must match a pattern or symbol defined within the autopub configuration file.

All subsequent updates for /symbolname/ will be published to the peers listed in the specified group (or all matching groups)

autopub_handle_update ( var  dsdata,
var  id 
)

Pass an update directly to the autopub module.

Parameters
dsdata- The update to pass to the autopub group
id- The id of the autopub group to pass the update to
Return values
0- always
Note
If a group matching the id does not exist, the update will not be passed to any autopub group.

Generated on Sat Aug 26 2017 12:36:33 for Transformer Pipeline Module API Reference