osmo_io_fd Struct Reference

#include <osmo_io_internal.h>

Data Structures
struct	[struct].msgb_alloc
struct	[struct].tx_queue
union	[union].u

Data Fields
struct llist_head	list
	linked list for internal management
int	fd
	actual operating-system level file decriptor
enum osmo_io_fd_mode	mode
	type of read/write mode to use
uint32_t	flags
	flags to guard closing/freeing of iofd
char *	name
	human-readable name to associte with fd
struct osmo_io_ops	io_ops
	send/recv (msg) callback functions
struct msgb *	pending
	Pending msgb to keep partial data during segmentation.
void *	data
	data pointer passed through to call-back function
unsigned int	priv_nr
	private number, extending data
size_t	cmsg_size
	size of iofd_msghdr.cmsg[] when allocated in recvmsg path
uint8_t	io_read_buffers
	maximum number of message-buffers per read operation
uint8_t	io_write_buffers
	maximum number of message-buffers per write operation
struct	msgb_alloc
struct	tx_queue
union	u

Field Documentation

cmsg_size

size_t osmo_io_fd::cmsg_size

size of iofd_msghdr.cmsg[] when allocated in recvmsg path

Referenced by iofd_poll_ofd_cb_recvmsg_sendmsg(), and osmo_iofd_set_cmsg_size().

data

void* osmo_io_fd::data

data pointer passed through to call-back function

Referenced by osmo_iofd_get_data(), osmo_iofd_set_data(), and osmo_iofd_setup().

fd

int osmo_io_fd::fd

actual operating-system level file decriptor

Referenced by _log_target_file_setup_iofd(), iofd_poll_register(), log_target_file_get_nonblock(), log_target_file_set_nonblock(), osmo_iofd_close(), osmo_iofd_get_fd(), osmo_iofd_register(), and osmo_iofd_setup().

flags

uint32_t osmo_io_fd::flags

flags to guard closing/freeing of iofd

io_ops

struct osmo_io_ops osmo_io_fd::io_ops

send/recv (msg) callback functions

Referenced by _call_read_cb(), iofd_handle_recv(), iofd_handle_segmentation(), iofd_poll_ofd_cb_recvmsg_sendmsg(), iofd_send_completion_cb(), osmo_iofd_get_ioops(), osmo_iofd_register(), osmo_iofd_set_ioops(), and osmo_iofd_setup().

io_read_buffers

uint8_t osmo_io_fd::io_read_buffers

maximum number of message-buffers per read operation

Referenced by iofd_msghdr_alloc(), osmo_iofd_set_io_buffers(), and osmo_iofd_setup().

io_write_buffers

uint8_t osmo_io_fd::io_write_buffers

maximum number of message-buffers per write operation

Referenced by iofd_txqueue_dequeue(), osmo_iofd_set_io_buffers(), osmo_iofd_setup(), and osmo_iofd_write_msgb().

list

struct llist_head osmo_io_fd::list

linked list for internal management

mode

enum osmo_io_fd_mode osmo_io_fd::mode

type of read/write mode to use

Referenced by iofd_handle_recv(), iofd_handle_segmented_read(), iofd_poll_ofd_cb_recvmsg_sendmsg(), osmo_iofd_notify_connected(), osmo_iofd_register(), osmo_iofd_sendmsg_msgb(), osmo_iofd_sendto_msgb(), osmo_iofd_set_cmsg_size(), osmo_iofd_set_io_buffers(), osmo_iofd_set_ioops(), osmo_iofd_set_sqes(), osmo_iofd_setup(), and osmo_iofd_write_msgb().

msgb_alloc

struct osmo_io_fd::[struct].msgb_alloc osmo_io_fd::msgb_alloc

Referenced by _call_read_cb(), iofd_handle_recv(), iofd_handle_segmented_read(), iofd_msgb_alloc(), iofd_msgb_alloc2(), iofd_msgb_length_max(), osmo_iofd_set_alloc_info(), and osmo_iofd_setup().

name

char* osmo_io_fd::name

human-readable name to associte with fd

Referenced by osmo_iofd_get_name(), osmo_iofd_set_name(), osmo_iofd_set_name_f(), and osmo_iofd_setup().

pending

struct msgb* osmo_io_fd::pending

Pending msgb to keep partial data during segmentation.

Referenced by iofd_handle_segmented_read(), iofd_prepare_handle_segmentation(), osmo_iofd_close(), and osmo_iofd_setup().

priv_nr

unsigned int osmo_io_fd::priv_nr

private number, extending data

Referenced by osmo_iofd_get_priv_nr(), and osmo_iofd_set_priv_nr().

tx_queue

struct osmo_io_fd::[struct].tx_queue osmo_io_fd::tx_queue

Referenced by iofd_txqueue_dequeue(), iofd_txqueue_enqueue(), iofd_txqueue_enqueue_front(), osmo_iofd_get_txqueue_max_length(), osmo_iofd_register(), osmo_iofd_set_txqueue_max_length(), osmo_iofd_setup(), osmo_iofd_txqueue_len(), and osmo_iofd_write_msgb().

u

union osmo_io_fd::[union].u osmo_io_fd::u

Referenced by iofd_poll_close(), iofd_poll_handle_recv(), iofd_poll_notify_connected(), iofd_poll_read_disable(), iofd_poll_read_enable(), iofd_poll_register(), iofd_poll_unregister(), iofd_poll_write_disable(), iofd_poll_write_enable(), and osmo_iofd_set_sqes().

---

The documentation for this struct was generated from the following file:

• src/core/osmo_io_internal.h