Skip to main content
Header: ar_osal/api/ar_osal_log_pkt_op.h

Structures

ar_log_pkt_op_init_info_t

Members
ar_log_data_transport_t
The data transport to use when sending log packets.
ar_heap_info
Heap information used to identify memory allocated by the data transport.

Functions

ar_log_pkt_op_init

ar_log_pkt_op_init
Parameters
ar_log_pkt_op_init_info_t *
pointer to info structure containing heap and data transport information that is used to initialize the pai
Returns Success 0 Failure non-zero

ar_log_pkt_op_deinit

ar_log_pkt_op_deinit Deinitializes the utility and release any/all resources aquired \depends ar_log_pkt_op_init(…) must be called before this function
Returns Success returns a pointer to the allocated memory Failure returns null if the allocation fails

ar_log_pkt_get_max_size

ar_log_pkt_get_max_size Retrieve the max size of a log packet that can be sent through the data transport \depends ar_log_pkt_op_init(…) must be called before this function
Returns return the max log packet size

ar_log_pkt_alloc

ar_log_pkt_alloc
Parameters
uint16_t
the log code used for the packet. See ar_util_data_log_codes.h in the AR Util
uint32_t
the size of the packet to allocate
Returns Success returns a pointer to the allocated memory Failure returns null if the allocation fails

ar_log_pkt_commit

ar_log_pkt_commit
Parameters
void *
pointer to memory allocated through ar_log_pkt_alloc
Returns Success 0 Failure non-zero

ar_log_pkt_free

ar_log_pkt_free
Parameters
void *
pointer to memory allocated through ar_log_pkt_alloc
Returns n/a

ar_log_code_status

ar_log_code_status
Parameters
uint16_t
the log code to check. See ar_util_data_log_codes.h in the AR Util
Returns TRUE ENABLED FALSE DISABLED

Type Definitions

ar_log_data_transport_t

An enumeration of supported transports

ar_log_pkt_op_init_info_t

par_log_pkt_op_init_info_t

Enumerations

ar_log_data_transport_t

An enumeration of supported transports

Values