Astra Linux Directory Client Core API  1.7.0
Интерфейс RPC администрирования (IALDRpcWrapper)

Группы

 C интерфейс взаимодействия с RPC сервером (ald-cclient.h)
 
 Вспомогательные типы и функции RPC (ALDRpcUtils.h)
 
 Идентификаторы команд RPC интерфейса (rpc-definitions.h)
 

Файлы

файл  ald-rpc.h
 

Классы

struct  ald_rpc_header
 
struct  ALD::ald_rpc_request
 
class  ALD::IALDRpcConnection
 
class  ALD::IALDRpcWrapper
 

Макросы

#define ALDRPCSERVICE   "aldd"
 
#define ALDRPCMAGIC   "ALDRPC01"
 
#define ALDRPCVERSION   100
 
#define ALD_RPC_ITF_NAME   "ald-rpc"
 

Определения типов

typedef shared_ptr< IALDRpcConnectionALD::CALDRpcConnPtr
 
typedef shared_ptr< IALDRpcWrapperALD::CALDRpcWrapperPtr
 

Перечисления

enum  ALD::alRPCStatus { alrsINI, alrsOK, alrsWAIT, alrsERR }
 

Функции

bool ALD::ald_rpc_request::good () const
 
void ALD::ald_rpc_request::addArg (const string &arg, const string &val)
 
void ALD::ald_rpc_request::addRes (const string &res, const string &val)
 
void ALD::ald_rpc_request::setError (const string &err)
 
string ALD::ald_rpc_request::argByName (const string &key)
 
string ALD::ald_rpc_request::resByName (const string &key)
 
bool ALD::ald_rpc_request::argExists (const string &key)
 
bool ALD::ald_rpc_request::resExists (const string &key)
 
void ALD::ald_rpc_request::clear ()
 
virtual ALDAuthType ALD::IALDRpcConnection::AuthType ()=0
 
virtual int ALD::IALDRpcConnection::getTimeout () const =0
 
virtual void ALD::IALDRpcConnection::setTimeout (int timeout)=0
 
virtual bool ALD::IALDRpcConnection::Connect (const string &server, ALDAuthType at)=0
 
virtual bool ALD::IALDRpcConnection::IsConnected ()=0
 
virtual void ALD::IALDRpcConnection::Disconnect ()=0
 
virtual void ALD::IALDRpcConnection::Call (ald_rpc_request &req)=0
 
virtual alRPCStatus ALD::IALDRpcConnection::CallEx (ald_rpc_request &req)=0
 
virtual ALD::IALDRpcConnection::~IALDRpcConnection ()
 
 ALD::IALDRpcWrapper::IALDRpcWrapper (IALDCore &Core)
 
virtual size_t ALD::IALDRpcWrapper::SendBroadcastMessage (const string &msg, ald_string_list *responses, int timeout=3)=0
 
virtual CALDRpcConnPtr ALD::IALDRpcWrapper::getConnection ()=0
 

Переменные

const size_t ALD::ALDRPCHDRSIZE = sizeof(ald_rpc_header)
 
ald_rpc_header ALD::ald_rpc_request::header
 
string ALD::ald_rpc_request::name
 
ald_string_multimap ALD::ald_rpc_request::args
 
ald_string_multimap ALD::ald_rpc_request::result
 
alRPCStatus ALD::ald_rpc_request::status
 
string ALD::ald_rpc_request::error
 

Подробное описание

RPC интерфейс Astra Linux Directory.

Макросы

◆ ALD_RPC_ITF_NAME

#define ALD_RPC_ITF_NAME   "ald-rpc"

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Имя RPC интерфейса

◆ ALDRPCMAGIC

#define ALDRPCMAGIC   "ALDRPC01"

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Сигнатура (ALDRPCMAGIC)

◆ ALDRPCSERVICE

#define ALDRPCSERVICE   "aldd"

◆ ALDRPCVERSION

#define ALDRPCVERSION   100

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Версия (ALDRPCVERSION)

Типы

◆ CALDRpcConnPtr

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Разделяемый указатель на интерфейс RPC соединения с сервером

◆ CALDRpcWrapperPtr

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Разделяемый указатель на интерфейс RPC взаимодействия с сервером IALDRpcWrapper

