AranyaClient Struct Reference

A handle to an Aranya Client. More...

#include <aranya-client.h>

Related Symbols
(Note that these are not member symbols.)
AranyaError	aranya_client_cleanup (struct AranyaClient *ptr)
	Releases any resources associated with ptr.
AranyaError	aranya_client_cleanup_ext (struct AranyaClient *ptr, struct AranyaExtError *__ext_err)
	Releases any resources associated with ptr.
AranyaError	aranya_client_init (struct AranyaClient *client, const struct AranyaClientConfig *config)
	Initializes a new client instance.
AranyaError	aranya_client_init_ext (struct AranyaClient *client, const struct AranyaClientConfig *config, struct AranyaExtError *__ext_err)
	Initializes a new client instance.
AranyaError	aranya_get_key_bundle (struct AranyaClient *client, struct AranyaKeyBundle *__output)
	Gets the public key bundle for this device.
AranyaError	aranya_get_key_bundle_ext (struct AranyaClient *client, struct AranyaKeyBundle *__output, struct AranyaExtError *__ext_err)
	Gets the public key bundle for this device.
AranyaError	aranya_get_device_id (struct AranyaClient *client, struct AranyaDeviceId *__output)
	Gets the public device ID.
AranyaError	aranya_get_device_id_ext (struct AranyaClient *client, struct AranyaDeviceId *__output, struct AranyaExtError *__ext_err)
	Gets the public device ID.
AranyaError	aranya_create_team (struct AranyaClient *client, struct AranyaTeamId *__output)
	Create a new graph/team with the current device as the owner.
AranyaError	aranya_create_team_ext (struct AranyaClient *client, struct AranyaTeamId *__output, struct AranyaExtError *__ext_err)
	Create a new graph/team with the current device as the owner.
AranyaError	aranya_add_team (struct AranyaClient *client, const struct AranyaTeamId *team)
	Add a team to the local device store.
AranyaError	aranya_add_team_ext (struct AranyaClient *client, const struct AranyaTeamId *team, struct AranyaExtError *__ext_err)
	Add a team to the local device store.
AranyaError	aranya_remove_team (struct AranyaClient *client, const struct AranyaTeamId *team)
	Remove a team from the local device store.
AranyaError	aranya_remove_team_ext (struct AranyaClient *client, const struct AranyaTeamId *team, struct AranyaExtError *__ext_err)
	Remove a team from the local device store.
AranyaError	aranya_add_sync_peer (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaAddr addr, AranyaDuration interval)
	Add the peer for automatic periodic Aranya state syncing.
AranyaError	aranya_add_sync_peer_ext (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaAddr addr, AranyaDuration interval, struct AranyaExtError *__ext_err)
	Add the peer for automatic periodic Aranya state syncing.
AranyaError	aranya_remove_sync_peer (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaAddr addr)
	Remove the peer from automatic Aranya state syncing.
AranyaError	aranya_remove_sync_peer_ext (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaAddr addr, struct AranyaExtError *__ext_err)
	Remove the peer from automatic Aranya state syncing.
AranyaError	aranya_close_team (struct AranyaClient *client, const struct AranyaTeamId *team)
	Close the team and stop all operations on the graph.
AranyaError	aranya_close_team_ext (struct AranyaClient *client, const struct AranyaTeamId *team, struct AranyaExtError *__ext_err)
	Close the team and stop all operations on the graph.
AranyaError	aranya_add_device_to_team (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaKeyBundle *keys)
	Add a device to the team with the default role.
AranyaError	aranya_add_device_to_team_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaKeyBundle *keys, struct AranyaExtError *__ext_err)
	Add a device to the team with the default role.
AranyaError	aranya_remove_device_from_team (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device)
	Remove a device from the team.
AranyaError	aranya_remove_device_from_team_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, struct AranyaExtError *__ext_err)
	Remove a device from the team.
AranyaError	aranya_assign_role (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaRole role)
	Assign a role to a device.
AranyaError	aranya_assign_role_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaRole role, struct AranyaExtError *__ext_err)
	Assign a role to a device.
AranyaError	aranya_revoke_role (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaRole role)
	Revoke a role from a device.
AranyaError	aranya_revoke_role_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaRole role, struct AranyaExtError *__ext_err)
	Revoke a role from a device.
AranyaError	aranya_assign_net_identifier (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaNetIdentifier net_identifier)
	Associate a network identifier to a device for use with AFC.
AranyaError	aranya_assign_net_identifier_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaNetIdentifier net_identifier, struct AranyaExtError *__ext_err)
	Associate a network identifier to a device for use with AFC.
