ipc_connectivity

Connectivity Service. More...

Data Structures
struct	a_ipc_dyn_array_enum_connectivity_result
	Dynamic-length array of a_ipc_enum_connectivity_result. More...
struct	a_ipc_dyn_array_enum_connectivity_consumers
	Dynamic-length array of a_ipc_enum_connectivity_consumers. More...
struct	a_ipc_dyn_array_enum_connectivity_providers
	Dynamic-length array of a_ipc_enum_connectivity_providers. More...
struct	a_ipc_struct_connectivity_provider_config_s
	Internal helper struct for connectivity_configure_consumer_req. More...
struct	a_ipc_msg_connectivity_configure_consumer_req
	Configure settings related to a connectivity consumer. More...
struct	a_ipc_msg_connectivity_configure_consumer_rsp
	Sent in response to a_ipc_msg_connectivity_configure_consumer_req. More...
struct	a_ipc_msg_connectivity_consumer_status_publish_ind
	Reports the status for each connectivity consumer. More...
struct	a_ipc_msg_connectivity_consumer_status_subscribe_req
	Subscribe to updates for connectivity_consumer_status. More...
struct	a_ipc_msg_connectivity_consumer_status_subscribe_rsp
	Sent in response to a_ipc_msg_connectivity_consumer_status_subscribe_req. More...
struct	a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp
	Unsubscribe from updates for connectivity_consumer_status. More...

Enumerations
enum	a_ipc_enum_connectivity_result { A_IPC_ENUM_CONNECTIVITY_RESULT_OK , A_IPC_ENUM_CONNECTIVITY_RESULT_FAILED , A_IPC_ENUM_CONNECTIVITY_RESULT_INVALID_CONFIG }
	Result of a connectivity service operations. More...
enum	a_ipc_enum_connectivity_consumers { A_IPC_ENUM_CONNECTIVITY_CONSUMERS_INVALID , A_IPC_ENUM_CONNECTIVITY_CONSUMERS_BASE_SYSTEM , A_IPC_ENUM_CONNECTIVITY_CONSUMERS_USERVM , A_IPC_ENUM_CONNECTIVITY_CONSUMERS_WIFI_AP }
	Consumers of connectivity within the system. More...
enum	a_ipc_enum_connectivity_providers {   A_IPC_ENUM_CONNECTIVITY_PROVIDERS_INVALID , A_IPC_ENUM_CONNECTIVITY_PROVIDERS_MODEM1 , A_IPC_ENUM_CONNECTIVITY_PROVIDERS_MODEM2 , A_IPC_ENUM_CONNECTIVITY_PROVIDERS_WIFI_STATION ,   A_IPC_ENUM_CONNECTIVITY_PROVIDERS_NO_PROVIDER }
	Providers of connectivity within the system. More...

