Data Structures
struct	lws_dll2

struct	lws_dll2_owner

struct	lws_wifi_scan

struct	lws_humanize_unit

Macros
#define	lws_start_foreach_ll(type, it, start)

#define	lws_end_foreach_ll(it, nxt)

#define	lws_start_foreach_ll_safe(type, it, start, nxt)

#define	lws_end_foreach_ll_safe(it)

#define	lws_start_foreach_llp(type, it, start)

#define	lws_start_foreach_llp_safe(type, it, start, nxt)

#define	lws_end_foreach_llp(it, nxt)

#define	lws_end_foreach_llp_safe(it)

#define	lws_ll_fwd_insert(___new_object, ___m_list, ___list_head)

#define	lws_ll_fwd_remove(___type, ___m_list, ___target, ___list_head)

#define	lws_dll2_describe(x, y)

#define	lws_start_foreach_dll_safe(___type, ___it, ___tmp, ___start)

#define	lws_end_foreach_dll_safe(___it, ___tmp)

#define	lws_start_foreach_dll(___type, ___it, ___start)

#define	lws_end_foreach_dll(___it)

#define	lws_ptr_diff(head, tail) ((int)((char )(head) - (char )(tail)))

Typedefs
typedef struct lws_dll2	lws_dll2_t

typedef struct lws_dll2_owner	lws_dll2_owner_t

typedef struct lws_humanize_unit	lws_humanize_unit_t

Enumerations
enum	{ LWS_RXFLOW_REASON_USER_BOOL = (1 << 0) , LWS_RXFLOW_REASON_HTTP_RXBUFFER = (1 << 6) , LWS_RXFLOW_REASON_H2_PPS_PENDING = (1 << 7) , LWS_RXFLOW_REASON_APPLIES = (1 << 14) , LWS_RXFLOW_REASON_APPLIES_ENABLE_BIT = (1 << 13) , LWS_RXFLOW_REASON_APPLIES_ENABLE , LWS_RXFLOW_REASON_APPLIES_DISABLE = LWS_RXFLOW_REASON_APPLIES , LWS_RXFLOW_REASON_FLAG_PROCESS_NOW = (1 << 12) }

Functions
LWS_VISIBLE LWS_EXTERN void	lws_dll2_add_head (struct lws_dll2 d, struct lws_dll2_owner owner)

LWS_VISIBLE LWS_EXTERN void	lws_dll2_add_tail (struct lws_dll2 d, struct lws_dll2_owner owner)

LWS_VISIBLE LWS_EXTERN void	lws_dll2_remove (struct lws_dll2 *d)

LWS_VISIBLE LWS_EXTERN int	lws_dll2_foreach_safe (struct lws_dll2_owner owner, void user, int(cb)(struct lws_dll2 d, void *user))

LWS_VISIBLE LWS_EXTERN void	lws_dll2_clear (struct lws_dll2 *d)

LWS_VISIBLE LWS_EXTERN void	lws_dll2_owner_clear (struct lws_dll2_owner *d)

LWS_VISIBLE LWS_EXTERN void	lws_dll2_add_before (struct lws_dll2 d, struct lws_dll2 after)

LWS_VISIBLE LWS_EXTERN void	lws_dll2_add_sorted (lws_dll2_t d, lws_dll2_owner_t own, int(compare)(const lws_dll2_t d, const lws_dll2_t *i))

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_buflist_append_segment (struct lws_buflist *head, const uint8_t buf, size_t len)

LWS_VISIBLE LWS_EXTERN size_t	lws_buflist_next_segment_len (struct lws_buflist head, uint8_t buf)

LWS_VISIBLE LWS_EXTERN int	lws_buflist_use_segment (struct lws_buflist **head, size_t len)

LWS_VISIBLE LWS_EXTERN void	lws_buflist_destroy_all_segments (struct lws_buflist **head)

void	lws_buflist_describe (struct lws_buflist *head, void id)

