vl_api_connect_sock_t Struct Reference

Connect to a remote peer

WILL BE DEPRECATED POST 20.01

More...

Data Fields
u32	client_index
u32	context
u32	wrk_index
u64	client_queue_address
u64	options [16]
u32	vrf
u8	is_ip4
u8	ip [16]
u16	port
u8	proto
u64	parent_handle
u8	hostname_len
u8	hostname [hostname_len]

Detailed Description

Connect to a remote peer

WILL BE DEPRECATED POST 20.01

Template Parameters

client_index	- opaque cookie to identify the sender
context	- sender context, to match reply w/ request
wrk_index	- worker that requests the connect
client_queue_address	- client's API queue address. Non-zero when used to perform redirects
options	- socket options, fifo sizes, etc. when doing redirects
vrf	- connection namespace
is_ip4	- flag that is 1 if ip address family is IPv4
ip	- ip address
port	- port
proto	- protocol 0 - TCP 1 - UDP
hostname-len	- length of hostname
hostname	- destination's hostname. If present, used by protocols like tls.
parent_handle	- handle of parent session (e.g. for opening quic streams).

Definition at line 312 of file session.api.

Field Documentation

client_index

u32 vl_api_connect_sock_t::client_index

Definition at line 313 of file session.api.

client_queue_address

u64 vl_api_connect_sock_t::client_queue_address

Definition at line 316 of file session.api.

context

u32 vl_api_connect_sock_t::context

Definition at line 314 of file session.api.

hostname

u8 vl_api_connect_sock_t::hostname[hostname_len]

Definition at line 325 of file session.api.

hostname_len

u8 vl_api_connect_sock_t::hostname_len

Definition at line 324 of file session.api.

ip

u8 vl_api_connect_sock_t::ip[16]

Definition at line 320 of file session.api.

is_ip4

u8 vl_api_connect_sock_t::is_ip4

Definition at line 319 of file session.api.

options

u64 vl_api_connect_sock_t::options[16]

Definition at line 317 of file session.api.

parent_handle

u64 vl_api_connect_sock_t::parent_handle

Definition at line 323 of file session.api.

port

u16 vl_api_connect_sock_t::port

Definition at line 321 of file session.api.

proto

u8 vl_api_connect_sock_t::proto

Definition at line 322 of file session.api.

vrf

u32 vl_api_connect_sock_t::vrf

Definition at line 318 of file session.api.

wrk_index

u32 vl_api_connect_sock_t::wrk_index

Definition at line 315 of file session.api.

---

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

• src/vnet/session/session.api