AranyaAddTeamConfigBuilder Struct Reference

A builder for initializing an `AranyaAddTeamConfig`. More...

#include <aranya-client.h>

Related Symbols
(Note that these are not member symbols.)
AranyaError	aranya_add_team_config_builder_init (struct AranyaAddTeamConfigBuilder *out)
	Initializes AranyaAddTeamConfigBuilder.
AranyaError	aranya_add_team_config_builder_cleanup (struct AranyaAddTeamConfigBuilder *ptr)
	Releases any resources associated with ptr.
AranyaError	aranya_add_team_config_builder_set_quic_syncer (struct AranyaAddTeamConfigBuilder *cfg, struct AranyaAddTeamQuicSyncConfig *quic)
	Configures QUIC syncer for `AranyaAddTeamConfigBuilder`.
AranyaError	aranya_add_team_config_builder_set_quic_syncer_ext (struct AranyaAddTeamConfigBuilder *cfg, struct AranyaAddTeamQuicSyncConfig *quic, struct AranyaExtError *__ext_err)
	Configures QUIC syncer for `AranyaAddTeamConfigBuilder`.
AranyaError	aranya_add_team_config_builder_set_id (struct AranyaAddTeamConfigBuilder *cfg, const struct AranyaTeamId *team_id)
	Configures team ID field for `AranyaAddTeamConfigBuilder`.
AranyaError	aranya_add_team_config_builder_set_id_ext (struct AranyaAddTeamConfigBuilder *cfg, const struct AranyaTeamId *team_id, struct AranyaExtError *__ext_err)
	Configures team ID field for `AranyaAddTeamConfigBuilder`.
AranyaError	aranya_add_team_config_build (struct AranyaAddTeamConfigBuilder *cfg, struct AranyaAddTeamConfig *out)
	Attempts to construct an `AranyaAddTeamConfig`.
AranyaError	aranya_add_team_config_build_ext (struct AranyaAddTeamConfigBuilder *cfg, struct AranyaAddTeamConfig *out, struct AranyaExtError *__ext_err)
	Attempts to construct an `AranyaAddTeamConfig`.

Detailed Description

A builder for initializing an `AranyaAddTeamConfig`.

Friends And Related Symbol Documentation

aranya_add_team_config_build()

AranyaError aranya_add_team_config_build ( struct AranyaAddTeamConfigBuilder *  cfg, struct AranyaAddTeamConfig *  out  )

related

Attempts to construct an `AranyaAddTeamConfig`.

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

Parameters

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

aranya_add_team_config_build_ext()

AranyaError aranya_add_team_config_build_ext ( struct AranyaAddTeamConfigBuilder *  cfg, struct AranyaAddTeamConfig *  out, struct AranyaExtError *  __ext_err  )

related

Attempts to construct an `AranyaAddTeamConfig`.

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

Parameters

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

aranya_add_team_config_builder_cleanup()

AranyaError aranya_add_team_config_builder_cleanup ( struct AranyaAddTeamConfigBuilder *  ptr )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_add_team_config_builder_init.

aranya_add_team_config_builder_init()

AranyaError aranya_add_team_config_builder_init ( struct AranyaAddTeamConfigBuilder *  out )

related

Initializes AranyaAddTeamConfigBuilder.

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

aranya_add_team_config_builder_set_id()

AranyaError aranya_add_team_config_builder_set_id ( struct AranyaAddTeamConfigBuilder *  cfg, const struct AranyaTeamId *  team_id  )

related

Configures team ID field for `AranyaAddTeamConfigBuilder`.

By default, the team ID is not set.

Parameters

[in,out]	cfg	a pointer to the builder for a team config
[in]	id	a pointer to a

aranya_add_team_config_builder_set_id_ext()

AranyaError aranya_add_team_config_builder_set_id_ext ( struct AranyaAddTeamConfigBuilder *  cfg, const struct AranyaTeamId *  team_id, struct AranyaExtError *  __ext_err  )

related

Configures team ID field for `AranyaAddTeamConfigBuilder`.

By default, the team ID is not set.

Parameters

[in,out]	cfg	a pointer to the builder for a team config
[in]	id	a pointer to a

aranya_add_team_config_builder_set_quic_syncer()

AranyaError aranya_add_team_config_builder_set_quic_syncer ( struct AranyaAddTeamConfigBuilder *  cfg, struct AranyaAddTeamQuicSyncConfig *  quic  )

related

Configures QUIC syncer for `AranyaAddTeamConfigBuilder`.

By default, the QUIC syncer config is not set.

Parameters

[in,out]	cfg	a pointer to the builder for a team config
[in]	quic	set the QUIC syncer config

aranya_add_team_config_builder_set_quic_syncer_ext()

AranyaError aranya_add_team_config_builder_set_quic_syncer_ext ( struct AranyaAddTeamConfigBuilder *  cfg, struct AranyaAddTeamQuicSyncConfig *  quic, struct AranyaExtError *  __ext_err  )

related

Configures QUIC syncer for `AranyaAddTeamConfigBuilder`.

By default, the QUIC syncer config is not set.

Parameters

[in,out]	cfg	a pointer to the builder for a team config
[in]	quic	set the QUIC syncer config

---

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

• output/aranya-client.h