LWS_VISIBLE LWS_EXTERN int	lws_snprintf (char str, size_t size, const char format,...) LWS_FORMAT(3)

LWS_VISIBLE LWS_EXTERN char *	lws_strncpy (char dest, const char src, size_t size)

LWS_VISIBLE LWS_EXTERN int	lws_hex_to_byte_array (const char h, uint8_t dest, int max)

LWS_VISIBLE LWS_EXTERN int	lws_timingsafe_bcmp (const void a, const void b, uint32_t len)

LWS_VISIBLE LWS_EXTERN int	lws_get_random (struct lws_context context, void buf, int len)

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_daemonize (const char *_lock_path)

LWS_VISIBLE LWS_EXTERN const char *LWS_WARN_UNUSED_RESULT	lws_get_library_version (void)

LWS_VISIBLE LWS_EXTERN void *	lws_wsi_user (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_set_wsi_user (struct lws wsi, void user)

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_parse_uri (char p, const char prot, const char ads, int port, const char **path)

LWS_VISIBLE LWS_EXTERN const char *	lws_cmdline_option (int argc, const char *argv, const char val)

LWS_VISIBLE LWS_EXTERN unsigned long	lws_now_secs (void)

LWS_VISIBLE LWS_EXTERN lws_usec_t	lws_now_usecs (void)

LWS_VISIBLE LWS_EXTERN struct lws_context *LWS_WARN_UNUSED_RESULT	lws_get_context (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_get_vhost_listen_port (struct lws_vhost *vhost)

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT	lws_get_count_threads (struct lws_context *context)

LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT	lws_get_parent (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN struct lws *LWS_WARN_UNUSED_RESULT	lws_get_child (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_get_effective_uid_gid (struct lws_context context, int uid, int *gid)

LWS_VISIBLE LWS_EXTERN const struct lws_udp *LWS_WARN_UNUSED_RESULT	lws_get_udp (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void *	lws_get_opaque_parent_data (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_set_opaque_parent_data (struct lws wsi, void data)

LWS_VISIBLE LWS_EXTERN void *	lws_get_opaque_user_data (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_set_opaque_user_data (struct lws wsi, void data)

LWS_VISIBLE LWS_EXTERN int	lws_get_child_pending_on_writable (const struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_clear_child_pending_on_writable (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN int	lws_get_close_length (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN unsigned char *	lws_get_close_payload (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN struct lws *	lws_get_network_wsi (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN void	lws_set_allocator (void (realloc)(void ptr, size_t size, const char reason))

LWS_VISIBLE LWS_EXTERN int	lws_rx_flow_control (struct lws *wsi, int enable)

LWS_VISIBLE LWS_EXTERN void	lws_rx_flow_allow_all_protocol (const struct lws_context context, const struct lws_protocols protocol)

LWS_VISIBLE LWS_EXTERN size_t	lws_remaining_packet_payload (struct lws *wsi)

size_t	lws_get_allocated_heap (void)

LWS_VISIBLE LWS_EXTERN int	lws_is_ssl (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN int	lws_is_cgi (struct lws *wsi)

LWS_VISIBLE LWS_EXTERN int	lws_open (const char *__file, int __oflag,...)

LWS_VISIBLE LWS_EXTERN void	lws_explicit_bzero (void *p, size_t len)

LWS_VISIBLE LWS_EXTERN int	lws_humanize (char buf, int len, uint64_t value, const lws_humanize_unit_t schema)

Variables
LWS_VISIBLE LWS_EXTERN const lws_humanize_unit_t	humanize_schema_si [7]

LWS_VISIBLE LWS_EXTERN const lws_humanize_unit_t	humanize_schema_si_bytes [7]

LWS_VISIBLE LWS_EXTERN const lws_humanize_unit_t	humanize_schema_us [8]

Detailed Description

Miscellaneous APIs

Various APIs outside of other categories

Macro Definition Documentation

◆ lws_end_foreach_dll

#define lws_end_foreach_dll ( ___it )

#include <include/libwebsockets/lws-misc.h>

Value:

                ___it = (___it)->next; \
        } \
}

◆ lws_end_foreach_dll_safe

#define lws_end_foreach_dll_safe	(	___it,
		___tmp
	)

#include <include/libwebsockets/lws-misc.h>

Value:

                ___it = ___tmp; \
        } \
}

◆ lws_end_foreach_ll

#define lws_end_foreach_ll	(	it,
		nxt
	)

#include <include/libwebsockets/lws-misc.h>

Value:

                it = it->nxt; \
        } \
}

lws_end_foreach_ll(): linkedlist iterator helper end

Parameters

it	same iterator var name given when starting
nxt	member name in the iterator pointing to next list element

This helper is the partner for lws_start_foreach_ll() that ends the while loop.

◆ lws_end_foreach_ll_safe

#define lws_end_foreach_ll_safe ( it )

#include <include/libwebsockets/lws-misc.h>

Value:

                it = next_##it; \
        } \
}

lws_end_foreach_ll_safe(): linkedlist iterator helper end (pre increment storage)

Parameters

it	same iterator var name given when starting

This helper is the partner for lws_start_foreach_ll_safe() that ends the while loop. It uses the precreated next_ variable already stored during start.

◆ lws_end_foreach_llp

#define lws_end_foreach_llp	(	it,
		nxt
	)

#include <include/libwebsockets/lws-misc.h>

Value:

                it = &(*(it))->nxt; \
        } \
}