AranyaError	aranya_remove_net_identifier (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaNetIdentifier net_identifier)
	Disassociate a network identifier from a device.
AranyaError	aranya_remove_net_identifier_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaNetIdentifier net_identifier, struct AranyaExtError *__ext_err)
	Disassociate a network identifier from a device.
AranyaError	aranya_create_label (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaLabel label)
	Create an AFC label.
AranyaError	aranya_create_label_ext (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaLabel label, struct AranyaExtError *__ext_err)
	Create an AFC label.
AranyaError	aranya_delete_label (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaLabel label)
	Delete an AFC label.
AranyaError	aranya_delete_label_ext (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaLabel label, struct AranyaExtError *__ext_err)
	Delete an AFC label.
AranyaError	aranya_assign_label (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaLabel label)
	Assign an AFC label to a device so that it can be used for an AFC channel.
AranyaError	aranya_assign_label_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaLabel label, struct AranyaExtError *__ext_err)
	Assign an AFC label to a device so that it can be used for an AFC channel.
AranyaError	aranya_revoke_label (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaLabel label)
	Revoke an AFC label from a device.
AranyaError	aranya_revoke_label_ext (struct AranyaClient *client, const struct AranyaTeamId *team, const struct AranyaDeviceId *device, AranyaLabel label, struct AranyaExtError *__ext_err)
	Revoke an AFC label from a device.
AranyaError	aranya_create_bidi_channel (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaNetIdentifier peer, AranyaLabel label, struct AranyaChannelId *__output)
	Create an Aranya Fast Channel (AFC).
AranyaError	aranya_create_bidi_channel_ext (struct AranyaClient *client, const struct AranyaTeamId *team, AranyaNetIdentifier peer, AranyaLabel label, struct AranyaChannelId *__output, struct AranyaExtError *__ext_err)
	Create an Aranya Fast Channel (AFC).
AranyaError	aranya_delete_channel (struct AranyaClient *client, struct AranyaChannelId chan)
	Delete an Aranya Fast Channel (AFC).
AranyaError	aranya_delete_channel_ext (struct AranyaClient *client, struct AranyaChannelId chan, struct AranyaExtError *__ext_err)
	Delete an Aranya Fast Channel (AFC).
AranyaError	aranya_poll_data (struct AranyaClient *client, AranyaDuration timeout)
	Poll for new Aranya Fast Channels (AFC) data.
AranyaError	aranya_poll_data_ext (struct AranyaClient *client, AranyaDuration timeout, struct AranyaExtError *__ext_err)
	Poll for new Aranya Fast Channels (AFC) data.
AranyaError	aranya_send_data (struct AranyaClient *client, struct AranyaChannelId chan, const uint8_t *data, size_t data_len)
	Send Aranya Fast Channels (AFC) data.
AranyaError	aranya_send_data_ext (struct AranyaClient *client, struct AranyaChannelId chan, const uint8_t *data, size_t data_len, struct AranyaExtError *__ext_err)
	Send Aranya Fast Channels (AFC) data.
AranyaError	aranya_recv_data (struct AranyaClient *client, uint8_t *buf, size_t *buf_len, struct AranyaAfcMsgInfo *info)
	Receive Aranya Fast Channels (AFC) data.
AranyaError	aranya_recv_data_ext (struct AranyaClient *client, uint8_t *buf, size_t *buf_len, struct AranyaAfcMsgInfo *info, struct AranyaExtError *__ext_err)
	Receive Aranya Fast Channels (AFC) data.

Detailed Description

A handle to an Aranya Client.

Friends And Related Symbol Documentation

aranya_add_device_to_team()

AranyaError aranya_add_device_to_team ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaKeyBundle * keys )

related

Add a device to the team with the default role.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
keys	the device's public key bundle AranyaKeyBundle.

aranya_add_device_to_team_ext()

AranyaError aranya_add_device_to_team_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaKeyBundle * keys, struct AranyaExtError * __ext_err )

related

Add a device to the team with the default role.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
keys	the device's public key bundle AranyaKeyBundle.

aranya_add_sync_peer()

AranyaError aranya_add_sync_peer ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaAddr addr, AranyaDuration interval )

related

Add the peer for automatic periodic Aranya state syncing.

If a peer is not reachable on the network, sync errors will appear in the tracing logs and Aranya will be unable to sync state with that peer.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
addr	the peer's Aranya network address AranyaAddr.
interval	the time AranyaDuration to wait between syncs with peer.

aranya_add_sync_peer_ext()

