Содержание   <<< Назад   Далее >>>

Формат главного конфигурационного файла, запуск

Главный конфигурационный файл это тот файл, который нужно указать ядру при запуске в командной строке. Если файл при запуске не указан, то по умолчанию ядро пытается загрузить настройки из файла 'etc/default.xml'. Именно поэтому обычное месторасположение этого файла - каталого etc. В стандартном случае, для запуска ядра достаточно запустить его исполняемый файл. Ядро прочитает настройки из файла 'etc/default.xml' и продолжит работу, согласно этому файлу.

Для Linux/BSD платформ есть возможность использовать знак '&' для запуска сервера в виде фонового процесса. Этот символ, нужно использовать в конце командной строки. Например: 

  $/torch/bin> ./torch ../etc/default.xml &
  
  или
  
  $/torch/bin> ./torch &
  (для стандартного случая расположения главного конфигурационного файла)

Примечание: В ядре для указания путей к файлам используются прямые слеши '/', как в Unix-подобных системах. Использовать обратные слеши '\' нельзя, т.к. это будет работать только в Windows. При необходимости переноса сервера на Unix-подобную систему, придется переписывать все "неправильные" пути.

Формат самого конфигурационного файла черезвычайно прост: 

<?xml version="1.0" encoding="UTF-8"?>
<config>
 <script id="main"><![CDATA[
 ...
 ]]></script>
</config>
Он содержит только текст скрипта на внутреннем Lua-языке ядра. Этот скрипт, в отличии от всех остальных в ядре, выполняется в своем отдельном пространстве команд. Это было сделано специально, для исключения возможных ошибок.
В это пранство команд входят следующие команды...

Пространство команд для конфигурации ядра

Данные команды используются в скрипте, который "запускает" ядро на выполнение. Список небольшой, но эти команды отвечают за все необходимые параметры для работы ядра.

bool SetWorkDir("path")
Назначение:
Устанавливает рабочий (корневой) каталог ядра. Важная функция, так как от этого корня далее будут расчитываться все остальные пути к файлам.
Параметры:
"path" (Строка) - Путь к каталогу, который должен стать корневым.
Возвращаемые значения:
true - если удачно удалось изменить корневой каталог ядра,
false - если произошла ошибка, в этом случае, текущий каталог остается без изменений.

bool LoadCodePage("codepage_name", "file")
Назначение:
Загружает кодовую страницу (кодировку) из файла, с заданным именем. Имя кодировки - это идентификатор, под которым она будет известна в ядре.
Параметры:
"codepage_name" (Строка) - Имя (идентфикатор) кодовой страницы,
"file" (Строка) - Путь к файлу, содержащему кодовую страницу.
Возвращаемые значения:
true - если удачно удалось загрузить кодовую страницу.
false - в случае ошибки. Например: нет файла, ошибка в файле, или кодовая страница с заданным идентифкатором уже загружена.

bool LoadLocale("file")
Назначение:
Загружает локализацию ядра. В файле локализации содержатся таблицы преобразования символов и системные сообщения ядра об ошибках. Без локализации ядро не сможет выводить какую-либо отладочную информацию.
Параметры:
"file" (Строка) - Путь к файлу локализации.
Возвращаемые значения:
true - в случае успеха.
false - в случае ошибки (нет файла или ошибка в файле).

bool OnConsole("codepage_name")
Назначение:
Включает вывод в консоль ядра в заданной кодировке. В этот лог попадает системная информация о функционировании ядра. требует загруженных предварительно локализации ядра и кодовой страницы.
Параметры:
"codepage_name" (Строка) - идентификатор кодовой страницы, в которой должен выводится лог в консоль ядра.
Возвращаемые значения:
true - в случае успешного включения вывода лога в консоль.
false - в случае ошибки (неправильно указан идентификатор кодовой страницы). Незагруженная локализация не влияет на возращаемое значение.

bool OnSystemlog("codepage_name", "file")
Назначение:
Включает вывод в лог-файл в заданной кодировке. В этот лог попадает системная информация о функционировании ядра. требует загруженных предварительно локализации ядра и кодовой страницы.
Параметры:
"codepage_name" (Строка) - идентификатор кодовой страницы, в которой должен сохраняться лог в файл.
"file" (Строка) - путь к файлу, в который будет сохранятся лог. Ядро при запуске не стирает этот файл, а продолжает добавлять информацию в конец файла.
Возвращаемые значения:
true - в случае успешного включения вывода лога в файл.
false - в случае ошибки (неправильно указан идентификатор кодовой страницы или имя файла). Незагруженная локализация не влияет на возращаемое значение.

bool LoadTreats("file")
Назначение:
Загружает файл со списком обработчиков, их параметрами и скриптами. О обработчиках можно почитать тут.
Параметры:
"file" (Строка) - путь к xml-файлу, в котором содержатся обработчики.
Возвращаемые значения:
true - в случае успеха.
false - в случае ошибки (нет файла или ошибка в файле).

bool OpenPort(port_number, "treat_id")
Назначение:
Открывает порт для подключения. После подключения аккаунт нового соединения будет передан обработчику : 'treat_id'
Параметры:
port_number (Число) - номер порта для подключений. Сервер будет слушать указанный порт на предмет новых соединений.
"treat_id" (Строка) - идентификатор обработчика, которому будет передано новое подключение.
Возвращаемые значения:
true - в случае успеха.
false - в случае ошибки.

bool LoadAccounts("db_id", "file")
Назначение:
Загружает список аккаунтов из указанного файла с заданным идентификатором.
Параметры:
"db_id" (Строка) - это идентификатор базы аккаунтов. Он необходим для идентификации конкретного списка аккаунтов при работе. Этот параметр нужен для возможности создания нескольких независимых баз аккаунтов (при необходимости).
"file" (Строка) - путь к файлу, в котором содержится база аккаунтов.
Возвращаемые значения:
true - в случае успеха.
false - в случае ошибки.

Содержание   <<< Назад   Далее >>>