Перечисления

◆ alRPCStatus

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Статус состояния RPC запроса

Функции

◆ addArg()

void ALD::ald_rpc_request::addArg ( const string &  arg,
const string &  val 
)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Установка аргумента

Аргументы
[in]argИмя аргумента
[in]valЗначение

◆ addRes()

void ALD::ald_rpc_request::addRes ( const string &  res,
const string &  val 
)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Установка результата

Аргументы
[in]resИмя результата
[in]valЗначение

◆ argByName()

string ALD::ald_rpc_request::argByName ( const string &  key)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Получение значения аргумента по имени (при отсутствии - пустая строка)

◆ argExists()

bool ALD::ald_rpc_request::argExists ( const string &  key)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Проверка существования аргумента по имени

◆ AuthType()

virtual ALDAuthType ALD::IALDRpcConnection::AuthType ( )
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Текущий способ аутентификации

◆ Call()

virtual void ALD::IALDRpcConnection::Call ( ald_rpc_request req)
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Выполнение RPC запроса к серверу ALD

◆ CallEx()

virtual alRPCStatus ALD::IALDRpcConnection::CallEx ( ald_rpc_request req)
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Выполнение RPC запроса к серверу ALD с получением кода возврата

◆ clear()

void ALD::ald_rpc_request::clear ( )
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Очистка таблиц аргументов и результатов

◆ Connect()

virtual bool ALD::IALDRpcConnection::Connect ( const string &  server,
ALDAuthType  at 
)
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Установка соединения

Аргументы
[in]serverFQDN адрес сервера ALD
[in]atСпособ аутентификации ALDAuthType
Возвращает
Успешность выполнения операции

◆ Disconnect()

virtual void ALD::IALDRpcConnection::Disconnect ( )
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Завершение соединения с сервером

◆ getConnection()

virtual CALDRpcConnPtr ALD::IALDRpcWrapper::getConnection ( )
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Создание экземпляра RPC соединения с сервером ALD CALDRpcConnPtr

◆ getTimeout()

virtual int ALD::IALDRpcConnection::getTimeout ( ) const
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Текущее значение таймаута

◆ good()

bool ALD::ald_rpc_request::good ( ) const
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Проверка успешного статуса запроса

◆ IALDRpcWrapper()

ALD::IALDRpcWrapper::IALDRpcWrapper ( IALDCore Core)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Конструктор

◆ IsConnected()

virtual bool ALD::IALDRpcConnection::IsConnected ( )
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Проверка установлено ли соединение

◆ resByName()

string ALD::ald_rpc_request::resByName ( const string &  key)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Получение значения результата по имени (при отсутствии - пустая строка)

◆ resExists()

bool ALD::ald_rpc_request::resExists ( const string &  key)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Проверка существования результата по имени

◆ SendBroadcastMessage()

virtual size_t ALD::IALDRpcWrapper::SendBroadcastMessage ( const string &  msg,
ald_string_list responses,
int  timeout = 3 
)
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Отправка широковещательного сообщения msg

◆ setError()

void ALD::ald_rpc_request::setError ( const string &  err)
inline

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Установка ошибки

◆ setTimeout()

virtual void ALD::IALDRpcConnection::setTimeout ( int  timeout)
pure virtual

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Установка значения таймаута

◆ ~IALDRpcConnection()

virtual ALD::IALDRpcConnection::~IALDRpcConnection ( )
inlinevirtual

Переменные

◆ ALDRPCHDRSIZE

const size_t ALD::ALDRPCHDRSIZE = sizeof(ald_rpc_header)

#include </opt/astra-11.10/ald/ald-1.7.80/src/include/ald-rpc.h>

Константа размера заголовка RPC запроса

◆ args

ald_string_multimap ALD::ald_rpc_request::args

Таблица аргументов

◆ error

string ALD::ald_rpc_request::error

Сообщение об ошибке

◆ header

ald_rpc_header ALD::ald_rpc_request::header

Заголовок RPC запроса

◆ name

string ALD::ald_rpc_request::name

Имя команды

◆ result

ald_string_multimap ALD::ald_rpc_request::result

Таблица результатов

◆ status

alRPCStatus ALD::ald_rpc_request::status

Статус запроса