Functions
A_IPC_RESULT	a_ipc_init_connectivity_configure_consumer_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_configure_consumer_req. More...
A_IPC_RESULT	a_ipc_init_connectivity_configure_consumer_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_configure_consumer_rsp. More...
A_IPC_RESULT	a_ipc_init_connectivity_consumer_status_publish_ind (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_publish_ind. More...
A_IPC_RESULT	a_ipc_init_connectivity_consumer_status_subscribe_req (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_subscribe_req. More...
A_IPC_RESULT	a_ipc_init_connectivity_consumer_status_subscribe_rsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_subscribe_rsp. More...
A_IPC_RESULT	a_ipc_init_connectivity_consumer_status_unsubscribe_req_norsp (a_ipc_msg *msg)
	Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp. More...

Detailed Description

Connectivity Service.

This page contains documentation of the Connectivity Service API.

---

Data Structure Documentation

a_ipc_dyn_array_enum_connectivity_result

struct a_ipc_dyn_array_enum_connectivity_result

Dynamic-length array of a_ipc_enum_connectivity_result.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_connectivity_result *	value	The contents of the array.

a_ipc_dyn_array_enum_connectivity_consumers

struct a_ipc_dyn_array_enum_connectivity_consumers

Dynamic-length array of a_ipc_enum_connectivity_consumers.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_connectivity_consumers *	value	The contents of the array.

a_ipc_dyn_array_enum_connectivity_providers

struct a_ipc_dyn_array_enum_connectivity_providers

Dynamic-length array of a_ipc_enum_connectivity_providers.

Data Fields
uint32_t	length	Length of the array (number of elements)
a_ipc_enum_connectivity_providers *	value	The contents of the array.

a_ipc_struct_connectivity_provider_config_s

struct a_ipc_struct_connectivity_provider_config_s

Internal helper struct for connectivity_configure_consumer_req.

Represents configuration of a single connectivity provider

Data Fields
uint32_t	flags	Flags. Reserved for future use. Ensure it is set to 0 for now
bool	is_enabled	Should the provider at all be enabled and selectable for the consumer.
uint8_t	priority	Priority of the provider relative to other providers. 0 highest priority

a_ipc_msg_connectivity_configure_consumer_req

struct a_ipc_msg_connectivity_configure_consumer_req

Configure settings related to a connectivity consumer.

Response is delivered in a_ipc_msg_connectivity_configure_consumer_rsp.

Create using a_ipc_init_connectivity_configure_consumer_req().

Message type is A_IPC_MSG_CONNECTIVITY_CONFIGURE_CONSUMER_REQ.

Data Fields
a_ipc_enum_connectivity_consumers	consumer	The connectivity consumer to configure.
a_ipc_struct_connectivity_provider_config_s	modem1	Configuration for modem 1 provider.
a_ipc_struct_connectivity_provider_config_s	modem2	Configuration for modem 2 provider.
a_ipc_struct_connectivity_provider_config_s	wifi_station	Configuration for wifi station provider.

a_ipc_msg_connectivity_configure_consumer_rsp

struct a_ipc_msg_connectivity_configure_consumer_rsp

Sent in response to a_ipc_msg_connectivity_configure_consumer_req.

Create using a_ipc_init_connectivity_configure_consumer_rsp().

Message type is A_IPC_MSG_CONNECTIVITY_CONFIGURE_CONSUMER_RSP.

Data Fields
a_ipc_enum_connectivity_consumers	consumer	The connectivity consumer to configure.
a_ipc_enum_connectivity_result	result	Result of the configure request.

a_ipc_msg_connectivity_consumer_status_publish_ind

struct a_ipc_msg_connectivity_consumer_status_publish_ind

Reports the status for each connectivity consumer.

Subscribe using a_ipc_msg_connectivity_consumer_status_subscribe_req and unsubscribe using a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp.

Create using a_ipc_init_connectivity_consumer_status_publish_ind().

Message type is A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_PUBLISH_IND.

Data Fields
a_ipc_enum_connectivity_providers	active_provider	The currently selected provider for the given consumer.
a_ipc_enum_connectivity_consumers	consumer	The consumer.
bool	has_internet_connection	If the consumer has internet connection, ie connectivity test either successful or the connectivity test has been ignored in the configuration.

a_ipc_msg_connectivity_consumer_status_subscribe_req

struct a_ipc_msg_connectivity_consumer_status_subscribe_req

Subscribe to updates for connectivity_consumer_status.

a_ipc_msg_connectivity_consumer_status_publish_ind will be received until a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp is sent.

Response is delivered in a_ipc_msg_connectivity_consumer_status_subscribe_rsp.

Create using a_ipc_init_connectivity_consumer_status_subscribe_req().

Message type is A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_SUBSCRIBE_REQ.

a_ipc_msg_connectivity_consumer_status_subscribe_rsp

struct a_ipc_msg_connectivity_consumer_status_subscribe_rsp

Sent in response to a_ipc_msg_connectivity_consumer_status_subscribe_req.

Create using a_ipc_init_connectivity_consumer_status_subscribe_rsp().

Message type is A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_SUBSCRIBE_RSP.

Data Fields
a_ipc_enum_ipc_subscribe_result	result	The result of the subscription request.

a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp

struct a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp

Unsubscribe from updates for connectivity_consumer_status.

a_ipc_msg_connectivity_consumer_status_publish_ind will no longer be received.

Create using a_ipc_init_connectivity_consumer_status_unsubscribe_req_norsp().

Message type is A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_UNSUBSCRIBE_REQ_NORSP.

Enumeration Type Documentation

a_ipc_enum_connectivity_consumers

enum a_ipc_enum_connectivity_consumers

Consumers of connectivity within the system.

Enumerator
A_IPC_ENUM_CONNECTIVITY_CONSUMERS_BASE_SYSTEM	The ACU6 base system and services.
A_IPC_ENUM_CONNECTIVITY_CONSUMERS_USERVM	The user VM internet bridge interface.
A_IPC_ENUM_CONNECTIVITY_CONSUMERS_WIFI_AP	The devices connected to WiFi AP.

a_ipc_enum_connectivity_providers

enum a_ipc_enum_connectivity_providers

Providers of connectivity within the system.

Enumerator
A_IPC_ENUM_CONNECTIVITY_PROVIDERS_MODEM1	NAD primary or only apn/connection.
A_IPC_ENUM_CONNECTIVITY_PROVIDERS_MODEM2	NAD secondary apn/connection.
A_IPC_ENUM_CONNECTIVITY_PROVIDERS_WIFI_STATION	WiFi station.
A_IPC_ENUM_CONNECTIVITY_PROVIDERS_NO_PROVIDER	Empty provider/no provider.

a_ipc_enum_connectivity_result

enum a_ipc_enum_connectivity_result

Result of a connectivity service operations.

Enumerator
A_IPC_ENUM_CONNECTIVITY_RESULT_OK	Operation completed successfully.
A_IPC_ENUM_CONNECTIVITY_RESULT_FAILED	Operation failed in some unspecified way.
A_IPC_ENUM_CONNECTIVITY_RESULT_INVALID_CONFIG	An invalid config was provided.

Function Documentation

a_ipc_init_connectivity_configure_consumer_req()

A_IPC_RESULT a_ipc_init_connectivity_configure_consumer_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_configure_consumer_req.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONFIGURE_CONSUMER_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_connectivity_configure_consumer_rsp()

A_IPC_RESULT a_ipc_init_connectivity_configure_consumer_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_configure_consumer_rsp.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONFIGURE_CONSUMER_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_connectivity_consumer_status_publish_ind()

A_IPC_RESULT a_ipc_init_connectivity_consumer_status_publish_ind

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_publish_ind.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_PUBLISH_IND.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_connectivity_consumer_status_subscribe_req()

A_IPC_RESULT a_ipc_init_connectivity_consumer_status_subscribe_req

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_subscribe_req.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_SUBSCRIBE_REQ.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_connectivity_consumer_status_subscribe_rsp()

A_IPC_RESULT a_ipc_init_connectivity_consumer_status_subscribe_rsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_subscribe_rsp.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_SUBSCRIBE_RSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

a_ipc_init_connectivity_consumer_status_unsubscribe_req_norsp()

A_IPC_RESULT a_ipc_init_connectivity_consumer_status_unsubscribe_req_norsp

(

a_ipc_msg *

msg

)

Initialize the message buffer to contain a_ipc_msg_connectivity_consumer_status_unsubscribe_req_norsp.

msg->info.type will be A_IPC_MSG_CONNECTIVITY_CONSUMER_STATUS_UNSUBSCRIBE_REQ_NORSP.

This function can be called on an already initialized message to change its type.

Parameters

msg	The message buffer to initialize

Variable Documentation

active_provider

a_ipc_enum_connectivity_providers a_ipc_msg_connectivity_consumer_status_publish_ind::active_provider

The currently selected provider for the given consumer.

consumer [1/3]

a_ipc_enum_connectivity_consumers a_ipc_msg_connectivity_configure_consumer_req::consumer

The connectivity consumer to configure.

consumer [2/3]

a_ipc_enum_connectivity_consumers a_ipc_msg_connectivity_configure_consumer_rsp::consumer

The connectivity consumer to configure.

consumer [3/3]

a_ipc_enum_connectivity_consumers a_ipc_msg_connectivity_consumer_status_publish_ind::consumer

The consumer.

flags

uint32_t a_ipc_struct_connectivity_provider_config_s::flags

Flags.

Reserved for future use. Ensure it is set to 0 for now

has_internet_connection

bool a_ipc_msg_connectivity_consumer_status_publish_ind::has_internet_connection

If the consumer has internet connection, ie connectivity test either successful or the connectivity test has been ignored in the configuration.

is_enabled

bool a_ipc_struct_connectivity_provider_config_s::is_enabled

Should the provider at all be enabled and selectable for the consumer.

modem1

a_ipc_struct_connectivity_provider_config_s a_ipc_msg_connectivity_configure_consumer_req::modem1

Configuration for modem 1 provider.

modem2

a_ipc_struct_connectivity_provider_config_s a_ipc_msg_connectivity_configure_consumer_req::modem2

Configuration for modem 2 provider.

priority

uint8_t a_ipc_struct_connectivity_provider_config_s::priority

Priority of the provider relative to other providers.

0 highest priority

result [1/2]

a_ipc_enum_connectivity_result a_ipc_msg_connectivity_configure_consumer_rsp::result

Result of the configure request.

result [2/2]

a_ipc_enum_ipc_subscribe_result a_ipc_msg_connectivity_consumer_status_subscribe_rsp::result

The result of the subscription request.

wifi_station

a_ipc_struct_connectivity_provider_config_s a_ipc_msg_connectivity_configure_consumer_req::wifi_station

Configuration for wifi station provider.