Transformer SDK For C  6.2.11.309924
Configuration: Global

fields-file

Type: String
Default: fields.conf

The name of the configuration file containing the field definitions. This file referenced by this option will be automatically parsed, so there is no need to use the include-file directive.

event-log

Short option: -l
Type: String
Default: %a.log

The name of the main Transformer log file. This will be placed in the directory defined by log-dir.

log-level

Type: String
Default: INFO

The logging devel of the Transformer. This can take the following values (in order of decreasing severity/increasing verbosity):

  • CRIT
  • ERROR
  • NOTIFY
  • WARN
  • INFO
  • DEBUG

transformer-active

Type: Boolean
Default: FALSE

If this option is enabled then the Transformer is switched into active mode. This allows DataSource peers to request data off the Transformer.

modules-dir

Type: String
Default: %r/lib

The directory where the Transformer's modules are located. %r, %h, %a, %n and %u are expanded if encountered within this option.

modules-conf-dir

Type: String
Default: %r/etc

The directory where module configuration files are located. %r, %h, %a, %n and %u are expanded if encountered within this option.

add-module

Default: None

Specify a module to load, it takes the following format:

add-module <module name> [module type]

<module name> is the name of the module to load, this may be specified with or with out the .so suffix.

[module type] is an optional parameter which specifies the type of the module. If it non-zero then the module is treated as an API extension module.

heartbeat-symbol

Type: String
Default: None

Symbolname for the symbol heartbeat function.

heartbeat-symbol-time

Type: Floating Point Value
Default: 30.0

Time between symbol heartbeats

peerdown-time

Type: Floating Point Value
Default: 60.0

After a peer has disconnected, the Transformer must remove all subscriptions that the peer has made. In order to ensure that rapid connect-disconnect cycles do not affect any data feeds, the Transformer will not discard objects until peerdown-time seconds has elapsed. This time allows a peer time to reconnect and re-request symbols.

disable-peer-status

Type: Boolean
Default: FALSE Disable status messages following transition of peer states

shell-enable

Type: Boolean
Default: FALSE

Enable Transformer Shell.

The shell is a useful tool for debugging purposes and querying the state of objects within the Transformer in an interactive manner.

shell-interface

Type: String
Default: None

Interface to listen on for shell connections. Without this option being configured, the Transformer will listen on all available interfaces for shell connections.

shell-port

Type: Integer
Default: 16000

Port to listen on for shell connections

symboluser-hashsize

Type: Integer
Default: 63

Size of hashtable for holding the details of the functinons for the Module caching functionality functionality.

contrib-return

Type: Boolean
Default: FALSE

If the Transformer receives a contribution (i.e. data from a peer that it usually sends data to), then this option will enable the update to be returned to the peer.


Generated on Sat Aug 26 2017 12:36:32 for Transformer SDK For C