Publisher API XML Element Descriptions

Use the publisher.xml file to configure the publisher API.

Warning! Shut down the publisher API before modifying any of its configuration elements.

Configurable elements of publisher.xml
Element	Description
Publisher	Root element for the configuration file.
Logger	Contains settings for logging activities.
LogLevel	The level of logging. Valid values are: - Error: log only errors. - Warning: log warnings in addition to errors. - Info: log informational messages in addition to messages logged at the warning level. - Debug: log debugging messages in addition to messages logged at the info level.
LogFile	Name and location of the log file. The file name can be relative or a full path.
NumMessageBuffers	Number of message buffers. One message buffer is required for each message that is being simultaneously built. This setting can have a value from 1 -- 65535, although the machine must have enough memory to hold the number of buffers specified.
NumPacketBuffers	Maximum number of packets to cache to satisfy requests by a subscriber to resend a packet. The number of packets is cached per data stream channel. The setting can have a value from 1 -- 4294967296, although the machine must have enough memory to hold the number of packets specified. The number of buffers is allocated on initialization of the publisher.
MessageFlushInterval	Interval, in seconds, during which a partially filled message buffer must be idle before being sent on the network. This setting can have a value from 1 to 65535.
LatencyCheckInterval	Number of seconds after which to do a latency check on a message. This setting can have a value from 1 to 65535.
AdminChannel	Information about the administration channel. This channel accepts requests for version information, statistics, and shutdown.
LocalInterface	Local interface that the publisher uses to monitor administrative requests.
AdminPort	Port number used by the UAF agent to communicate with the publisher. The publisher listens for incoming administration requests on this port.
MaxConnections	Determines the number of concurrent connections to the AdminChannel. Defaults to 10. Value must be in the range of 1 to 65535.
ResendChannel	Information about the resend channel. This channel listens for connections from subscribers, who open connections to publishers and issue requests to resend packets.
ResendPort	Port number used by subscribers to request resends of dropped network packets, and to time network latency between publisher and subscriber.
TimeToLive	The limit on the number of routing devices a message may pass through before expiring.
DataStreamChannelList	A list of data stream channel definitions. There can be up to 255 data stream channels.
DataStreamChannel	Contains information for one data stream channel. Each message sent by the publisher is sent in a network packet buffer over one of the defined channels. The publisher attempts to balance sending over all the channels while the system is under load.
ChannelName	Descriptive name for the channel, which is used to identify the channel when logging.
LocalInterface	IP address of a network interface on the local machine, which should be used for sending data.
IPAddress	UDP multicast address for sending the messages over the network.
Port	Port over which messages are sent using UDP multicasting.