lws_end_foreach_llp(): linkedlist pointer iterator helper end

Parameters

it	same iterator var name given when starting
nxt	member name in the iterator pointing to next list element

This helper is the partner for lws_start_foreach_llp() that ends the while loop.

◆ lws_end_foreach_llp_safe

#define lws_end_foreach_llp_safe ( it )

#include <include/libwebsockets/lws-misc.h>

Value:

                it = next; \
        } \
}

◆ lws_ll_fwd_insert

#define lws_ll_fwd_insert	(	___new_object,
		___m_list,
		___list_head
	)

#include <include/libwebsockets/lws-misc.h>

Value:

                {\
                ___new_object->___m_list = ___list_head; \
                ___list_head = ___new_object; \
        }

◆ lws_ll_fwd_remove

#define lws_ll_fwd_remove	(	___type,
		___m_list,
		___target,
		___list_head
	)

#include <include/libwebsockets/lws-misc.h>

Value:

                { \
                lws_start_foreach_llp(___type **, ___ppss, ___list_head) { \
                        if (*___ppss == ___target) { \
                                *___ppss = ___target->___m_list; \
                                break; \
                        } \
                } lws_end_foreach_llp(___ppss, ___m_list); \
        }

◆ lws_ptr_diff

#define lws_ptr_diff	(	head,
		tail
	)	((int)((char )(head) - (char )(tail)))

#include <include/libwebsockets/lws-misc.h>

lws_ptr_diff(): helper to report distance between pointers as an int

Parameters

head	the pointer with the larger address
tail	the pointer with the smaller address

This helper gives you an int representing the number of bytes further forward the first pointer is compared to the second pointer.

◆ lws_start_foreach_dll

