Document of c-modernization-kit (porter) 1.0.0

Loading...
Searching...
No Matches
Macros
上限値・デフォルト値

## Macros
#define | POTR_MAX_ADDR_LEN 64U
| アドレス文字列の最大長 (バイト、終端 NUL を含む)。
#define | POTR_MAX_PAYLOAD 65507U
| ペイロードの最大長 (バイト)。UDP 最大ペイロード (65535 - IP20 - UDP8)。max_payload 設定値のバリデーション上限として使用する。
#define | POTR_MAX_WINDOW_SIZE 256U
| ウィンドウサイズの最大値 (パケット数)。window_size 設定値のバリデーション上限として使用する。
#define | POTR_MAX_SERVICES 64U
| config_list_service_ids() の初期バッファ容量。サービス数がこれを超えた場合は realloc で自動拡張する。
#define | POTR_MAX_MESSAGE_SIZE 65535U
| 1 回の potrSend で送信できる最大メッセージ長 (バイト) のデフォルト値。設定ファイルの max_message_size で変更可能。フラグメント化により max_payload を超えるメッセージも送受信できる。
#define | POTR_SEND_QUEUE_DEPTH 1024U
| 非同期送信キューの最大エントリ数のデフォルト値。設定ファイルの send_queue_depth で変更可能。メッセージがフラグメント化される場合、1 メッセージが複数エントリを占有する。
#define | POTR_PAYLOAD_ELEM_HDR_SIZE 6U
| パックコンテナ内ペイロードエレメントのヘッダーサイズ (バイト)。flags (2): POTR_FLAG_MORE_FRAG / POTR_FLAG_COMPRESSED を格納 + payload_len (4): uint32_t (NBO)。通番は外側パケットで管理するためペイロードエレメントには含まない。
#define | POTR_MAX_PATH 4U
| マルチパスの最大パス数。

## Detailed Description

## Macro Definition Documentation

## ◆ POTR_MAX_ADDR_LEN

#define POTR_MAX_ADDR_LEN 64U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

アドレス文字列の最大長 (バイト、終端 NUL を含む)。

Definition at line 93 of file porter_const.h.

Referenced by apply_service_kv().

## ◆ POTR_MAX_PAYLOAD

#define POTR_MAX_PAYLOAD 65507U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

ペイロードの最大長 (バイト)。UDP 最大ペイロード (65535 - IP20 - UDP8)。max_payload 設定値のバリデーション上限として使用する。

Definition at line 94 of file porter_const.h.

Referenced by on_recv(), on_recv(), packet_build_packed(), packet_parse(), packet_unpack_next(), and potrOpenService().

## ◆ POTR_MAX_WINDOW_SIZE

#define POTR_MAX_WINDOW_SIZE 256U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

ウィンドウサイズの最大値 (パケット数)。window_size 設定値のバリデーション上限として使用する。

Definition at line 95 of file porter_const.h.

Referenced by potrOpenService().

## ◆ POTR_MAX_SERVICES

#define POTR_MAX_SERVICES 64U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

config_list_service_ids() の初期バッファ容量。サービス数がこれを超えた場合は realloc で自動拡張する。

Definition at line 96 of file porter_const.h.

Referenced by config_list_service_ids().

## ◆ POTR_MAX_MESSAGE_SIZE

#define POTR_MAX_MESSAGE_SIZE 65535U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

1 回の potrSend で送信できる最大メッセージ長 (バイト) のデフォルト値。設定ファイルの max_message_size で変更可能。フラグメント化により max_payload を超えるメッセージも送受信できる。

Definition at line 97 of file porter_const.h.

Referenced by bidir_send_thread_func(), and config_load_global().

## ◆ POTR_SEND_QUEUE_DEPTH

#define POTR_SEND_QUEUE_DEPTH 1024U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

非同期送信キューの最大エントリ数のデフォルト値。設定ファイルの send_queue_depth で変更可能。メッセージがフラグメント化される場合、1 メッセージが複数エントリを占有する。

Definition at line 98 of file porter_const.h.

Referenced by config_load_global().

## ◆ POTR_PAYLOAD_ELEM_HDR_SIZE

#define POTR_PAYLOAD_ELEM_HDR_SIZE 6U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

パックコンテナ内ペイロードエレメントのヘッダーサイズ (バイト)。flags (2): POTR_FLAG_MORE_FRAG / POTR_FLAG_COMPRESSED を格納 + payload_len (4): uint32_t (NBO)。通番は外側パケットで管理するためペイロードエレメントには含まない。

Definition at line 99 of file porter_const.h.

Referenced by packet_unpack_next(), send_packed_peer_mode(), send_thread_func(), and send_to_peer().

## ◆ POTR_MAX_PATH

#define POTR_MAX_PATH 4U

`#include </__w/c-modernization-kit/c-modernization-kit/prod/porter/include/porter_const.h>`

マルチパスの最大パス数。

Definition at line 100 of file porter_const.h.

Referenced by cleanup_sockets(), ctx_cleanup(), flush_packed_peer(), health_thread_func(), n1_check_health_timeout(), n1_send_nack(), n1_send_ping_reply(), n1_send_reject(), peer_send_fin(), potrCloseService(), potrOpenService(), and recv_thread_func().