Elements for opensubscriber.xml

Element

Description

OpenSubscriber

Root element for the configuration file.

Logger

Contains settings for logging activities

LogLevel

The level of logging. Valid values are

error: only log 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

The name and location of the log file. The file name can be relative or a full path.

TemplateDir

This is the directory where the message templates are located.

DataStreamHandlerConfig

This is the file which should be used for the data stream handler configuration.

NumPacketBuffers

This is the number of network packet buffers to create per data channel. The size of one buffer is about the size of the MTU of the network interfaces being used. A larger number of packet buffers means that a larger burst of traffic can be handled without requiring resends. This setting can have a value from 1 to 4294967296.

PacketWindowSize

This determines how many packets are tracked for resend purposes. This setting can have a value from 1 to 4294967296. The value should be 50-75% of the Publishers NumPacketBuffers.

LatencyCheckInterval

This determines how often (in seconds) the network latency between Publisher and Subscriber is checked. This setting can have a value from 1 to 65535.

FlushInterval

This indicates how long a data channel can sit idle before a check is made for dropped packets. 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.

AdminPort

This is the port number used by the UAF agent to communicate with the subscriber. The subscriber will listen for incoming administration requests on this port.

DataStreamChannelList

This is a list of data stream channels from which the subscriber will receive messages. Either all or none of the channels for a given publisher should be present. Channels from multiple publishers may be present. There can be up to 255 data stream channels.

DataStreamChannel

Contains information for one publisher data stream channel.

LocalInterface

This is the IP address of a network interface on the local machine which will receive the messages.

PublisherName

This contains a publisher name for each unique publisher. This is used to identify the publisher.

ChannelName

IPAddress

Port

The ChannelName, IPAddress and Port should have the same values as in the corresponding channel in the publisher. ChannelName is a descriptive name for the publisher data stream channel. IPAddress is the UDP multicast address used by the publishers data stream channel for sending the messages over the network. Port is the local port used by the publishers data stream channel to send messages over the network using UDP multicasting.

PublisherList

This contains one entry for each unique publisher being used by the subscriber. The list can contain publisher entries which are unused in the DataStreamChannel definitions, however this will consume resources.

Publisher

This contains information about each unique publisher being used by the subscriber.

PublisherName

This should correspond to the PublisherName used in the DataStreamChannel definitions

IPAddress

This is the IP address or host name of the machine hosting the publisher.

ResendPort

The ResendPort must have the same value as the publishers ResendPort definition in the publisher.xml.

Using the messagefilter.xml file, a subscriber can determine which messages are included or excluded. Filter rules allow exclusion of messages based on message type, or inclusion or exclusion of messages based on values within fields of the message. Only simple equality checks are performed. Exclusions based on message types are faster than checks which require field-level comparisons. The rules specified must adhere to the messagefilter.xsd schema. In a default out of the box installation, all the message types are included and no message filtering is performed.