some autogen docs

This commit is contained in:
2025-08-14 14:07:52 +03:00
parent d95944dcfc
commit 04152f05a9
7 changed files with 261 additions and 7 deletions

View File

@@ -9,20 +9,60 @@
namespace PIHTTP {
//! ~english Immutable HTTP message container with accessors for message components
//! ~russian Контейнер для неизменяемого HTTP-сообщения с методами доступа к компонентам
class PIP_EXPORT MessageConst {
public:
//! ~english Gets the HTTP method used in the message
//! ~russian Возвращает HTTP-метод, использованный в сообщении
PIHTTP::Method method() const { return m_method; }
//! ~english Gets the HTTP status code
//! ~russian Возвращает HTTP-статус код
PIHTTP::Code code() const { return m_code; }
//! ~english Checks if status code is informational (1xx)
//! ~russian Проверяет, является ли статус код информационным (1xx)
bool isCodeInformational() const;
//! ~english Checks if status code indicates success (2xx)
//! ~russian Проверяет, указывает ли статус код на успех (2xx)
bool isCodeSuccess() const;
//! ~english Checks if status code indicates redirection (3xx)
//! ~russian Проверяет, указывает ли статус код на перенаправление (3xx)
bool isCodeRedirection() const;
//! ~english Checks if status code indicates client error (4xx)
//! ~russian Проверяет, указывает ли статус код на ошибку клиента (4xx)
bool isCodeClientError() const;
//! ~english Checks if status code indicates server error (5xx)
//! ~russian Проверяет, указывает ли статус код на ошибку сервера (5xx)
bool isCodeServerError() const;
//! ~english Checks if status code indicates any error (4xx or 5xx)
//! ~russian Проверяет, указывает ли статус код на любую ошибку (4xx или 5xx)
bool isCodeError() const { return isCodeClientError() || isCodeServerError(); }
//! ~english Gets the request/response path
//! ~russian Возвращает путь запроса/ответа
const PIString & path() const { return m_path; }
//! ~english Gets path components as list
//! ~russian Возвращает компоненты пути в виде списка
PIStringList pathList() const { return m_path.split('/').removeAll({}); }
//! ~english Gets the message body
//! ~russian Возвращает тело сообщения
const PIByteArray & body() const { return m_body; }
//! ~english Gets all message headers
//! ~russian Возвращает все заголовки сообщения
const PIMap<PIString, PIString> & headers() const { return m_headers; }
//! ~english Gets all message arguments
//! ~russian Возвращает все аргументы сообщения
const PIMap<PIString, PIString> & arguments() const { return m_arguments; }
protected:
@@ -35,25 +75,60 @@ protected:
};
//! ~english Mutable HTTP message container with modifiers for message components
//! ~russian Контейнер для изменяемого HTTP-сообщения с методами модификации
class PIP_EXPORT MessageMutable: public MessageConst {
public:
//! ~english Sets the HTTP method
//! ~russian Устанавливает HTTP-метод
MessageMutable & setMethod(PIHTTP::Method m);
//! ~english Sets the HTTP status code
//! ~russian Устанавливает HTTP-статус код
MessageMutable & setCode(PIHTTP::Code c);
//! ~english Sets the request/response path
//! ~russian Устанавливает путь запроса/ответа
MessageMutable & setPath(PIString p);
//! ~english Sets the message body
//! ~russian Устанавливает тело сообщения
MessageMutable & setBody(PIByteArray b);
const PIMap<PIString, PIString> & headers() const { return m_headers; }
const PIMap<PIString, PIString> & arguments() const { return m_arguments; }
PIMap<PIString, PIString> & headers() { return m_headers; }
//! ~english Adds a header to the message
//! ~russian Добавляет заголовок к сообщению
MessageMutable & addHeader(const PIString & header, const PIString & value);
//! ~english Removes a header from the message
//! ~russian Удаляет заголовок из сообщения
MessageMutable & removeHeader(const PIString & header);
PIMap<PIString, PIString> & arguments() { return m_arguments; }
//! ~english Adds an argument to the message
//! ~russian Добавляет аргумент к сообщению
MessageMutable & addArgument(const PIString & arg, const PIString & value);
//! ~english Removes an argument from the message
//! ~russian Удаляет аргумент из сообщения
MessageMutable & removeArgument(const PIString & arg);
//! ~english Creates message from HTTP status code
//! ~russian Создает сообщение из HTTP-статус кода
static MessageMutable fromCode(PIHTTP::Code c);
//! ~english Creates message from HTTP method
//! ~russian Создает сообщение из HTTP-метода
static MessageMutable fromMethod(PIHTTP::Method m);
};
//! ~english Gets string representation of HTTP method
//! ~russian Возвращает строковое представление HTTP-метода
PIP_EXPORT const char * methodName(Method m);