AranyaClientConfigBuilder Struct Reference

Configuration info builder for an Aranya client config `AranyaClientConfig`. More...

#include <aranya-client.h>

Related Symbols
(Note that these are not member symbols.)
AranyaError	aranya_client_config_builder_init (struct AranyaClientConfigBuilder *out)
	Initializes AranyaClientConfigBuilder.
AranyaError	aranya_client_config_builder_init_ext (struct AranyaClientConfigBuilder *out, struct AranyaExtError *__ext_err)
	Initializes AranyaClientConfigBuilder.
AranyaError	aranya_client_config_builder_cleanup (struct AranyaClientConfigBuilder *ptr)
	Releases any resources associated with ptr.
AranyaError	aranya_client_config_builder_cleanup_ext (struct AranyaClientConfigBuilder *ptr, struct AranyaExtError *__ext_err)
	Releases any resources associated with ptr.
AranyaError	aranya_client_config_build (struct AranyaClientConfigBuilder *cfg, struct AranyaClientConfig *out)
	Attempts to construct a `AranyaClientConfig`.
AranyaError	aranya_client_config_build_ext (struct AranyaClientConfigBuilder *cfg, struct AranyaClientConfig *out, struct AranyaExtError *__ext_err)
	Attempts to construct a `AranyaClientConfig`.
AranyaError	aranya_client_config_builder_set_daemon_uds_path (struct AranyaClientConfigBuilder *cfg, const char *address)
	Sets Unix Domain Socket path that the daemon is listening on.
AranyaError	aranya_client_config_builder_set_daemon_uds_path_ext (struct AranyaClientConfigBuilder *cfg, const char *address, struct AranyaExtError *__ext_err)
	Sets Unix Domain Socket path that the daemon is listening on.

Detailed Description

Configuration info builder for an Aranya client config `AranyaClientConfig`.

Friends And Related Symbol Documentation

aranya_client_config_build()

AranyaError aranya_client_config_build ( struct AranyaClientConfigBuilder *  cfg, struct AranyaClientConfig *  out  )

related

Attempts to construct a `AranyaClientConfig`.

This function consumes and releases any resources associated with the memory pointed to by cfg.

Parameters

[in]	cfg	a pointer to the client config builder
[out]	out	a pointer to write the client config to

aranya_client_config_build_ext()

AranyaError aranya_client_config_build_ext ( struct AranyaClientConfigBuilder *  cfg, struct AranyaClientConfig *  out, struct AranyaExtError *  __ext_err  )

related

Attempts to construct a `AranyaClientConfig`.

This function consumes and releases any resources associated with the memory pointed to by cfg.

Parameters

[in]	cfg	a pointer to the client config builder
[out]	out	a pointer to write the client config to

aranya_client_config_builder_cleanup()

AranyaError aranya_client_config_builder_cleanup ( struct AranyaClientConfigBuilder *  ptr )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_client_config_builder_init.

aranya_client_config_builder_cleanup_ext()

AranyaError aranya_client_config_builder_cleanup_ext ( struct AranyaClientConfigBuilder *  ptr, struct AranyaExtError *  __ext_err  )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_client_config_builder_init.

aranya_client_config_builder_init()

AranyaError aranya_client_config_builder_init ( struct AranyaClientConfigBuilder *  out )

related

Initializes AranyaClientConfigBuilder.

When no longer needed, out's resources must be released with its cleanup routine.

aranya_client_config_builder_init_ext()

AranyaError aranya_client_config_builder_init_ext ( struct AranyaClientConfigBuilder *  out, struct AranyaExtError *  __ext_err  )

related

Initializes AranyaClientConfigBuilder.

When no longer needed, out's resources must be released with its cleanup routine.

aranya_client_config_builder_set_daemon_uds_path()

AranyaError aranya_client_config_builder_set_daemon_uds_path ( struct AranyaClientConfigBuilder *  cfg, const char *  address  )

related

Sets Unix Domain Socket path that the daemon is listening on.

Parameters

[in,out]	cfg	a pointer to the client config builder
[in]	address	a string containing the address

aranya_client_config_builder_set_daemon_uds_path_ext()

AranyaError aranya_client_config_builder_set_daemon_uds_path_ext ( struct AranyaClientConfigBuilder *  cfg, const char *  address, struct AranyaExtError *  __ext_err  )

related

Sets Unix Domain Socket path that the daemon is listening on.

Parameters

[in,out]	cfg	a pointer to the client config builder
[in]	address	a string containing the address

---

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

• output/aranya-client.h