Result of a connect() call. More...

#include <ivon_client_types.h>

Public Attributes
int	success
	Non-zero on success.

int	is_connection_error
	Non-zero if the error is a connection error.

uint8_t	negotiation_code
	ivon_negotiation_error_code_t value

uint8_t	connection_code

const char *	message
	Human-readable error message (static lifetime, do not free).

char	detail [256]
	Detailed error information.

Detailed Description

Result of a connect() call.

If success is non-zero the connection is established. Otherwise inspect is_connection_error, negotiation_code / connection_code and the message/detail fields.

Member Data Documentation

◆ connection_code

uint8_t ivon_connect_result::connection_code

ivon_connection_error_code_t value

◆ detail

char ivon_connect_result::detail[256]

Detailed error information.

Copied into a caller-provided buffer via ivon_connect_result_detail(). This field is for internal use; consumers should use the accessor.

◆ is_connection_error

int ivon_connect_result::is_connection_error

Non-zero if the error is a connection error.

◆ message

const char* ivon_connect_result::message

Human-readable error message (static lifetime, do not free).

◆ negotiation_code

uint8_t ivon_connect_result::negotiation_code

ivon_negotiation_error_code_t value

◆ success

int ivon_connect_result::success

Non-zero on success.

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

src/client/include/libivon/public/ivon_client_types.h

Public Attributes