AranyaError aranya_add_sync_peer_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaAddr addr, AranyaDuration interval, struct AranyaExtError * __ext_err )

related

Add the peer for automatic periodic Aranya state syncing.

If a peer is not reachable on the network, sync errors will appear in the tracing logs and Aranya will be unable to sync state with that peer.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
addr	the peer's Aranya network address AranyaAddr.
interval	the time AranyaDuration to wait between syncs with peer.

aranya_add_team()

AranyaError aranya_add_team ( struct AranyaClient * client, const struct AranyaTeamId * team )

related

Add a team to the local device store.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_add_team_ext()

AranyaError aranya_add_team_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, struct AranyaExtError * __ext_err )

related

Add a team to the local device store.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_assign_label()

AranyaError aranya_assign_label ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaLabel label )

related

Assign an AFC label to a device so that it can be used for an AFC channel.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device ID AranyaDeviceId of the device to assign the label to.
label	the AFC channel label AranyaLabel.

aranya_assign_label_ext()

AranyaError aranya_assign_label_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaLabel label, struct AranyaExtError * __ext_err )

related

Assign an AFC label to a device so that it can be used for an AFC channel.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device ID AranyaDeviceId of the device to assign the label to.
label	the AFC channel label AranyaLabel.

aranya_assign_net_identifier()

AranyaError aranya_assign_net_identifier ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaNetIdentifier net_identifier )

related

Associate a network identifier to a device for use with AFC.

Permission to perform this operation is checked against the Aranya policy.

If the address already exists for this device, it is replaced with the new address. Capable of resolving addresses via DNS, required to be statically mapped to IPV4. For use with OpenChannel and receiving messages. Can take either DNS name or IPV4.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
net_identifier	the device's network identifier AranyaNetIdentifier.

aranya_assign_net_identifier_ext()

AranyaError aranya_assign_net_identifier_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaNetIdentifier net_identifier, struct AranyaExtError * __ext_err )

related

Associate a network identifier to a device for use with AFC.

Permission to perform this operation is checked against the Aranya policy.

If the address already exists for this device, it is replaced with the new address. Capable of resolving addresses via DNS, required to be statically mapped to IPV4. For use with OpenChannel and receiving messages. Can take either DNS name or IPV4.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
net_identifier	the device's network identifier AranyaNetIdentifier.

aranya_assign_role()

AranyaError aranya_assign_role ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaRole role )

related

Assign a role to a device.

This will change the device's current role to the new role assigned.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
role	the role AranyaRole to assign to the device.

aranya_assign_role_ext()

AranyaError aranya_assign_role_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaRole role, struct AranyaExtError * __ext_err )

related

Assign a role to a device.

This will change the device's current role to the new role assigned.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
role	the role AranyaRole to assign to the device.

aranya_client_cleanup()

AranyaError aranya_client_cleanup ( struct AranyaClient * ptr )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_client_init.

aranya_client_cleanup_ext()

AranyaError aranya_client_cleanup_ext ( struct AranyaClient * ptr, struct AranyaExtError * __ext_err )

related

Releases any resources associated with ptr.

ptr must either be null or initialized by aranya_client_init.

aranya_client_init()

AranyaError aranya_client_init ( struct AranyaClient * client, const struct AranyaClientConfig * config )

related

Initializes a new client instance.

Parameters

client	the uninitialized Aranya Client AranyaClient.
config	the client's configuration AranyaClientConfig.

aranya_client_init_ext()

AranyaError aranya_client_init_ext ( struct AranyaClient * client, const struct AranyaClientConfig * config, struct AranyaExtError * __ext_err )

related

Initializes a new client instance.

Parameters

client	the uninitialized Aranya Client AranyaClient.
config	the client's configuration AranyaClientConfig.

aranya_close_team()

AranyaError aranya_close_team ( struct AranyaClient * client, const struct AranyaTeamId * team )

related

Close the team and stop all operations on the graph.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_close_team_ext()

AranyaError aranya_close_team_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, struct AranyaExtError * __ext_err )

related

Close the team and stop all operations on the graph.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_create_bidi_channel()

AranyaError aranya_create_bidi_channel ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaNetIdentifier peer, AranyaLabel label, struct AranyaChannelId * __output )

related

Create an Aranya Fast Channel (AFC).

Creates a bidirectional AFC channel between the current device and another peer.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
peer	the peer's network identifier AranyaNetIdentifier.
label	the AFC channel label AranyaLabel to create the channel with.
__output	the channel's ID AranyaChannelId