#define lws_start_foreach_dll	(	___type,
		___it,
		___start
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        ___type ___it = ___start; \
        while (___it) {

◆ lws_start_foreach_dll_safe

#define lws_start_foreach_dll_safe	(	___type,
		___it,
		___tmp,
		___start
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        ___type ___it = ___start; \
        while (___it) { \
                ___type ___tmp = (___it)->next;

◆ lws_start_foreach_ll

#define lws_start_foreach_ll	(	type,
		it,
		start
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        type it = start; \
        while (it) {

lws_start_foreach_ll(): linkedlist iterator helper start

Parameters

type	type of iteration, eg, struct xyz *
it	iterator var name to create
start	start of list

This helper creates an iterator and starts a while (it) { loop. The iterator runs through the linked list starting at start and ends when it gets a NULL. The while loop should be terminated using lws_start_foreach_ll().

◆ lws_start_foreach_ll_safe

#define lws_start_foreach_ll_safe	(	type,
		it,
		start,
		nxt
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        type it = start; \
        while (it) { \
                type next_##it = it->nxt;

lws_start_foreach_ll_safe(): linkedlist iterator helper start safe against delete

Parameters

type	type of iteration, eg, struct xyz *
it	iterator var name to create
start	start of list
nxt	member name in the iterator pointing to next list element

This helper creates an iterator and starts a while (it) { loop. The iterator runs through the linked list starting at start and ends when it gets a NULL. The while loop should be terminated using lws_end_foreach_ll_safe(). Performs storage of next increment for situations where iterator can become invalidated during iteration.

◆ lws_start_foreach_llp

#define lws_start_foreach_llp	(	type,
		it,
		start
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        type it = &(start); \
        while (*(it)) {

lws_start_foreach_llp(): linkedlist pointer iterator helper start

Parameters

type	type of iteration, eg, struct xyz **
it	iterator var name to create
start	start of list

This helper creates an iterator and starts a while (it) { loop. The iterator runs through the linked list starting at the address of start and ends when it gets a NULL. The while loop should be terminated using lws_start_foreach_llp().

This helper variant iterates using a pointer to the previous linked-list element. That allows you to easily delete list members by rewriting the previous pointer to the element's next pointer.

◆ lws_start_foreach_llp_safe

#define lws_start_foreach_llp_safe	(	type,
		it,
		start,
		nxt
	)

#include <include/libwebsockets/lws-misc.h>

Value:

{ \
        type it = &(start); \
        type next; \
        while (*(it)) { \
                next = &((*(it))->nxt); \

Function Documentation

◆ lws_buflist_append_segment()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_buflist_append_segment	(	struct lws_buflist **	head,
		const uint8_t *	buf,
		size_t	len
	)

#include <include/libwebsockets/lws-misc.h>

lws_buflist_append_segment(): add buffer to buflist at head

Parameters

head	list head
buf	buffer to stash
len	length of buffer to stash

Returns -1 on OOM, 1 if this was the first segment on the list, and 0 if it was a subsequent segment.

◆ lws_buflist_destroy_all_segments()

LWS_VISIBLE LWS_EXTERN void lws_buflist_destroy_all_segments ( struct lws_buflist ** head )

#include <include/libwebsockets/lws-misc.h>

lws_buflist_destroy_all_segments(): free all segments on the list

Parameters

head list head

This frees everything on the list unconditionally. *head is always NULL after this.

◆ lws_buflist_next_segment_len()

LWS_VISIBLE LWS_EXTERN size_t lws_buflist_next_segment_len	(	struct lws_buflist **	head,
		uint8_t **	buf
	)

#include <include/libwebsockets/lws-misc.h>

lws_buflist_next_segment_len(): number of bytes left in current segment

Parameters

head	list head
buf	if non-NULL, *buf is written with the address of the start of the remaining data in the segment

Returns the number of bytes left in the current segment. 0 indicates that the buflist is empty (there are no segments on the buflist).

◆ lws_buflist_use_segment()

LWS_VISIBLE LWS_EXTERN int lws_buflist_use_segment	(	struct lws_buflist **	head,
		size_t	len
	)

#include <include/libwebsockets/lws-misc.h>

lws_buflist_use_segment(): remove len bytes from the current segment

Parameters

head	list head
len	number of bytes to mark as used

If len is less than the remaining length of the current segment, the position in the current segment is simply advanced and it returns.

If len uses up the remaining length of the current segment, then the segment is deleted and the list head moves to the next segment if any.

Returns the number of bytes left in the current segment. 0 indicates that the buflist is empty (there are no segments on the buflist).

◆ lws_cmdline_option()

LWS_VISIBLE LWS_EXTERN const char* lws_cmdline_option	(	int	argc,
		const char **	argv,
		const char *	val
	)

#include <include/libwebsockets/lws-misc.h>

lws_cmdline_option(): simple commandline parser

Parameters

argc	count of argument strings
argv	argument strings
val	string to find

Returns NULL if the string val is not found in the arguments.

If it is found, then it returns a pointer to the next character after val. So if val is "-d", then for the commandlines "myapp -d15" and "myapp -d 15", in both cases the return will point to the "15".

In the case there is no argument, like "myapp -d", the return will either point to the '\0' at the end of -d, or to the start of the next argument, ie, will be non-NULL.

◆ lws_daemonize()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_daemonize ( const char * _lock_path )

#include <include/libwebsockets/lws-misc.h>

lws_daemonize(): make current process run in the background

Parameters

_lock_path the filepath to write the lock file

Spawn lws as a background process, taking care of various things

◆ lws_get_allocated_heap()

size_t lws_get_allocated_heap ( void )

#include <include/libwebsockets/lws-misc.h>

lws_get_allocated_heap() - if the platform supports it, returns amount of heap allocated by lws itself

On glibc currently, this reports the total amount of current logical heap allocation, found by tracking the amount allocated by lws_malloc() and friends and accounting for freed allocations via lws_free().

This is useful for confirming where processwide heap allocations actually come from... this number represents all lws internal allocations, for fd tables, wsi allocations, ah, etc combined. It doesn't include allocations from user code, since lws_malloc() etc are not exported from the library.

On other platforms, it always returns 0.

◆ lws_get_child()

LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_get_child ( const struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_get_child() - get child wsi or NULL

Parameters

wsi	lws connection

Allows you to find a related wsi from the parent wsi.

◆ lws_get_context()

LWS_VISIBLE LWS_EXTERN struct lws_context* LWS_WARN_UNUSED_RESULT lws_get_context ( const struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_get_context - Allow getting lws_context from a Websocket connection instance

With this function, users can access context in the callback function. Otherwise users may have to declare context as a global variable.

Parameters

wsi	Websocket connection instance

◆ lws_get_count_threads()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_get_count_threads ( struct lws_context * context )

#include <include/libwebsockets/lws-misc.h>

lws_get_count_threads(): how many service threads the context uses

Parameters

context the lws context

By default this is always 1, if you asked for more than lws can handle it will clip the number of threads. So you can use this to find out how many threads are actually in use.

◆ lws_get_effective_uid_gid()

LWS_VISIBLE LWS_EXTERN void lws_get_effective_uid_gid	(	struct lws_context *	context,
		int *	uid,
		int *	gid
	)

#include <include/libwebsockets/lws-misc.h>

lws_get_effective_uid_gid() - find out eventual uid and gid while still root

Parameters

context	lws context
uid	pointer to uid result
gid	pointer to gid result

This helper allows you to find out what the uid and gid for the process will be set to after the privileges are dropped, beforehand. So while still root, eg in LWS_CALLBACK_PROTOCOL_INIT, you can arrange things like cache dir and subdir creation / permissions down /var/cache dynamically.

◆ lws_get_library_version()

LWS_VISIBLE LWS_EXTERN const char* LWS_WARN_UNUSED_RESULT lws_get_library_version ( void )

#include <include/libwebsockets/lws-misc.h>

lws_get_library_version(): return string describing the version of lws

On unix, also includes the git describe

◆ lws_get_network_wsi()

LWS_VISIBLE LWS_EXTERN struct lws* lws_get_network_wsi ( struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_get_network_wsi() - Returns wsi that has the tcp connection for this wsi

Parameters

wsi	wsi you have

Returns wsi that has the tcp connection (which may be the incoming wsi)

HTTP/1 connections will always return the incoming wsi HTTP/2 connections may return a different wsi that has the tcp connection

◆ lws_get_parent()

LWS_VISIBLE LWS_EXTERN struct lws* LWS_WARN_UNUSED_RESULT lws_get_parent ( const struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_get_parent() - get parent wsi or NULL

Parameters

wsi	lws connection

Specialized wsi like cgi stdin/out/err are associated to a parent wsi, this allows you to get their parent.

◆ lws_get_random()

LWS_VISIBLE LWS_EXTERN int lws_get_random	(	struct lws_context *	context,
		void *	buf,
		int	len
	)

#include <include/libwebsockets/lws-misc.h>

lws_get_random(): fill a buffer with platform random data

Parameters

context	the lws context
buf	buffer to fill
len	how much to fill

Fills buf with len bytes of random. Returns the number of bytes set, if not equal to len, then getting the random failed.

◆ lws_get_udp()

LWS_VISIBLE LWS_EXTERN const struct lws_udp* LWS_WARN_UNUSED_RESULT lws_get_udp ( const struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_get_udp() - get wsi's udp struct

Parameters

wsi	lws connection

Returns NULL or pointer to the wsi's UDP-specific information

◆ lws_get_vhost_listen_port()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_get_vhost_listen_port ( struct lws_vhost * vhost )

#include <include/libwebsockets/lws-misc.h>

lws_get_vhost_listen_port - Find out the port number a vhost is listening on

In the case you passed 0 for the port number at context creation time, you can discover the port number that was actually chosen for the vhost using this api.

Parameters

vhost Vhost to get listen port from

◆ lws_hex_to_byte_array()

LWS_VISIBLE LWS_EXTERN int lws_hex_to_byte_array	(	const char *	h,
		uint8_t *	dest,
		int	max
	)

#include <include/libwebsockets/lws-misc.h>

lws_hex_to_byte_array(): convert hex string like 0123456789ab into byte data

Parameters

h	incoming NUL-terminated hex string
dest	array to fill with binary decodes of hex pairs from h
max	maximum number of bytes dest can hold, must be at least half the size of strlen(h)

This converts hex strings into an array of 8-bit representations, ie the input "abcd" produces two bytes of value 0xab and 0xcd.

Returns number of bytes produced into dest, or -1 on error.

Errors include non-hex chars and an odd count of hex chars in the input string.

◆ lws_humanize()

LWS_VISIBLE LWS_EXTERN int lws_humanize	(	char *	buf,
		int	len,
		uint64_t	value,
		const lws_humanize_unit_t *	schema
	)

#include <include/libwebsockets/lws-misc.h>

lws_humanize() - Convert possibly large number to human-readable uints

Parameters

buf	result string buffer
len	remaining length in `buf`
value	the uint64_t value to represent
schema	and array of scaling factors and units

This produces a concise string representation of value, referencing the schema schema of scaling factors and units to find the smallest way to render it.

Three schema are exported from lws for general use, humanize_schema_si, which represents as, eg, " 22.130Gi" or " 128 "; humanize_schema_si_bytes which is the same but shows, eg, " 22.130GiB", and humanize_schema_us, which represents a count of us as a human-readable time like " 14.350min", or " 1.500d".

You can produce your own schema.

◆ lws_is_cgi()

LWS_VISIBLE LWS_EXTERN int lws_is_cgi ( struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_is_cgi() - find out if this wsi is running a cgi process

Parameters

wsi	lws connection

◆ lws_is_ssl()

LWS_VISIBLE LWS_EXTERN int lws_is_ssl ( struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_is_ssl() - Find out if connection is using SSL

Parameters

wsi	websocket connection to check Returns 0 if the connection is not using SSL, 1 if using SSL and using verified cert, and 2 if using SSL but the cert was not checked (appears for client wsi told to skip check on connection)

◆ lws_now_secs()

LWS_VISIBLE LWS_EXTERN unsigned long lws_now_secs ( void )

#include <include/libwebsockets/lws-misc.h>

lws_now_secs(): return seconds since 1970-1-1

◆ lws_now_usecs()

LWS_VISIBLE LWS_EXTERN lws_usec_t lws_now_usecs ( void )

#include <include/libwebsockets/lws-misc.h>

lws_now_usecs(): return useconds since 1970-1-1

◆ lws_open()

LWS_VISIBLE LWS_EXTERN int lws_open	(	const char *	__file,
		int	__oflag,
			...
	)

#include <include/libwebsockets/lws-misc.h>

lws_open() - platform-specific wrapper for open that prepares the fd

Parameters

__file	the filepath to open
__oflag	option flags

This is a wrapper around platform open() that sets options on the fd according to lws policy. Currently that is FD_CLOEXEC to stop the opened fd being available to any child process forked by user code.

◆ lws_parse_uri()

LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_parse_uri	(	char *	p,
		const char **	prot,
		const char **	ads,
		int *	port,
		const char **	path
	)

#include <include/libwebsockets/lws-misc.h>

lws_parse_uri: cut up prot:/ads:port/path into pieces Notice it does so by dropping '\0' into input string and the leading / on the path is consequently lost

Parameters

p	incoming uri string.. will get written to
prot	result pointer for protocol part (https://)
ads	result pointer for address part
port	result pointer for port part
path	result pointer for path part

You may also refer to unix socket addresses, using a '+' at the start of the address. In this case, the address should end with ':', which is treated as the separator between the address and path (the normal separator '/' is a valid part of the socket path). Eg,

http://+/var/run/mysocket:/my/path

If the first character after the + is '@', it's interpreted by lws client processing as meaning to use linux abstract namespace sockets, the @ is replaced with a '\0' before use.

◆ lws_remaining_packet_payload()

LWS_VISIBLE LWS_EXTERN size_t lws_remaining_packet_payload ( struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_remaining_packet_payload() - Bytes to come before "overall" rx fragment is complete

Parameters

wsi	Websocket instance (available from user callback)

This tracks how many bytes are left in the current ws fragment, according to the ws length given in the fragment header.

If the message was in a single fragment, and there is no compression, this is the same as "how much data is left to read for this message".

However, if the message is being sent in multiple fragments, this will reflect the unread amount of the current fragment, not the message. With ws, it is legal to not know the length of the message before it completes.

Additionally if the message is sent via the negotiated permessage-deflate extension, this number only tells the amount of compressed data left to be read, since that is the only information available at the ws layer.

◆ lws_rx_flow_allow_all_protocol()

LWS_VISIBLE LWS_EXTERN void lws_rx_flow_allow_all_protocol	(	const struct lws_context *	context,
		const struct lws_protocols *	protocol
	)

#include <include/libwebsockets/lws-misc.h>

lws_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive

When the user server code realizes it can accept more input, it can call this to have the RX flow restriction removed from all connections using the given protocol.

Parameters

context	lws_context
protocol	all connections using this protocol will be allowed to receive

◆ lws_rx_flow_control()

LWS_VISIBLE LWS_EXTERN int lws_rx_flow_control	(	struct lws *	wsi,
		int	enable
	)

#include <include/libwebsockets/lws-misc.h>

lws_rx_flow_control() - Enable and disable socket servicing for received packets.

If the output side of a server process becomes choked, this allows flow control for the input side.

Parameters

wsi	Websocket connection instance to get callback for
enable	0 = disable read servicing for this connection, 1 = enable

If you need more than one additive reason for rxflow control, you can give iLWS_RXFLOW_REASON_APPLIES_ENABLE or _DISABLE together with one or more of b5..b0 set to idicate which bits to enable or disable. If any bits are enabled, rx on the connection is suppressed.

LWS_RXFLOW_REASON_FLAG_PROCESS_NOW flag may also be given to force any change in rxflowbstatus to benapplied immediately, this should be used when you are changing a wsi flow control state from outside a callback on that wsi.

◆ lws_set_allocator()

LWS_VISIBLE LWS_EXTERN void lws_set_allocator ( void *(*)(void *ptr, size_t size, const char *reason) realloc )

#include <include/libwebsockets/lws-misc.h>

lws_set_allocator() - custom allocator support

Parameters

realloc Allows you to replace the allocator (and deallocator) used by lws

◆ lws_set_wsi_user()

LWS_VISIBLE LWS_EXTERN void lws_set_wsi_user	(	struct lws *	wsi,
		void *	user
	)

#include <include/libwebsockets/lws-misc.h>

lws_set_wsi_user() - set the user data associated with the client connection

Parameters

wsi	lws connection
user	user data

By default lws allocates this and it's not legal to externally set it yourself. However client connections may have it set externally when the connection is created... if so, this api can be used to modify it at runtime additionally.

◆ lws_snprintf()

LWS_VISIBLE LWS_EXTERN int lws_snprintf	(	char *	str,
		size_t	size,
		const char *	format,
			...
	)

#include <include/libwebsockets/lws-misc.h>

lws_snprintf(): snprintf that truncates the returned length too

Parameters

str	destination buffer
size	bytes left in destination buffer
format	format string
...	args for format

This lets you correctly truncate buffers by concatenating lengths, if you reach the limit the reported length doesn't exceed the limit.

◆ lws_strncpy()

LWS_VISIBLE LWS_EXTERN char* lws_strncpy	(	char *	dest,
		const char *	src,
		size_t	size
	)

#include <include/libwebsockets/lws-misc.h>

lws_strncpy(): strncpy that guarantees NUL on truncated copy

Parameters

dest	destination buffer
src	source buffer
size	bytes left in destination buffer

This lets you correctly truncate buffers by concatenating lengths, if you reach the limit the reported length doesn't exceed the limit.

◆ lws_wsi_user()

LWS_VISIBLE LWS_EXTERN void* lws_wsi_user ( struct lws * wsi )

#include <include/libwebsockets/lws-misc.h>

lws_wsi_user() - get the user data associated with the connection

Parameters

wsi	lws connection

Not normally needed since it's passed into the callback

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Miscellaneous APIs

Macro Definition Documentation

◆ lws_end_foreach_dll

◆ lws_end_foreach_dll_safe

◆ lws_end_foreach_ll

◆ lws_end_foreach_ll_safe

◆ lws_end_foreach_llp

◆ lws_end_foreach_llp_safe

◆ lws_ll_fwd_insert

◆ lws_ll_fwd_remove

◆ lws_ptr_diff

◆ lws_start_foreach_dll

◆ lws_start_foreach_dll_safe

◆ lws_start_foreach_ll

◆ lws_start_foreach_ll_safe

◆ lws_start_foreach_llp

◆ lws_start_foreach_llp_safe

Function Documentation

◆ lws_buflist_append_segment()

◆ lws_buflist_destroy_all_segments()

◆ lws_buflist_next_segment_len()

◆ lws_buflist_use_segment()

◆ lws_cmdline_option()

◆ lws_daemonize()

◆ lws_get_allocated_heap()

◆ lws_get_child()

◆ lws_get_context()

◆ lws_get_count_threads()

◆ lws_get_effective_uid_gid()

◆ lws_get_library_version()

◆ lws_get_network_wsi()

◆ lws_get_parent()

◆ lws_get_random()

◆ lws_get_udp()

◆ lws_get_vhost_listen_port()

◆ lws_hex_to_byte_array()

◆ lws_humanize()

◆ lws_is_cgi()

◆ lws_is_ssl()

◆ lws_now_secs()

◆ lws_now_usecs()

◆ lws_open()

◆ lws_parse_uri()

◆ lws_remaining_packet_payload()

◆ lws_rx_flow_allow_all_protocol()

◆ lws_rx_flow_control()

◆ lws_set_allocator()

◆ lws_set_wsi_user()

◆ lws_snprintf()

◆ lws_strncpy()

◆ lws_wsi_user()