Help: File Formats
This document provides help for the file formats of the files necessary to operate TelliCast Client.
These files may be written and adapted to a particular situation using any standard editor. The format is similar to the Windows
ini-file format. Details are given in the examples linked to this page.
For most entries there are default values so that the corresponding entries / sections can be left out.
For this entries the default value is given with the description of the entry. If there is no default value given,then the entry is
mandatory and an error message will be generated when it is missing.
Content
Please note:
- In the following the format for directories is given as used in Unix, i. e. directories separated with slashes
(home/directory/file).
When the Server is run on a Windows system, the slashes have to be replaced with backslashes (home\directory\file).
- Words that have to be entered into files are quoted here in quotation marks for a better
distinction from the text. Nevertheless the words have to be written into the files without the quotation marks.
- Pointed brackets in the description of the file entries signify that the words written in the pointed
brackets are not the entry itself but a description of the entry. When making the entry,
exchange the description for the desired value without writing the pointed brackets.
E. g. "<port number>" may result in an entry like "9201".
|
This file contains the central client configuration settings.
It should be placed within the tc-cast-client working directory (unless specified otherwise using the tc-cast-client command line options).
Parameter index of file cast-client.ini
[config_version]
version
[recipient]
user_name
user_key
user_key_crypt
user_name_prefix
[shell]
login
allowed_address
port
interface_address
refresh
graphic_port
[watchdog]
activate
alive_check_interval
restart_time
max_memory_usage
max_cpu_usage
max_cpu_usage_period
max_nr_of_core_files
error_script
error_script_cause_announcement
[mail]
mail_server_address
sender_address
default_feedback_mail_recipient
[logging]
log_level
log_file_size
log_file_number
max_shift_interval
shift_time
[locations]
file_database_directory
channels_file
log_file
license_file
[announcement_channel]
address
name
[parameters]
interface_address
tmp_directory
tmp_prefix
tmp_suffix
total_bandwidth
acknowledgement_proxy_address
packet_naks
allow_execute
file_database_size
file_delivery_counter
file_delivery_speed
set_systemtime
set_systemtime_diff
|
[config_version]
|
file:
cast-client.ini
|
|
|
|
version
|
section:
[config_version]
|
file:
cast-client.ini
|
|
The version of the configuration file
|
|
syntax:
|
example:
version=2.8
|
|
|
|
unit:
n/a
range:
n/a
default:
version=2.9
|
this parameter is
 optional
 mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[recipient]