aranya_create_bidi_channel_ext()

AranyaError aranya_create_bidi_channel_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaNetIdentifier peer, AranyaLabel label, struct AranyaChannelId * __output, struct AranyaExtError * __ext_err )

related

Create an Aranya Fast Channel (AFC).

Creates a bidirectional AFC channel between the current device and another peer.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
peer	the peer's network identifier AranyaNetIdentifier.
label	the AFC channel label AranyaLabel to create the channel with.
__output	the channel's ID AranyaChannelId

aranya_create_label()

AranyaError aranya_create_label ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaLabel label )

related

Create an AFC label.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
label	the AFC channel label AranyaLabel to create.

aranya_create_label_ext()

AranyaError aranya_create_label_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaLabel label, struct AranyaExtError * __ext_err )

related

Create an AFC label.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
label	the AFC channel label AranyaLabel to create.

aranya_create_team()

AranyaError aranya_create_team ( struct AranyaClient * client, struct AranyaTeamId * __output )

related

Create a new graph/team with the current device as the owner.

Parameters

client	the Aranya Client AranyaClient.
__output	the team's ID AranyaTeamId.

aranya_create_team_ext()

AranyaError aranya_create_team_ext ( struct AranyaClient * client, struct AranyaTeamId * __output, struct AranyaExtError * __ext_err )

related

Create a new graph/team with the current device as the owner.

Parameters

client	the Aranya Client AranyaClient.
__output	the team's ID AranyaTeamId.

aranya_delete_channel()

AranyaError aranya_delete_channel ( struct AranyaClient * client, struct AranyaChannelId chan )

related

Delete an Aranya Fast Channel (AFC).

Parameters

client	the Aranya Client AranyaClient.
chan	the AFC channel ID AranyaChannelId of the channel to delete.

aranya_delete_channel_ext()

AranyaError aranya_delete_channel_ext ( struct AranyaClient * client, struct AranyaChannelId chan, struct AranyaExtError * __ext_err )

related

Delete an Aranya Fast Channel (AFC).

Parameters

client	the Aranya Client AranyaClient.
chan	the AFC channel ID AranyaChannelId of the channel to delete.

aranya_delete_label()

AranyaError aranya_delete_label ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaLabel label )

related

Delete an AFC label.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
label	the AFC channel label AranyaLabel to delete.

aranya_delete_label_ext()

AranyaError aranya_delete_label_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaLabel label, struct AranyaExtError * __ext_err )

related

Delete an AFC label.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
label	the AFC channel label AranyaLabel to delete.

aranya_get_device_id()

AranyaError aranya_get_device_id ( struct AranyaClient * client, struct AranyaDeviceId * __output )

related

Gets the public device ID.

Parameters

client	the Aranya Client AranyaClient.
__output	the client's device ID AranyaDeviceId.

aranya_get_device_id_ext()

AranyaError aranya_get_device_id_ext ( struct AranyaClient * client, struct AranyaDeviceId * __output, struct AranyaExtError * __ext_err )

related

Gets the public device ID.

Parameters

client	the Aranya Client AranyaClient.
__output	the client's device ID AranyaDeviceId.

aranya_get_key_bundle()

AranyaError aranya_get_key_bundle ( struct AranyaClient * client, struct AranyaKeyBundle * __output )

related

Gets the public key bundle for this device.

Parameters

client	the Aranya Client AranyaClient.
__output	the client's key bundle AranyaKeyBundle.

aranya_get_key_bundle_ext()

AranyaError aranya_get_key_bundle_ext ( struct AranyaClient * client, struct AranyaKeyBundle * __output, struct AranyaExtError * __ext_err )

related

Gets the public key bundle for this device.

Parameters

client	the Aranya Client AranyaClient.
__output	the client's key bundle AranyaKeyBundle.

aranya_poll_data()

AranyaError aranya_poll_data ( struct AranyaClient * client, AranyaDuration timeout )

related

Poll for new Aranya Fast Channels (AFC) data.

If the operation times out, this will return an ARANYA_ERROR_TIMEOUT.

Parameters

client	the Aranya Client AranyaClient.
timeout	how long to wait before timing out the poll operation AranyaDuration.

aranya_poll_data_ext()

AranyaError aranya_poll_data_ext ( struct AranyaClient * client, AranyaDuration timeout, struct AranyaExtError * __ext_err )

related

Poll for new Aranya Fast Channels (AFC) data.

If the operation times out, this will return an ARANYA_ERROR_TIMEOUT.

Parameters

client	the Aranya Client AranyaClient.
timeout	how long to wait before timing out the poll operation AranyaDuration.

