Протокол работы TCP/IP сервера ИРБИС 64 — различия между версиями

Материал из Wikipedia
Перейти к: навигация, поиск
(Новая страница: «Все функции работы с сервером ИРБИС64 имеют параметры запроса и строки ответа в последнем …»)
 
(→‎Регистрация пользователя)
Строка 15: Строка 15:
 
== Общие функции ==
 
== Общие функции ==
 
=== Регистрация пользователя ===
 
=== Регистрация пользователя ===
−
;function '''irbis_client_reg'''(
+
{| style="width:100%;background-color:gray;" cellspacing="1"
−
:aserver_host: string;
+
|- style="background-color:white;"
−
:aserver_port: string;
+
!style="width:20%;"|Объявление функции
−
:arm: char;  
+
!style="width:30%;"|Параметры
−
:user_name, password: string;
+
!style="width:30%;"|Возврат
−
:answer: TStringList
+
!style="width:20%;"|Комментарий
−
;): integer;
+
|- style="background-color:white;"
 +
|<span style="color:blue">function</span> irbis_client_reg (
 +
:aserver_host: '''string''';
 +
:aserver_port: '''string''';
 +
:arm: '''char''';  
 +
:user_name: '''string''';
 +
:password: '''string''';
 +
:answer: '''TStringList'''
 +
): integer;
 +
|'''aserver_hos'''t – адресс сервера в числовом виде (например 255.255.255.255)
  
−
ПАРАМЕТРЫ
+
'''aserver_port''' – рабочий порт сервера (6666)
 +
 
 +
'''arm''' – вид клиента
 +
:читатель (IRBIS_READER),
 +
:каталогизатор (IRBIS_CATALOG)
 +
:комплектатор (IRBIS_COMPLECT),
 +
:книговыдача (IRBIS_BOOKLAND).
 +
 
 +
'''user_name''' – имя пользователя
 +
 
 +
'''password''' – пароль пользователя
 +
|В answer в первой строке код возврата. Если код возврата равен ZERO, то следующие строки в answer - это ini-файл, определенный на сервере для данного пользователя. Если код возврата не равен ZERO - в answer только одна строка.
 
   
 
   
−
aserver_host – адресс сервера в числовом виде (например 255.255.255.255).
+
;Коды возврата:
−
aserver_port – рабочий порт сервера (6666).
+
:ZERO
−
arm – вид клиента – читатель (IRBIS_READER),
+
:CLIENT_ALREADY_EXISTS  - пользователь уже зарегистрирован.
−
каталогизатор (IRBIS_CATALOG), комплектатор (IRBIS_COMPLECT),
+
:WRONG_PASSWORD - неверный пароль.
−
книговыдача (IRBIS_BOOKLAND).
+
:CLIENT_ALREADY_EXISTS - пользователь уже зарегистрирован
−
user_name – имя пользователя.
+
|Перед началом работы с сервером ИРБИС64 требуется произвести регистрацию с помощью данной функции. В случае успешного выполнения клиент получает ini-файл с определенными параметрами, необходимыми для работы программы.
−
password – пароль пользователя.
+
|}
  
−
ВОЗВРАТ
+
=== Разрегистрация клиента (сигнал окончания работы) ===
−
 
−
В answer в первой строке код возврата.
 
−
Если код возврата равен ZERO, то следующие строки в answer - это ini-файл определенный на сервере для данного пользователя.
 
−
Если код возврата не равен ZERO - в answer только одна строка.
 
−
 
−
Коды возврата:
 
−
ZERO
 
−
CLIENT_ALREADY_EXISTS  - пользователь уже зарегистрирован.
 
−
WRONG_PASSWORD - неверный пароль.
 
−
CLIENT_ALREADY_EXISTS - пользователь уже зарегистрирован
 
−
 
−
КОММЕНТАРИЙ
 
−
 
−
Перед началом работы с сервером ИРБИС64 требуется произвести регистрацию с помощью данной функции. В случае успешного выполнения клиент получает ini-файл с определенными параметрами необходимыми для работы программы.
 

Версия 19:10, 6 февраля 2010

Все функции работы с сервером ИРБИС64 имеют параметры запроса и строки ответа в последнем параметре функции. То есть шаблон функции может быть представлен в виде: function(A1...AN; answer: TStringList) Где

Параметры
A1...AN – параметры запроса
Возврат
answer – список строк ответа, который организован таким образом, что в первой строке как правило – числовой код возврата (в строковом представлении), далее - строки результата.
Комментарий

Возврат функции может быть следующим числом:

  • mrOK – пришел ответ сервера в ожидаемом формате.
  • mrCancel – ошибка при обработке запроса – нет гарантии что ответ правильный.
  • mrNo – клиент находится в процессе обработки предыдущего запроса и не может обработать данный запрос.

Общие функции

Регистрация пользователя

Объявление функции Параметры Возврат Комментарий
function irbis_client_reg (
aserver_host: string;
aserver_port: string;
arm: char;
user_name: string;
password: string;
answer: TStringList

): integer;

aserver_host – адресс сервера в числовом виде (например 255.255.255.255)

aserver_port – рабочий порт сервера (6666)

arm – вид клиента

читатель (IRBIS_READER),
каталогизатор (IRBIS_CATALOG)
комплектатор (IRBIS_COMPLECT),
книговыдача (IRBIS_BOOKLAND).

user_name – имя пользователя

password – пароль пользователя

В answer в первой строке код возврата. Если код возврата равен ZERO, то следующие строки в answer - это ini-файл, определенный на сервере для данного пользователя. Если код возврата не равен ZERO - в answer только одна строка.
Коды возврата
ZERO
CLIENT_ALREADY_EXISTS - пользователь уже зарегистрирован.
WRONG_PASSWORD - неверный пароль.
CLIENT_ALREADY_EXISTS - пользователь уже зарегистрирован
 Перед началом работы с сервером ИРБИС64 требуется произвести регистрацию с помощью данной функции. В случае успешного выполнения клиент получает ini-файл с определенными параметрами, необходимыми для работы программы.

Разрегистрация клиента (сигнал окончания работы)

Источник — «http://wiki.elnit.org/index.php?title=Протокол_работы_TCP/IP_сервера_ИРБИС_64&oldid=485»