|
file:
cast-client.ini
|
|
The section [recipient] specifies the recipient. The entries have to be identical with the entries in the Recipient File(s) (*.rcv) of the Server.
|
|
|
user_name
|
section:
[recipient]
|
file:
cast-client.ini
|
|
Recipient name as unique! ascii string.
|
|
syntax:
user_name=<string>
|
example:
user_name=miller
|
|
Name of the recipient as unique ASCII string.
The "user_name" may be up to 50 characters long and may contain any of the following characters: lower case letters, capital letters, numbers, hyphen, underscore and "@".
Please note that the user_name specification is case-insensitive and therefore e. g. the user names "miller" and "Miller" are regarded as identical.
This entry has to be identical to the "user_name" specified in a Recipient File at the Server if the entry "use_name_prefix" is not used in this section. Otherwise, the "user_name" at the Recipient File of the Server has to be the sum of "user_name_prefix" and "user_name".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - user_name_prefix
tc-cast-server - *.rcv - [recipient] - user_name
tc-cast-server - *.cha - [recipients] - user_name
tc-cast-server - *.job/*.str/*.crw/*.enf/*.nss - [recipients] - user_name
tc-cast-server - *.job/*.str/*.crw/*.enf/*.nss - [additional_recipients] - user_name
|
|
|
user_key
|
section:
[recipient]
|
file:
cast-client.ini
|
|
Secret recipient key used to direct encrpyted transmissions to this recipient.
|
|
syntax:
user_key=<string>
|
example:
user_key=topsecret
|
|
Specifies the key of the recipient. This key is used for encrypted transmissions. It will be used to decrypt the distributed data key. The "user_key" has to be identical with the "user_key" used at Server side.
This entry will be ignored if an entry "user_key_crypt" is specified in this section.
The "user_key" may be up to 20 characters long and may contain any of the following characters: lower case letters, capital letters, numbers, hyphen, underscore and "@".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - *.rcv - [recipient] - user_key
tc-cast-client - cast-client.ini - [recipient] - user_key_crypt
tc-cast-server - *.cha - [channel] - encryption
|
|
|
user_key_crypt
|
section:
[recipient]
|
file:
cast-client.ini
|
|
Encrypted user_key (e.g. using tc-keys).
|
|
syntax:
user_key_crypt=<encrypted key>
|
example:
|
|
When using TelliNet Authentication the user can choose the option "Save password" on the login interface. The password will then be encrypted and stored in the Client Configuration File with the entry "user_key_crypt". The next time the user is logging in, a password is not required, because the password specified with the entry "user_key_crypt" is used.
The "user_key_crypt" can also be entered manually (for TelliCast / TelliVision and TelliNet). Please use the tool "tc-keys" to manually transform a plain user key into the crypted user key. The crypted used key is a scrambled variant of the plain "user_key".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - *.rcv - [recipient] - user_key_crypt
tc-cast-client - cast-client.ini - [recipient] - user_key
tc-cast-server - *.cha - [channel] - encryption
|
|
|
user_name_prefix
|
section:
[recipient]
|
file:
cast-client.ini
|
|
Allows you to add a fixed prefix to the user_name given in cast-client.ini.
|
|
syntax:
user_name_prefix=<string>
|
example:
user_name_prefix=provider_
|
|
User name prefix of the recipient as ASCII string. If you want to make sure that, independent of the user name, typed into the login form and invisible to the user, the user name always starts with a fixed prefix (e.g. company_), you can set "user_name_prefix". The resulting user name (used within the software and within the Server Recipient Files) is always the sum of "user_name_prefix" and "user_name".
The "user_name_prefix" may be up to 50 characters long and may contain any of the following characters: lower case letters, capital letters, numbers, hyphen, underscore and "@".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [recipient] - user_name
tc-cast-server - *.rcv - [recipient] - user_name
|
|
|
[shell]
|
file:
cast-client.ini
|
|
This section allows to configure the program internal web interface.
This web interface (which is normally used by the operators only) can be accessed locally or remotely using normal web browsers like e. g. the MS Internet Explorer or Netscape Navigator).
|
|
|
login
|
section:
[shell]
|
file:
cast-client.ini
|
|
Password protection of the web interface.
|
|
syntax:
login=<name>:<password>
login=none
|
example:
login=miller:mysecret
login=none
|
|
Specifies a login for the web interface. This includes a username and a password and has to be written as: "<name>:<password>". To disable the username, password protection, "login=none" has to be configured. If no parameter "login" is given, the access to the web interface is not possible.
|
|
unit:
n/a
range:
n/a
default:
no login allowed and web interface is deactivated
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [shell] - allowed_address
|
|
|
allowed_address
|
section:
[shell]
|
file:
cast-client.ini
|
|
Allows connections to the web interface only from the hosts listed (e.g. localhost). By default access is permitted for all hosts, but login restrictions according to the login parameter apply.
|
|
syntax:
allowed_address=<IP address>
allowed_address=<DNS name>
|
example:
allowed_address=127.0.0.1
allowed_address=serverhost
|
|
Specifies the IP address or DNS name of a host that is allowed to connect to the web interface port of the Client and open the web interface. The entry can be given multiple times to allow more than one host to connect to the web interface of the Client.
If "127.0.0.1" is entered, access is allowed from all available local interfaces.
|
|
unit:
n/a
range:
n/a
default:
access is permitted for all hosts
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [shell] - login
|
|
|
port
|
section:
[shell]
|
file:
cast-client.ini
|
|
port of web interface e.g. URL:http://localhost:8100
|
|
syntax:
port=<port>
|
example:
port=8100
|
|
The port to be used for the web interface (default: 2517).
|
|
unit:
n/a
range:
n/a
default:
8100
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [shell] - interface_address
|
|
|
interface_address
|
section:
[shell]
|
file:
cast-client.ini
|
|
IP address of the interface to that the web interface port is bound to.
|
|
syntax:
interface_address=<interface name>
interface_address=<IP address>
interface_address=<DNS name>
|
example:
interface_address=eth1
interface_address=172.27.1.2
interface_address=control.company.com
|
|
In case the host is equipped with more than one interface, this entry can be used to bind the web interface to a specific network interface only.
Please note that the use of "localhost:<port>" instead of "<IP address >:<port>" in the browser is not possible to access the web interface locally when the entry "interface_address" is specifying the IP address of the local host. Instead, "localhost" or "127.0.0.1" has to be entered as interface_address to use "localhost:<port>" as address of the web interface.
Please note: Specification of the interface name as interface_address is only possible under Linux operating systems.
|
|
unit:
n/a
range:
n/a
default:
bound to all local network interfaces
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [shell] - port
|
|
|
refresh
|
section:
[shell]
|
file:
cast-client.ini
|
|
Time interval for automatic refreshes within various web pages of the web interface.
|
|
syntax:
refresh=<seconds>
|
example:
refresh=5
|
|
Specifies the time interval between automatic refreshes within various web pages of the web interface.
|
|
unit:
seconds
range:
n/a
default:
5
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
graphic_port
|
section:
[shell]
|
file:
cast-client.ini
|
|
Port used for the web interface "bandwidth" java applet.
|
|
syntax:
graphic_port=<port>
|
example:
graphic_port=8105
graphic_port=0 (for an ephemeral port)
|
|
The web interface contains graphics giving an overview of the currently used bandwidth for TelliNet / TelliCast / TelliVision. The Client uses the port configured here to communicate the bandwidth values for the graphics to the web interface (default: a port is chosen randomly).
|
|
unit:
n/a
range:
n/a
default:
8105
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[watchdog]
|
file:
cast-client.ini
|
|
This section specifies the parameters of a built-in process of TelliNet / TelliCast / TelliVision that keeps the overall performance of the Client under surveillance.
|
|
activate
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Activates or deactivates the program internal watchdog.
|
|
syntax:
activate=<value of range>
|
example:
activate=1
|
|
Possible entries are:
1 = the watchdog is activated.
0 = the watchdog is not activated.
|
|
unit:
n/a
range:
0/1
default:
1=on
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - cast-server.ini - [watchdog]
|
|
|
alive_check_interval
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
The "working" process has to send an alive message to the watchdog process in the specified interval.
|
|
syntax:
alive_check_interval=<seconds>
|
example:
alive_check_interval=40
|
|
The "working" process has to send an alive message to the watchdog process in the given interval (of minimum 30 seconds). If the alive message is not received for multiple intervals, the "working" process is restarted.
|
|
unit:
seconds
range:
30 or more
default:
30 seconds
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
|
|
|
restart_time
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Force a restart at given times.
|
|
syntax:
restart_time=<hh:mm>
restart_time=<hh:mm ddd>
|
example:
restart_time=05:15
restart_time=00:00 Sun
|
|
The watchdog can be configured to restart the "working" process at a given time of each day or of a specific day per week.
This entry specifies the UTC time of the day when the"working" process is restarted in the format "<hh:mm>" (hour:minute) or "<hh:mm ddd>" (hour:minute day). The day has to be given as the first three letters of the english name of the day, e. g. "Mon" for Monday or "Thu" for Thursday.
If only the time is specified, the process is restarted every day.
The entry can be given multiple times, i. e. it is possible to restart the process several times during one day.
|
|
unit:
n/a
range:
n/a
default:
no forced restart
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
|
|
|
max_memory_usage
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Maximum amount of memory the "working" process is allowed to allocate.
|
|
syntax:
max_memory_usage=<byte>
|
example:
max_memory_usage=300000000
|
|
Maximum amount of memory the process is allowed to allocate. Allocation of more memory is considered a program bug and the "working" process is restarted.
|
|
unit:
byte
range:
n/a
default:
300000000 = 300 MByte
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
|
|
|
max_cpu_usage
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Maximum percent of CPU the "working" process is allowed to use over a period of time (see max_cpu_usage_period).
|
|
syntax:
max_cpu_usage=<value of range>
|
example:
max_cpu_usage=75
|
|
In case the CPU usage exceeds the given amount for a period of approximately "max_cpu_usage_period" the process is restarted.
Please note that it is not possible to check cpu usage when using WIN9x operating systems due to restrictions in these operating systems. Therefore this parameter is ignored under WIN9x operating systems.
|
|
unit:
percent
range:
1-100
default:
90%
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
tc-cast-client - cast-client.ini - [watchdog] - max_cpu_usage_period
|
|
|
max_cpu_usage_period
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Calculation period for max_cpu_usage.
|
|
syntax:
max_cpu_usage_period=<seconds>
|
example:
max_cpu_usage_period=120
|
|
In case the CPU usage exceeds the amount given with "max_cpu_usage" for the configured period, the process is restarted by the internal watchdog.
Please note that it is not possible to check cpu usage when using WIN9x operating systems due to restrictions in these operating systems. Therefore this parameter is ignored under WIN9x operating systems.
|
|
unit:
seconds
range:
n/a
default:
120
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
tc-cast-client - cast-client.ini - [watchdog] - max_cpu_usage
|
|
|
max_nr_of_core_files
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Under Unix like operating systems the watchdog will archive the given number of possibly existing core files.
|
|
syntax:
max_nr_of_core_files=<number>
|
example:
max_nr_of_core_files=10
|
|
This parameter restricts the storage of possibly existing core files on Unix like operating systems. If the number of core files exceeds the configured number, the oldest stored core file is deleted each time a new core file is stored.
Whenever a core file is generated, the current log file is stored under the name "<log file name>.tc-cast-server.<timestamp>" and a new log file is opened. "timestamp" is the UTC date and time when the core file and the log file have been stored.
|
|
unit:
n/a
range:
n/a
default:
10
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - activate
|
|
|
error_script
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
Defines the path/filename (relative to the active working directory) of a shell script to be executed after the local client detected a certain error condition).
|
|
syntax:
error_script=<name of script including path>
|
example:
error_script=./error.sh
|
|
This shell script might be useful to try working arround error causes that are external to the local client (e.g. restarting a satellite reception driver or restarting the complete host).
Please note: The script will be executed with the following parameters:
<cause> <duration>
<cause> may be one of the following:
0=TelliCast: no announcement channel reception
<duration> is the approx. duration in seconds since when the error condition is already active.
If no path is specified for the error_script and no matching file is found in the active working directory, the Client will try to execute an executable according to the PATH environment variable.
|
|
unit:
n/a
range:
n/a
default:
none
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - error_script_cause_announcement
|
|
|
error_script_cause_announcement
|
section:
[watchdog]
|
file:
cast-client.ini
|
|
For TelliCast usage only. If activated, the TelliCast Client will call the configured error_script in the corresponding interval while there is no announcement channel reception.
|
|
syntax:
error_script_cause_announcement=<seconds>
|
example:
error_script_cause_announcement=30
|
|
|
|
unit:
seconds
range:
n/a
default:
0=deactivated
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [watchdog] - error_script
|
|
[mail]
|
file:
cast-client.ini
|
|
The [mail] section can be used to send a mail to the operator / support in case the administrator needs help with the system (feedback mail). To use the feedback mail it is sufficient to specify the "mail_server_address". The section can only be given once.
|
|
|
mail_server_address
|
section:
[mail]
|
file:
cast-client.ini
|
|
SMTP server for automatic and feedback mail.
|
|
syntax:
mail_server_address=<IP address>
mail_server_address=<DNS name>
mail_server_address=<IP address>:<port>
mail_server_address=<DNS name>:<port>
|
example:
mail_server_address=172.33.33.33
mail_server_address=mail.company.com
mail_server_address=172.33.33.33:1200
mail_server_address=mail.company.com:1200
|
|
Address of the mail server that is used as SMTP-Server for outgoing mails. This entry is necessary to activate the functionality of both feedback mail and runtime error mail.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [mail] - sender_address
tc-cast-client - cast-client.ini - [mail] - runtime_error_mail_recipient
|
|
|
sender_address
|
section:
[mail]
|
file:
cast-client.ini
|
|
Default originator shown in feedback mail.
|
|
syntax:
sender_address=<e-mail address>
|
example:
sender_address=user@company.com
|
|
E-mail address of the sender of "feedback mail".
It is not possible to specify more than one sender e-mail address or more than one section
[mail], i. e. the entry can not be given multiple times.
The entry is optional, as the sender e-mail address can also
be specified directly in the feedback mail form of the web interface. The sender e-mail address
specified here is given as default value in the respective field of the form.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [mail] - mail_server_address
|
|
|
default_feedback_mail_recipient
|
section:
[mail]
|
file:
cast-client.ini
|
|
Default recipient for feedback mail.
|
|
syntax:
default_feedback_mail_recipient=<e-mail address>
|
example:
default_feedback_mail_recipient=support@company.com
|
|
Destination email address of the recipient of the "feedback mail", which allows to communicate e. g. some comments / problem descriptions to the operator / technical support of the software via a form in the web interface.
The entry can be repeated if more than one person should be notified.
Recipients can also be specified directly in the feedback mail form of the web interface. The recipients specified here are given as default values in the respective field of the form.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [mail] - mail_server_address
|
|
|
[logging]
|
file:
cast-client.ini
|
|
The section [logging] can be used to fine tune the log output.
|
|
log_level
|
section:
[logging]
|
file:
cast-client.ini
|
|
none
|
|
syntax:
log_level=<value of range>
|
example:
log_level=normal
|
|
Specifies the extent of logged debugging output. Possible values are:
none = no debugging output
quiet = only error and warning messages are logged
normal = error and warning messages and information about important system functions are logged
verbose = error and warning messages and detailed information about the behaviour of the program are logged
|
|
unit:
n/a
range:
none, quiet, normal, verbose
default:
normal
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
log_file_size
|
section:
[logging]
|
file:
cast-client.ini
|
|
maximum size of single log file in bytes
|
|
syntax:
log_file_size=<bytes>
|
example:
log_file_size=1000000
|
|
Specifies the maximum size of the log file in bytes. When the log file gets larger than "log_file_size", it is stored as "<log_file>.1", a new log file is created for new logging and all previous log files are shifted: the old "<log_file>.1" is renamed to "<log_file>.2" etc.
|
|
unit:
byte
range:
n/a
default:
1000000 = 1 MByte
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [logging] - log_file_number
|
|
|
log_file_number
|
section:
[logging]
|
file:
cast-client.ini
|
|
maximum overall number of logfiles (actual+old)
|
|
syntax:
log_file_number=<number of files>
|
example:
log_file_number=4
|
|
Specifies the number of log files to store. Each time a log file is shifted (shifting described with entry for "log_file_size"), it is stored with a higher number. When the new name will be "<log_file>.<log_file_number>", the file is removed.
|
|
unit:
n/a
range:
n/a
default:
4
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [logging] - log_file_size
|
|
|
max_shift_interval
|
section:
[logging]
|
file:
cast-client.ini
|
|
The maximum time in minutes between shifting of the file.
|
|
syntax:
max_shift_time=<minutes>
|
example:
max_shift_time=1440
|
|
Specifies the maximum output is written to a file before rotation. When the given time is exceeded since the last rotation, the file is rotated.
|
|
unit:
minute
range:
n/a
default:
0
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
logging|shift_time
|
|
|
shift_time
|
section:
[logging]
|
file:
cast-client.ini
|
|
Fixed time to shift the related file.
|
|
syntax:
shift_time=<hour>:<minute>
|
example:
shift_time=4:30
|
|
Define a time at which the related file will be shifted. Providing this parameter switches nameing of the saved files from numbering to time-stamping (<file>.2009-02-11-12-22-00.<extension>).
After rotation, a maximum of max_file_number files is kept.
Additional rotations may occur
- if the file size exceeds log_file_size, or
- if the last rotation was more than max_shift_interval minutes ago.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
logging|log_file_size
logging|max_shift_interval
logging|max_file_number
|
|
|
[locations]
|
file:
cast-client.ini
|
|
The section [locations] tells the Client where to find the files and directories it needs for its configuration. There are default values for all entries and thus the whole section or some entries may be left out. All locations are relative to the working directory of the Client.
|
|
|
file_database_directory
|
section:
[locations]
|
file:
cast-client.ini
|
|
TelliCast only (all modules). Temporary directory to store partially received data.
|
|
syntax:
file_database_directory=<directory name>
|
example:
file_database_directory=receiving/tmp
|
|
The directory for caching data fragments. The path is relative to the working directory of the Client. If set to "<memory>", the file database will be stored in the RAM instead being written to the local file system (in this case the needed RAM size is reserved after the start-up of the application).
|
|
unit:
n/a
range:
n/a
default:
receiving/tmp
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
channels_file
|
section:
[locations]
|
file:
cast-client.ini
|
|
TelliCast and TelliVision: Receiver channel subcription file
|
|
syntax:
channels_file=<file name>
|
example:
channels_file=cast-client-channels.ini
|
|
Specifies the Client Channel File containing the parameters for the reception of the TelliCast data channels.
|
|
unit:
n/a
range:
n/a
default:
cast-client-channels.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
log_file
|
section:
[locations]
|
file:
cast-client.ini
|
|
Location/name of log file for status/error output.
|
|
syntax:
log_file=<file name>
log_file=<directory>/<file name>
log_file=|syslog
log_file=<memory>
|
example:
log_file=cast-client.log
log_file=../logging/receiving/cast-client.log
log_file=|syslog
log_file=<memory>
|
|
The log file that is created automatically at startup to write information about the system behaviour into it during operation.
On Linux operating systems the log messages can also be redirected to the local syslog daemon. In this case please specify "log_file=|syslog".
To write log messages to the memory of the local host instead of storing it into a log file please specify "log_file=<memory>" (in this case the variable do not have to be exchanged by the according value but has to be written as a variable in pointed brackets). If log messages are written into the memory, they can only be read from the program internal web interface.
|
|
unit:
n/a
range:
n/a
default:
cast-client.log
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [logging]
|
|
|
license_file
|
section:
[locations]
|
file:
cast-client.ini
|
|
Client License File
|
|
syntax:
license_file=<file name>
license_file=<directory>/<file name>
|
example:
license_file=license.ini
license_file=../administration/license.ini
|
|
The name of the license file containing the product license including the path th that file (absolute or relative to the working directory).
|
|
unit:
n/a
range:
n/a
default:
license.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[announcement_channel]
|
file:
cast-client.ini
|
|
The announcement channel is constantly received by the Client to get the invitations for reception and the data keys in case of encrypted data transmissions. The name and parameters of the announcement channel have to be the same as used in the Server.
|
|
address
|
section:
[announcement_channel]
|
file:
cast-client.ini
|
|
IP multicast address:port for the announcement channel
|
|
syntax:
address=<address>
address=<address>:<port>
address=:<port>
|
example:
address=229.1.1.1:10120
|
|
Specifies the multicast address and port to be used for the announcements.
|
|
unit:
n/a
range:
n/a
default:
229.1.1.1:10120
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - cast-server.ini - [announcement_channel] - address
|
|
name
|
section:
[announcement_channel]
|
file:
cast-client.ini
|
|
name of the announcement channel (additional distinction beside the IP multicast address)
|
|
syntax:
name=<string>
|
example:
name=TSL Announcement Channel
|
|
|
|
unit:
n/a
range:
n/a
default:
TSL Announcement Channel
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - cast-server.ini - [announcement_channel] - name
|
|
[parameters]
|
file:
cast-client.ini
|
|
The section [parameters] contains general configuration parameters for TelliCast functionality.
|
|
interface_address
|
section:
[parameters]
|
file:
cast-client.ini
|
|
local interface to receive multicast data.
|
|
syntax:
interface_address=<address>
|
example:
interface_address=172.27.1.51
|
|
Address of the interface that is used to receive multicast data packets with TelliCast.
Please note that this parameter has to be specified when using some DVB card types.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
tmp_directory
|
section:
[parameters]
|
file:
cast-client.ini
|
|
If this parameter is given tc-cast-client will internally store/compose all received files within the given directory and later move them to the target directory.
|
|
syntax:
tmp_directory=<directory>
|
example:
tmp_directory=receiving/tmp/files
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still not complete. To avoid that, the files can be stored in a temporary directory. After the files are completely available, they are moved to the target directory.
The value given here is the default value for all received channels. You may overwrite this default setting using the per channel "tmp_directory" entry within cast-client-channels.ini.
Please note: alternatively, the parameters "tmp_prefix" or "tmp_suffix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_directory
tc-cast-client - cast-client.ini - [parameters] - tmp_prefix
tc-cast-client - cast-client.ini - [parameters] - tmp_suffix
|
|
|
tmp_prefix
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Like tmp_directory, but files are composed within the final target directories but stored with the given prefix in front of the normal filenames until the files are fully written.
|
|
syntax:
tmp_prefix=<file name start>
|
example:
tmp_prefix=.
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still not complete. To avoid that a prefix can be specified for the files. When a file is moved to the target directory, it is stored under the file name plus the prefix. The prefix is deleted by the Client as soon as the storing of the file is completed. This mechanism allows the user to see from the name of the files in the target directory whether the files are complete.
The value given here is the default value for all received channels. You may overwrite this default setting using the per channel "tmp_prefix" entry within cast-client-channels.ini.
Please note: alternatively, the parameters "tmp_directory" or "tmp_suffix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_prefix
tc-cast-client - cast-client.ini - [parameters] - tmp_directory
tc-cast-client - cast-client.ini - [parameters] - tmp_suffix
|
|
|
tmp_suffix
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Like tmp_prefix, but adding a suffix to the normal filenames until the files are fully written.
|
|
syntax:
tmp_suffix=<file suffix>
|
example:
tmp_suffix=.tmp
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still not complete. To avoid that a suffix can be specified for the files. When a file is moved to the target directory, it is stored under the file name plus the suffix. The suffix is deleted by the Client as soon as the storing of the file is completed. This mechanism allows the user to see from the name of the files in the target directory whether the files are complete.
The value given here is the default value for all received channels. You may overwrite this default setting using the per channel "tmp_suffix" entry within cast-client-channels.ini.
Please note: alternatively, the parameters "tmp_directory" or "tmp_prefix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_suffix
tc-cast-client - cast-client.ini - [parameters] - tmp_prefix
tc-cast-client - cast-client.ini - [parameters] - tmp_directory
|
|
|
total_bandwidth
|
section:
[parameters]
|
file:
cast-client.ini
|
|
maximum bandwidth this receiver is expected to be able to receive simultaneously.
|
|
syntax:
total_bandwidth=<bits>
|
example:
total_bandwidth=10000000
|
|
This entry specifies the maximum allowed bandwidth for multicast reception with TelliCast.
The client will only subscribe to channels until "total_bandwidth" is reached.
Please note that you can assign a priority to each channel in the Client Channel File "cast-client-channels.ini". In case that "total_bandwidth" is reached, channels with lower priority will be blocked in order to join transmissions on channels with higher priority.
|
|
unit:
bits/s
range:
n/a
default:
100000000 = 100 Mbit/s
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel name>] - priority
|
|
|
acknowledgement_proxy_address
|
section:
[parameters]
|
file:
cast-client.ini
|
|
to send acknowledgement indirectly via an HTTP proxy (IP:port)
|
|
syntax:
acknowledgement_proxy_address=<address>:<port>
|
example:
acknowledgement_proxy_address=172.27.1.2:80
|
|
Address and port number of the caching web porxy host that will be used to send acknowledgements in case that the acknowledgements should pass a proxy. This entry is necessary if proxy utilisation is required for internet access.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - *.job/*.crw - [scheduling] - request_acknowledgements
|
|
|
packet_naks
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Activates packet based multicast retransmission at transport layel (MTP/SO).
|
|
syntax:
packet_naks=<value of range>
|
example:
packet_naks=1
|
|
Specifies whether NAKs are sent to the TelliCast Server at the transport layer (MTP/SO) in case that single packets of a transmission are missing. Possible entries are:
0 = no NAKs are sent.
1 = NAKs are sent via UDP unicast.
2 = NAKs are sent via UDP multicast.
Please note that at the Server the entry "allow_packet_naks" has to be activated for the corresponding channel as well (Channel File *.cha; section [channel]).
|
|
unit:
n/a
range:
0/1/2
default:
0=off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - *.cha - [channel] - allow_packet_naks
tc-cast-server - *.rcv - [recipient] - receive_only
|
|
|
allow_execute
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Allows sender to automatically execute received files on this client.
|
|
syntax:
allow_execute=<value of range>
|
example:
allow_execute=1
|
|
This entry determines, whether the automatic execution of files on the Client host after reception is accepted. Possible entries are:
1 = execution is accepted,
0 = execution is refused, i. e. executable files are only stored in the target directory without being executed
When Clients are configured to refuse the execution, they will receive the executable files, but the files are not executed automatically.
This value can be overwritten for individual channels in the cast-client-channels.ini file.
|
|
unit:
n/a
range:
0/1
default:
0 = not allowed
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel name>] - allow_execute
tc-cast-server - *.job - [execute]
|
|
|
file_database_size
|
section:
[parameters]
|
file:
cast-client.ini
|
|
maximum size of temporary fragment storage within the client file system.
|
|
syntax:
file_database_size=<bytes>
|
example:
file_database_size=262144000
|
|
Specifies the maximum size of the TelliCast directory for caching data fragments. The location of the directory is specified in the section [locations] with the entry "file_database_directory".
|
|
unit:
bytes
range:
n/a
default:
262144000 = 250 MByte
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [locations] - file_database_directory
|
|
|
file_delivery_counter
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Defines the maximum number of received files that will be delivered to the target directories per second (if temporary directories are used, the number of files written into the temporary directories is limited).
|
|
syntax:
file_delivery_counter=<value of range>
|
example:
file_delivery_counter=50
|
|
Please note: The configured limitation can be used in combination with the file_delivery_speed parameter and applies globally to all delivered files (as sum for all TelliCast channels).
Please note: It is highly recommended to limit the file delivery in order to control the interference with data reception and CPU utilization.
|
|
unit:
n/a
range:
0-1000; 0=unlimited
default:
25 = max. 25 files per second
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - file_delivery_speed
tc-cast-server - *.cha - [channel] - file_sending_counter
|
|
|
file_delivery_speed
|
section:
[parameters]
|
file:
cast-client.ini
|
|
Defines the maximum speed (bit/s) with which of received files will be delivered to the target directories (if temporary directories are used, the speed for writing into the temporary directories is limited).
|
|
syntax:
file_delivery_speed=<value of range>
|
example:
file_delivery_speed=20000000
|
|
Please note: The configured limitation can be used in combination with the file_delivery_counter parameter and applies globally to all delivered files (as sum for all TelliCast channels).
Please note: It is highly recommended to limit the file delivery in order to control the interference with data reception and CPU utilization.
|
|
unit:
bit/s
range:
0-200000000; 0=unlimited
default:
10000000 = max. 10 mbit/s per second
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - file_delivery_counter
tc-cast-server - *.cha - [channel] - file_sending_counter
|
|
|
set_systemtime
|
section:
[parameters]
|
file:
cast-client.ini
|
|
if activated, the TelliCast Client will try to regularly set the local system time according to a time signal received from the TelliCast server (subject to sufficient operating system user account rights).
|
|
syntax:
set_systemtime=<value of range>
|
example:
set_systemtime=1
|
|
|
|
unit:
boolean
range:
0/1
default:
0=off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
set_systemtime_diff
|
section:
[parameters]
|
file:
cast-client.ini
|
|
If set_systemtime is activated, the local TelliCast Client will add the configured time difference (ms) to the time signal received from the TelliCast server (e.g. to optimize the accuracy of the received time signals to a more or less static satellite transmission delay).
|
|
syntax:
set_systemtime_diff=<value of range>
|
example:
set_systemtime_diff=1500
|
|
|
|
unit:
ms
range:
0-86.400.000 = 1 day
default:
0 ms
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - set_systemtime
|
|
This file contains the product license. It has to be located in the working directory of the Client program and has to be named as specified in the Client Configuration File, section [locations], with the entry license_file (default: license.ini). A product license is necessary for the program to run.
Parameter index of file license.ini
[config_version]
version
[license]
license_class
expiry_date
oem_license
restriction
product_license
operating_system
max_bandwidth_mc
http_skin
min_version
max_version
license_id
license_signature
[license_parameters]
description
license_server_proxy
[activations]
|
[config_version]
|
file:
license.ini
|
|
|
|
version
|
section:
[config_version]
|
file:
license.ini
|
|
The version of the configuration file
|
|
syntax:
|
example:
version=2.8
|
|
|
|
unit:
n/a
range:
n/a
default:
version=2.9
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[license]
|
file:
license.ini
|
|
The license section is necessary for the program to run. It contains the license key and information about the validity of the license. It has to be entered in exactly the same way (including the order of the lines) as it is given by the distributor.
|
|
license_class
|
section:
[license]
|
file:
license.ini
|
|
The license class of the product.
|
|
syntax:
license_class=<license classification>
|
example:
license_class=Evaluation Copy
|
|
This entry gives a classification for the license, e. g. whether it is a commercial copy or an evaluation license.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
expiry_date
|
section:
[license]
|
file:
license.ini
|
|
The date at which the license is expired.
|
|
syntax:
expiry_date=<yyyy.mm.dd>
|
example:
expiry_date=2004.10.01
|
|
An expiry date is only given when the license has a time limit (e. g. for evaluation licenses). The format of the time is "year.month.day".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
oem_license
|
section:
[license]
|
file:
license.ini
|
|
Informs, whether the license is an oem license (product can be used as integrated part of other products).
|
|
syntax:
oem_license=<company name>
oem_license=none
|
example:
oem_license=MyCompany
oem_license=none
|
|
The name of the company is specified here when the license is an oem license. Otherwise the entry is "none".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
restriction
|
section:
[license]
|
file:
license.ini
|
|
Any restrictions for the license.
|
|
syntax:
restriction=<text>
|
example:
restriction=valid in conjunction with service or evaluation agreement only!
|
|
This entry specifies the restrictions for the use of the software with this license (e. g. that it can only be used for evaluation purposes).
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
product_license
|
section:
[license]
|
file:
license.ini
|
|
Specifies a module that can be used with the given license.
|
|
syntax:
product_license=Client/<module>
|
example:
product_license=Client/TelliNet
|
|
A module is not necessarily the whole software but each part/functionality of the software that can be licensed separately is called module. If the license is valid for more than one module, the entry is repeated for each module.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
operating_system
|
section:
[license]
|
file:
license.ini
|
|
Specifies the operating system and processor necessary to run the version valid with the given license key.
|
|
syntax:
operating_system=Client/<OS>
|
example:
operating_system=Client/Windows
|
|
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
max_bandwidth_mc
|
section:
[license]
|
file:
license.ini
|
|
Maximum allowed overall bandwidth for TelliCast and TelliVision (for all channels).
|
|
syntax:
max_bandwidth_mc=<bandwidth>
|
example:
max_bandwidth_mc=1000000
|
|
|
|
unit:
bits/second
range:
n/a
default:
unlimited
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
http_skin
|
section:
[license]
|
file:
license.ini
|
|
Corporate design of the web interface.
|
|
syntax:
http_skin=<company name>
|
example:
http_skin=CustomerCompany
|
|
The web interface design can be adapted to the corporate design of the customer (by including customer logo, colors etc.). These changes in the web interface skin can only be made by the software producer on request of the customer. This entry specifies the company design that will be displayed for the web interface of the licensed product.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
min_version
|
section:
[license]
|
file:
license.ini
|
|
Oldest version of the software that can be used with this license file.
|
|
syntax:
min_version=<version number>
|
example:
min_version=2.3.0
|
|
The license is valid for a range of versions of the software. This value gives the lower boundary of the range of versions that can be used with this license.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - license.ini - [license] - max_version
|
|
|
max_version
|
section:
[license]
|
file:
license.ini
|
|
Newest version of the software that can be used with this license file.
|
|
syntax:
max_version=<version number>
|
example:
max_version=2.8
|
|
The license is valid for a range of versions of the software. This value gives the upper boundary of the range of versions that can be used with this license.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - license.ini - [license] - min_version
|
|
license_id
|
section:
[license]
|
file:
license.ini
|
|
The license key as given by the distributor.
|
|
syntax:
|
example:
|
|
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
license_signature
|
section:
[license]
|
file:
license.ini
|
|
The license signature as given by the distributor.
|
|
syntax:
|
example:
|
|
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[license_parameters]
|
file:
license.ini
|
|
Parameters for the license files which are not included in the license signature.
|
|
description
|
section:
[license_parameters]
|
file:
license.ini
|
|
A text giving any description or comments.
|
|
syntax:
description=<text>
|
example:
description=License purchased for test in customer environments.
|
|
This section is optional. It will not be given by the distributor but can be entered by the operator of the Server according to his demands. Any text can be entered without effect on the validity of the license.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
license_server_proxy
|
section:
[license_parameters]
|
file:
license.ini
|
|
HTTP proxy to use for license checks using a license server.
|
|
syntax:
license_server_proxy=<IP address>
license_server_proxy=<DNS name>
license_server_proxy=<IP address>:<port>
license_server_proxy=<DNS name>:<port>
|
example:
license_server_proxy=172.27.1.1:8080
|
|
|
|
unit:
n/a
range:
n/a
default:
license_server_proxy=no proxy
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
This file contains the channel specific configurations. It has to be located in the working directory of the Client program and has to be named as specified in the Client Configuration File, section [locations], with the entry channels_file (default: cast-client-channels.ini). This file is optional.
Parameter index of file cast-client-channels.ini
[config_version]
version
[channel]
name
priority
target_directory
activate_ftp_forwarding
allow_execute
tmp_directory
tmp_prefix
tmp_suffix
stream_protocol
stream_address
stream_interface
allowed_address
stream_ttl
stream_buffer
|
[config_version]
|
file:
cast-client-channels.ini
|
|
|
|
version
|
section:
[config_version]
|
file:
cast-client-channels.ini
|
|
The version of the configuration file
|
|
syntax:
|
example:
version=2.8
|
|
|
|
unit:
n/a
range:
n/a
default:
version=2.9
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
[channel]
|
file:
cast-client-channels.ini
|
|
The section [channel] describes one channel to be received. If more than one channel should be received, the section has to be repeated for each channel.
If no such section is found then all channels to which the Client is invited will be received.
|
|
name
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
The name describes the channel to be received.
|
|
syntax:
|
example:
name=*
|
|
An asterisk (*) can be used as wildcard at the end of the channel name. E. g. the channels 'de.test.company.data', 'de.test.company.content' and 'de.test.company.more' can be received with the channel name "de.test.company.*". All channels are received if the name is "*".
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
priority
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Priority of this channel/channel group reception in case the reception would cause reception bandwidth sum to exceed "cast-client.ini [parameters] total_bandwidth".
0=highest; 1000=lowest
|
|
syntax:
priority=<value of range>
|
example:
priority=500
|
|
Specifies the priority of the channel. When the bandwidth of all incoming transmissions exceeds the maximum bandwidth configured in the cast-client.ini file (i. e. it is not possible to receive all incoming data), transmissions on the channels with the highest priorities are received.
"0" is the maximum priority, "1000" is the minimum priority.
|
|
unit:
n/a
range:
0-1000
default:
500
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
target_directory
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Directory for received files. The target_directory name is relative to the current working directory.
|
|
syntax:
target_directory=<directory>
|
example:
target_directory=received
|
|
All incoming files transmitted on this channel are stored under the directory specified with this entry.
|
|
unit:
n/a
range:
n/a
default:
received
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
activate_ftp_forwarding
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Will activate FTP forwarding for the correctly received files according to the cast-client.ini [ftp_forwarding] parameters.
|
|
syntax:
activate_ftp_forwarding=<value of range>
|
example:
activate_ftp_forwarding=1
|
|
This entry specifies, whether the correctly received files are stored on the local host or forwarded to an FTP server. Possible entries are:
0 = The files are stored on the local host in the directory specified with the entry "target_directory" in this section.
1 = The files are forwarded to the FTP server specified in the section [ftp_forwarding] of the cast-client.ini file. The directory name for the directory to store the correctly received files specified with the entry "target_directory" in this section is also used on the FTP server.
|
|
unit:
n/a
range:
0/1
default:
0 = off
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [ftp_forwarding] - ftp_server_address
tc-cast-client - cast-client-channels.ini - [<channel name>] - target_directory
|
|
|
allow_execute
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Enables/disables execution of programs/scripts after job reception if specified within the server job file.
|
|
syntax:
allow_execute=<value of range>
|
example:
allow_execute=1
|
|
This entry determines, whether the automatic execution of files on the Client host after reception is accepted. Possible entries are: BR>"1" execution is accepted, and\nwith the entry of "0" execution is refused, i. e. executable files are only stored in the incoming directory without being executed.
|
|
unit:
n/a
range:
0/1
default:
0=not allowed, but default value may be redefined in cast-client.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
tmp_directory
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
If this parameter is given tc-cast-client will internally store/compose all received files within the given directory and later move them to the target directory.
|
|
syntax:
tmp_directory=<directory>
|
example:
tmp_directory=receiving/tmp/files
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still nincomplete. To avoid that, the files can be stored in a temporary directory during the storing process. After the files are completely available, they are moved to the target directory.
This value overwrites the default value for all received channels given in the Client Configuration File cast-client.ini in the section [parameters].
Please note: alternatively, the parameters "tmp_prefix" or "tmp_suffix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off, but default value may be redefined in cast-client.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - tmp_directory
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_prefix
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_suffix
|
|
|
tmp_prefix
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Like tmp_directory, but files are composed within the final target directories but stored with the given prefix in front of the normal filenames until the files are fully written.
|
|
syntax:
tmp_prefix=<file name start>
|
example:
tmp_prefix=.
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still not complete. To avoid that a prefix can be specified for the files. When a file is moved to the target directory, it is stored under the file name plus the prefix. The prefix is deleted by the Client as soon as the storing of the file is completed. This mechanism allows the user to see from the name of the files in the target directory whether the files are complete.
This value overwrites the default value for all received channels that is set with the entry "tmp_prefix" in the client Configuration File cast-client.ini in the section [parameters].
Please note: alternatively, the parameters "tmp_directory" or "tmp_suffix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off, but default value may be redefined in cast-client.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - tmp_prefix
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_directory
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_suffix
|
|
|
tmp_suffix
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
Like tmp_prefix, but adding a suffix to the normal filenames until the files are fully written.
|
|
syntax:
tmp_suffix=<file suffix>
|
example:
tmp_suffix=.tmp
|
|
The delivery of big files from the Client cache database directly to the target directory needs time and therefore may cause problems because the user may open the files while the storing process is still not complete. To avoid that a suffix can be specified for the files. When a file is moved to the target directory, it is stored under the file name plus the suffix. The suffix is deleted by the Client as soon as the storing of the file is completed. This mechanism allows the user to see from the name of the files in the target directory whether the files are complete.
This value overwrites the default value for all received channels set in the Client Configuration File cast-client.ini in the section [parameters].
Please note: alternatively, the parameters "tmp_directory" or "tmp_prefix" can be used to avoid the utilization of still incomplete files. Please do not set more than one of the parameters "tmp_directory", "tmp_prefix" and "tmp_suffix".
|
|
unit:
n/a
range:
n/a
default:
undefined=off, but default value may be redefined in cast-client.ini
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client.ini - [parameters] - tmp_suffix
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_directory
tc-cast-client - cast-client-channels.ini - [<channel name>] - tmp_prefix
|
|
|
stream_protocol
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
for DataStreams channels only: protocol used to further distribute the data stream by the receiver
|
|
syntax:
stream_protocol=<value of range>
|
example:
stream_protocol=tcp
|
|
|
|
unit:
n/a
range:
udp, tcp, file
default:
destination_protocol specified in the Job File at the Server
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
stream_address
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
For DataStreams channels only: target IP address and port or filename to further distribute the data stream by the receiver.
When using UDP a multicast IP address may be given.
|
|
syntax:
stream_address=<address>:<port>
stream_address=<port>
|
example:
stream_address=172.27.1.51:9999
|
|
Specifies the final destination of the data stream.
The Server is transmitting the incoming data stream to the Clients. The Clients further distribute the streams to the recipients.
The address is dependent on the mode of transmission used:
If the "destination_protocol" used is TCP, it is not allowed to specify an address. Only a port has to be specified. Client applications can connect to the port to receive the data stream.
If the "stream_protocol" is UDP and multicast distribution is used, a multicast address and a port have to be specified (default: source_address of the Server Job File).
If the "stream_protocol" is UDP and unicast transmission is used, the address or name of the recipient host and the port used have to be specified (default: localhost).
If the "stream_protocol" is file, a file name has to be specified.
|
|
unit:
n/a
range:
n/a
default:
n/a
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-server - *.str - [stream] - destination_address
|
|
|
stream_interface
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
For DataStreams channels only: source interface to further distribute the data stream by the receiver.
|
|
syntax:
stream_interface=<address>
|
example:
stream_interface=172.27.1.51
|
|
|
|
unit:
n/a
range:
n/a
default:
automatically chosen interface
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - stream_address
tc-cast-client - cast-client-channels.ini - stream_protocol
|
|
|
allowed_address
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
for DataStreams channels only: Allow connections to the TCP stream port only from the hosts listed (e.g. localhost).
|
|
syntax:
allowed_address=<address>
allowed_address=<DNS-Name>
|
example:
allowed_address=172.27.1.51
|
|
This parameter does only apply to streams provided via TCP.
|
|
unit:
n/a
range:
n/a
default:
access is permitted for all hosts
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
tc-cast-client - cast-client-channels.ini - [<channel_name>] - stream_protocol
tc-cast-client - cast-client-channels.ini - [<channel name>] - steam_address
|
|
|
stream_ttl
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
For DataStreams channels only: only relevant when locally sending via multicast TTL used in stream packets generated to further distribute the data stream by the receiver.
|
|
syntax:
destination_ttl=<value of range>
|
example:
destination_ttl=1
|
|
Range of multicast distribution. This entry specifies the maximum number of routers that a multicast packet can pass between the Client and the recipient.
|
|
unit:
n/a
range:
0-255
default:
stream_ttl in the Job File at the Server
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|
|
|
stream_buffer
|
section:
[channel]
|
file:
cast-client-channels.ini
|
|
For DataStreams channels only: defines how much data will be stored for this channel within the tc-cast-client in case that it can not immediately be distributed by the TelliCast client.
|
|
syntax:
stream_buffer=<bytes>
|
example:
stream_buffer=5000
|
|
Defines how much data will be stored for this channel within the Server in case that the data can not immediately be distributed to the TelliCast Clients.
Please configure a small buffer space when using low bit-rate channels that should rather discard data instead of waiting to deliver all data completely.
|
|
unit:
bytes
range:
1600-1000000
default:
100000 = 100 kByte
|
this parameter is
optional
mandatory
repeatable
|
read by system
at startup only
continuously
on re-config signal
|
|
related entries:
|