libwebsockets
Lightweight C library for HTML5 websockets
Loading...
Searching...
No Matches
lws_ss_policy Struct Reference

#include <lws-secure-streams-policy.h>

Collaboration diagram for lws_ss_policy:

Data Fields

struct lws_ss_policy * next
const char * streamtype
const char * endpoint
const char * rideshare_streamtype
const char * payload_fmt
const char * socks5_proxy
lws_ss_metadata_t * metadata
const lws_metric_policy_t * metrics
const lws_ss_auth_t * auth
union { 
} u
union { 
const lws_ss_trust_store_t * store
   struct { 
const lws_ss_x509_t * cert
const lws_ss_x509_t * key
   } server
} trust
const lws_retry_bo_t * retry_bo
int32_t txc
int32_t txc_peer
uint32_t proxy_buflen
uint32_t proxy_buflen_rxflow_on_above
uint32_t proxy_buflen_rxflow_off_below
uint32_t client_buflen
uint32_t client_buflen_rxflow_on_above
uint32_t client_buflen_rxflow_off_below
uint32_t timeout_ms
uint32_t flags
uint16_t port
uint8_t metadata_count
uint8_t protocol
uint8_t client_cert
uint8_t priority

Detailed Description

lws_ss_policy_t: policy database entry for a stream type

Decides the system policy for how to implement connections of name .streamtype.

Streams may need one kind of auth sequencing for the network connection and another kind of auth sequencing for the streams that are carried inside it, this is the purpose of .nauth and .sauth. Both are optional and may be NULL.

An array of these is set at context creation time, ending with one with a NULL streamtype.

Definition at line 224 of file lws-secure-streams-policy.h.

Field Documentation

◆ next

struct lws_ss_policy* lws_ss_policy::next

Definition at line 225 of file lws-secure-streams-policy.h.

◆ streamtype

const char* lws_ss_policy::streamtype

stream type lhs to match on

Definition at line 226 of file lws-secure-streams-policy.h.

◆ endpoint

const char* lws_ss_policy::endpoint

DNS address to connect to

Definition at line 228 of file lws-secure-streams-policy.h.

◆ rideshare_streamtype

const char* lws_ss_policy::rideshare_streamtype

optional transport on another, preexisting stream of this streamtype name

Definition at line 229 of file lws-secure-streams-policy.h.

◆ payload_fmt

const char* lws_ss_policy::payload_fmt

Definition at line 232 of file lws-secure-streams-policy.h.

◆ socks5_proxy

const char* lws_ss_policy::socks5_proxy

Definition at line 233 of file lws-secure-streams-policy.h.

◆ metadata

lws_ss_metadata_t* lws_ss_policy::metadata

Definition at line 234 of file lws-secure-streams-policy.h.

◆ metrics

const lws_metric_policy_t* lws_ss_policy::metrics

Definition at line 235 of file lws-secure-streams-policy.h.

◆ auth

const lws_ss_auth_t* lws_ss_policy::auth

Definition at line 236 of file lws-secure-streams-policy.h.

◆ [union]

union { ... } lws_ss_policy::u

◆ [union]

union { ... } lws_ss_policy::trust

◆ retry_bo

const lws_retry_bo_t* lws_ss_policy::retry_bo

retry policy to use

Definition at line 339 of file lws-secure-streams-policy.h.

◆ txc

int32_t lws_ss_policy::txc

Definition at line 341 of file lws-secure-streams-policy.h.

◆ txc_peer

int32_t lws_ss_policy::txc_peer

Definition at line 342 of file lws-secure-streams-policy.h.

◆ proxy_buflen

uint32_t lws_ss_policy::proxy_buflen

max dsh alloc for proxy

Definition at line 344 of file lws-secure-streams-policy.h.

◆ proxy_buflen_rxflow_on_above

uint32_t lws_ss_policy::proxy_buflen_rxflow_on_above

Definition at line 345 of file lws-secure-streams-policy.h.

◆ proxy_buflen_rxflow_off_below

uint32_t lws_ss_policy::proxy_buflen_rxflow_off_below

Definition at line 346 of file lws-secure-streams-policy.h.

◆ client_buflen

uint32_t lws_ss_policy::client_buflen

max dsh alloc for client

Definition at line 348 of file lws-secure-streams-policy.h.

◆ client_buflen_rxflow_on_above

uint32_t lws_ss_policy::client_buflen_rxflow_on_above

Definition at line 349 of file lws-secure-streams-policy.h.

◆ client_buflen_rxflow_off_below

uint32_t lws_ss_policy::client_buflen_rxflow_off_below

Definition at line 350 of file lws-secure-streams-policy.h.

◆ timeout_ms

uint32_t lws_ss_policy::timeout_ms

default message response timeout in ms

Definition at line 352 of file lws-secure-streams-policy.h.

◆ flags

uint32_t lws_ss_policy::flags

stream attribute flags

Definition at line 354 of file lws-secure-streams-policy.h.

◆ port

uint16_t lws_ss_policy::port

endpoint port

Definition at line 356 of file lws-secure-streams-policy.h.

◆ metadata_count

uint8_t lws_ss_policy::metadata_count

metadata count

Definition at line 358 of file lws-secure-streams-policy.h.

◆ protocol

uint8_t lws_ss_policy::protocol

protocol index

Definition at line 359 of file lws-secure-streams-policy.h.

◆ client_cert

uint8_t lws_ss_policy::client_cert

which client cert to apply 0 = none, 1+ = cc 0+

Definition at line 360 of file lws-secure-streams-policy.h.

◆ priority

uint8_t lws_ss_policy::priority

Definition at line 362 of file lws-secure-streams-policy.h.

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