aranya_recv_data()

AranyaError aranya_recv_data ( struct AranyaClient * client, uint8_t * buf, size_t * buf_len, struct AranyaAfcMsgInfo * info )

related

Receive Aranya Fast Channels (AFC) data.

Parameters

client	the Aranya Client.
buf	buffer to store message into.
buf_len	length of buffer.
info	information about the message AranyaAfcMsgInfo.

aranya_recv_data_ext()

AranyaError aranya_recv_data_ext ( struct AranyaClient * client, uint8_t * buf, size_t * buf_len, struct AranyaAfcMsgInfo * info, struct AranyaExtError * __ext_err )

related

Receive Aranya Fast Channels (AFC) data.

Parameters

client	the Aranya Client.
buf	buffer to store message into.
buf_len	length of buffer.
info	information about the message AranyaAfcMsgInfo.

aranya_remove_device_from_team()

AranyaError aranya_remove_device_from_team ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device )

related

Remove a device from the team.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.

aranya_remove_device_from_team_ext()

AranyaError aranya_remove_device_from_team_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, struct AranyaExtError * __ext_err )

related

Remove a device from the team.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.

aranya_remove_net_identifier()

AranyaError aranya_remove_net_identifier ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaNetIdentifier net_identifier )

related

Disassociate a network identifier from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
net_identifier	the device's network identifier AranyaNetIdentifier.

aranya_remove_net_identifier_ext()

AranyaError aranya_remove_net_identifier_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaNetIdentifier net_identifier, struct AranyaExtError * __ext_err )

related

Disassociate a network identifier from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
net_identifier	the device's network identifier AranyaNetIdentifier.

aranya_remove_sync_peer()

AranyaError aranya_remove_sync_peer ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaAddr addr )

related

Remove the peer from automatic Aranya state syncing.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
addr	the peer's Aranya network address AranyaAddr.

aranya_remove_sync_peer_ext()

AranyaError aranya_remove_sync_peer_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, AranyaAddr addr, struct AranyaExtError * __ext_err )

related

Remove the peer from automatic Aranya state syncing.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
addr	the peer's Aranya network address AranyaAddr.

aranya_remove_team()

AranyaError aranya_remove_team ( struct AranyaClient * client, const struct AranyaTeamId * team )

related

Remove a team from the local device store.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_remove_team_ext()

AranyaError aranya_remove_team_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, struct AranyaExtError * __ext_err )

related

Remove a team from the local device store.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.

aranya_revoke_label()

AranyaError aranya_revoke_label ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaLabel label )

related

Revoke an AFC label from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device ID AranyaDeviceId of the device to revoke the label from.
label	the AFC channel label AranyaLabel.

aranya_revoke_label_ext()

AranyaError aranya_revoke_label_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaLabel label, struct AranyaExtError * __ext_err )

related

Revoke an AFC label from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device ID AranyaDeviceId of the device to revoke the label from.
label	the AFC channel label AranyaLabel.

aranya_revoke_role()

AranyaError aranya_revoke_role ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaRole role )

related

Revoke a role from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
role	the role AranyaRole to revoke from the device.

aranya_revoke_role_ext()

AranyaError aranya_revoke_role_ext ( struct AranyaClient * client, const struct AranyaTeamId * team, const struct AranyaDeviceId * device, AranyaRole role, struct AranyaExtError * __ext_err )

related

Revoke a role from a device.

Permission to perform this operation is checked against the Aranya policy.

Parameters

client	the Aranya Client AranyaClient.
team	the team's ID AranyaTeamId.
device	the device's ID AranyaDeviceId.
role	the role AranyaRole to revoke from the device.

aranya_send_data()

AranyaError aranya_send_data ( struct AranyaClient * client, struct AranyaChannelId chan, const uint8_t * data, size_t data_len )

related

Send Aranya Fast Channels (AFC) data.

Parameters

client	the Aranya Client AranyaClient.
chan	the AFC channel's ID AranyaChannelId.
data	raw bytes of data to send.
data_len	length of data to send.

aranya_send_data_ext()

AranyaError aranya_send_data_ext ( struct AranyaClient * client, struct AranyaChannelId chan, const uint8_t * data, size_t data_len, struct AranyaExtError * __ext_err )

related

Send Aranya Fast Channels (AFC) data.

Parameters

client	the Aranya Client AranyaClient.
chan	the AFC channel's ID AranyaChannelId.
data	raw bytes of data to send.
data_len	length of data to send.

---

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

• output/aranya-client.h