AranyaCreateTeamQuicSyncConfigBuilder Struct Reference

A builder for initializing a `AranyaCreateTeamQuicSyncConfig`. More...

#include <aranya-client.h>

Related Symbols
(Note that these are not member symbols.)
AranyaError	aranya_create_team_quic_sync_config_builder_init (struct AranyaCreateTeamQuicSyncConfigBuilder *out)
	Initializes AranyaCreateTeamQuicSyncConfigBuilder.
AranyaError	aranya_create_team_quic_sync_config_builder_cleanup (struct AranyaCreateTeamQuicSyncConfigBuilder *ptr)
	Releases any resources associated with ptr.
AranyaError	aranya_create_team_quic_sync_config_generate (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg)
	Attempts to set PSK seed generation mode value on `AranyaCreateTeamQuicSyncConfigBuilder`.
AranyaError	aranya_create_team_quic_sync_config_generate_ext (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg, struct AranyaExtError *__ext_err)
	Attempts to set PSK seed generation mode value on `AranyaCreateTeamQuicSyncConfigBuilder`.
AranyaError	aranya_create_team_quic_sync_config_raw_seed_ikm (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg, const struct AranyaSeedIkm *ikm)
	Attempts to set raw PSK seed IKM value `AranyaSeedIkm` on `AranyaCreateTeamQuicSyncConfigBuilder`.
AranyaError	aranya_create_team_quic_sync_config_raw_seed_ikm_ext (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg, const struct AranyaSeedIkm *ikm, struct AranyaExtError *__ext_err)
	Attempts to set raw PSK seed IKM value `AranyaSeedIkm` on `AranyaCreateTeamQuicSyncConfigBuilder`.
AranyaError	aranya_create_team_quic_sync_config_build (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg, struct AranyaCreateTeamQuicSyncConfig *out)
	Attempts to construct a `AranyaCreateTeamQuicSyncConfig`.
AranyaError	aranya_create_team_quic_sync_config_build_ext (struct AranyaCreateTeamQuicSyncConfigBuilder *cfg, struct AranyaCreateTeamQuicSyncConfig *out, struct AranyaExtError *__ext_err)
	Attempts to construct a `AranyaCreateTeamQuicSyncConfig`.

Detailed Description

A builder for initializing a `AranyaCreateTeamQuicSyncConfig`.

The `AranyaCreateTeamQuicSyncConfig` is an optional part of initializing a `AranyaCreateTeamConfig`.

Friends And Related Symbol Documentation

aranya_create_team_quic_sync_config_build()

AranyaError aranya_create_team_quic_sync_config_build ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg, struct AranyaCreateTeamQuicSyncConfig *  out  )

related

Attempts to construct a `AranyaCreateTeamQuicSyncConfig`.

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

Parameters

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

aranya_create_team_quic_sync_config_build_ext()

AranyaError aranya_create_team_quic_sync_config_build_ext ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg, struct AranyaCreateTeamQuicSyncConfig *  out, struct AranyaExtError *  __ext_err  )

related

Attempts to construct a `AranyaCreateTeamQuicSyncConfig`.

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

Parameters

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

aranya_create_team_quic_sync_config_builder_cleanup()

AranyaError aranya_create_team_quic_sync_config_builder_cleanup ( struct AranyaCreateTeamQuicSyncConfigBuilder *  ptr )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_create_team_quic_sync_config_builder_init.

aranya_create_team_quic_sync_config_builder_init()

AranyaError aranya_create_team_quic_sync_config_builder_init ( struct AranyaCreateTeamQuicSyncConfigBuilder *  out )

related

Initializes AranyaCreateTeamQuicSyncConfigBuilder.

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

aranya_create_team_quic_sync_config_generate()

AranyaError aranya_create_team_quic_sync_config_generate ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg )

related

Attempts to set PSK seed generation mode value on `AranyaCreateTeamQuicSyncConfigBuilder`.

Parameters

[in,out]

cfg

a pointer to the quic sync config builder

This method will be removed soon since certificates will be used instead of PSKs in the future.

aranya_create_team_quic_sync_config_generate_ext()

AranyaError aranya_create_team_quic_sync_config_generate_ext ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg, struct AranyaExtError *  __ext_err  )

related

Attempts to set PSK seed generation mode value on `AranyaCreateTeamQuicSyncConfigBuilder`.

Parameters

[in,out]

cfg

a pointer to the quic sync config builder

This method will be removed soon since certificates will be used instead of PSKs in the future.

aranya_create_team_quic_sync_config_raw_seed_ikm()

AranyaError aranya_create_team_quic_sync_config_raw_seed_ikm ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg, const struct AranyaSeedIkm *  ikm  )

related

Attempts to set raw PSK seed IKM value `AranyaSeedIkm` on `AranyaCreateTeamQuicSyncConfigBuilder`.

Parameters

[in,out]	cfg	a pointer to the quic sync config builder
[in]	ikm	a pointer the raw PSK seed IKM

This method will be removed soon since certificates will be used instead of PSKs in the future.

aranya_create_team_quic_sync_config_raw_seed_ikm_ext()

AranyaError aranya_create_team_quic_sync_config_raw_seed_ikm_ext ( struct AranyaCreateTeamQuicSyncConfigBuilder *  cfg, const struct AranyaSeedIkm *  ikm, struct AranyaExtError *  __ext_err  )

related

Attempts to set raw PSK seed IKM value `AranyaSeedIkm` on `AranyaCreateTeamQuicSyncConfigBuilder`.

Parameters

[in,out]	cfg	a pointer to the quic sync config builder
[in]	ikm	a pointer the raw PSK seed IKM

This method will be removed soon since certificates will be used instead of PSKs in the future.

---

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

• output/aranya-client.h