libhttp/doc/api/httplib_connect_client_secure.md

LibHTTP API Reference

httplib_connect_client_secure( client_options, error_buffer, error_buffer_size );

Parameters

Parameter	Type	Description
client_options	const struct httplib_client_options *	Settings about the server connection
error_buffer	char *	Buffer to store an error message
error_buffer_size	size_t	Size of the error message buffer including the NUL terminator

Return Value

Type	Description
struct httplib_connection *	Pointer to the connection information or NULL if an error occured

Description

The function httplib_connect_client_secure() creates a secure connection with a server. The information about the connection and server is passed in a structure and an error message may be returned in a local buffer. The function returns a pointer to a struct httplib_connection structure when successful and NULL otherwise.

Please note that IPv6 communication is supported by LibHTTP, but only if the use of IPv6 was enabled at compile time. The check while running a program if IPv6 communication is possible you can call httplib_check_feature() with the USE_IPV6 parameter to check if IPv6 communications can be used.

See Also

• struct httplib_client_options;
• httplib_check_feature();
• httplib_connect_client();
• httplib_connect_websocket_client();