struct rpc_msghdr

Overview

Store information about message More…

#include <tapi_rpc_socket.h>

struct rpc_msghdr {
    // fields

    void* msg_name;
    socklen_t msg_namelen;
    struct rpc_iovec* msg_iov;
    size_t msg_iovlen;
    void* msg_control;
    size_t msg_controllen;
    rpc_send_recv_flags msg_flags;
    size_t real_msg_controllen;
    size_t got_msg_controllen;
    int msg_cmsghdr_num;
    rpc_msghdr_field_mode msg_control_mode;
    rpc_msghdr_field_mode msg_name_mode;
    bool msg_namelen_exact;
    socklen_t got_msg_namelen;
    socklen_t msg_rnamelen;
    size_t msg_riovlen;
    rpc_msg_flags_mode msg_flags_mode;
    rpc_send_recv_flags in_msg_flags;
};

Detailed Documentation

Store information about message

Fields

void* msg_name

protocol address

socklen_t msg_namelen

size of protocol address

struct rpc_iovec* msg_iov

scatter/gather array

size_t msg_iovlen

elements in msg_iov

void* msg_control

ancillary data

size_t msg_controllen

length of ancillary data

rpc_send_recv_flags msg_flags

flags returned by recvmsg()

size_t real_msg_controllen

Real length of msg_control buffer. Ignored if zero; if non-zero. value of msg_controllen will be used explicitly on TA.

size_t got_msg_controllen

msg_controllen value obtained on TA

int msg_cmsghdr_num

Number of valid cmsghdr structures in msg_control

rpc_msghdr_field_mode msg_control_mode

How to process msg_control when calling RPC: in case of default mode, msg_control will be parsed only for send calls, and will be passed as a raw value for receive calls.

rpc_msghdr_field_mode msg_name_mode

How to process msg_name (in case of default mode, address will be parsed for send calls but passed as raw value for receive calls on input).

bool msg_namelen_exact

If true, use specified msg_namelen value on a remote host; otherwise compute it on remote host from address type.

socklen_t got_msg_namelen

Here msg_namelen obtained on remote host will be retrieved.

socklen_t msg_rnamelen

Real size of protocol address buffer.

size_t msg_riovlen

real number of elements in msg_iov

rpc_msg_flags_mode msg_flags_mode

determine how to process field msg_flags

rpc_send_recv_flags in_msg_flags

msg_flags value passed in