非同期送信キューの型定義と操作関数。 More...

#include <stddef.h>
#include <porter_const.h>
#include <porter_type.h>
#include <pthread.h>

Include dependency graph for potrSendQueue.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	PotrPayloadElem
	送信キューの 1 エントリ。ペイロードエレメント 1 個分のデータを保持する。 More...
struct	PotrSendQueue
	非同期送信キュー。 More...

Typedefs
typedef pthread_mutex_t	PotrMutex
typedef pthread_cond_t	PotrCondVar

Functions
int	potr_send_queue_init (PotrSendQueue *q, size_t depth, uint16_t max_payload)
void	potr_send_queue_destroy (PotrSendQueue *q)
int	potr_send_queue_push (PotrSendQueue q, PotrPeerId peer_id, uint16_t flags, const void payload, uint16_t payload_len)
int	potr_send_queue_push_wait (PotrSendQueue q, PotrPeerId peer_id, uint16_t flags, const void payload, uint16_t payload_len, volatile int *running)
int	potr_send_queue_pop (PotrSendQueue q, PotrPayloadElem out, volatile int *running)
int	potr_send_queue_peek (PotrSendQueue q, PotrPayloadElem out)
int	potr_send_queue_peek_timed (PotrSendQueue q, PotrPayloadElem out, uint32_t timeout_ms)
int	potr_send_queue_try_pop (PotrSendQueue q, PotrPayloadElem out)
void	potr_send_queue_complete (PotrSendQueue *q)
void	potr_send_queue_wait_drained (PotrSendQueue *q)
void	potr_send_queue_shutdown (PotrSendQueue *q)

Detailed Description

非同期送信キューの型定義と操作関数。

Author: c-modernization-kit sample team

Date: 2026/03/08

Version: 1.0.0

ノンブロッキング送信 (potrSend の flags に POTR_SEND_BLOCKING なし) で使用されるスレッドセーフな送信キューです。
ペイロードエレメントをリングバッファに積み、送信スレッドが順に sendto で送出します。
ブロッキング送信は potr_send_queue_wait_drained() で先行キューの sendto 完了を待ってから直接送信します。

Copyright: Copyright (C) CompanyName, Ltd. 2026. All rights reserved.

Definition in file potrSendQueue.h.

Typedef Documentation

◆ PotrMutex

typedef pthread_mutex_t PotrMutex

Definition at line 32 of file potrSendQueue.h.

◆ PotrCondVar

typedef pthread_cond_t PotrCondVar

Definition at line 33 of file potrSendQueue.h.

Function Documentation

◆ potr_send_queue_init()

int potr_send_queue_init	(	PotrSendQueue *	q,
		size_t	depth,
		uint16_t	max_payload )

extern

Definition at line 51 of file potrSendQueue.c.

References PotrSendQueue::depth, PotrSendQueue::drained, PotrSendQueue::entries, PotrPayloadElem::flags, PotrSendQueue::mutex, PotrSendQueue::not_empty, PotrSendQueue::not_full, PotrPayloadElem::payload, PotrPayloadElem::payload_len, PotrSendQueue::payload_pool, PotrPayloadElem::peer_id, POTR_COND_INIT, POTR_ERROR, POTR_MUTEX_INIT, POTR_PEER_NA, and POTR_SUCCESS.

Referenced by potrOpenService(), and reset_send_queue().

Here is the caller graph for this function:

◆ potr_send_queue_destroy()

void potr_send_queue_destroy ( PotrSendQueue * q )

extern

Definition at line 87 of file potrSendQueue.c.

References PotrSendQueue::drained, PotrSendQueue::entries, PotrSendQueue::mutex, PotrSendQueue::not_empty, PotrSendQueue::not_full, PotrSendQueue::payload_pool, POTR_COND_DESTROY, and POTR_MUTEX_DESTROY.

Referenced by potrCloseService(), potrOpenService(), and reset_send_queue().

Here is the caller graph for this function:

◆ potr_send_queue_push()

int potr_send_queue_push	(	PotrSendQueue *	q,
		PotrPeerId	peer_id,
		uint16_t	flags,
		const void *	payload,
		uint16_t	payload_len )

extern

Definition at line 100 of file potrSendQueue.c.

References PotrSendQueue::count, PotrSendQueue::depth, PotrSendQueue::entries, PotrPayloadElem::flags, PotrSendQueue::inflight, PotrSendQueue::mutex, PotrSendQueue::not_empty, PotrPayloadElem::payload, PotrPayloadElem::payload_len, PotrPayloadElem::peer_id, POTR_COND_SIGNAL, POTR_ERROR, POTR_MUTEX_LOCK, POTR_MUTEX_UNLOCK, POTR_SUCCESS, and PotrSendQueue::tail.

◆ potr_send_queue_push_wait()

int potr_send_queue_push_wait	(	PotrSendQueue *	q,
		PotrPeerId	peer_id,
		uint16_t	flags,
		const void *	payload,
		uint16_t	payload_len,
		volatile int *	running )