mbgtools-lx  4.2.8
MBG_MSG_CTL_s Struct Reference

A generic message send and receive control structure. More...

#include <gpsserio.h>

Data Structures

union  st
 

Data Fields

MBG_MSG_RCV_CTL rcv
 
MBG_MSG_XMT_CTL xmt
 
MBG_MUTEX dev_mutex
 Mutex to serialize device access. More...
 
int conn_type
 One of the MBG_CONN_TYPES. More...
 
uint32_t device_flags
 See MSG_CTL_DEVICE_FLAG_MSKS. More...
 
ulong msg_rcv_timeout
 Binary message receive timeout [ms]. More...
 
bool dev_has_receiver_info
 
MBG_XDEV_FEATURES xdev_features
 Receiver info plus extended device features. More...
 
MBG_NACK_HANDLER_FNCnack_handler_fnc
 See mbgextio_register_nack_callback. More...
 
MBG_ASYNC_MSG_HANDLER_FNCasync_msg_handler_fnc
 See mbgextio_register_async_msg_callback. More...
 
MBG_ASYNC_DATA_HANDLER_FNCasync_data_handler_fnc
 See mbgextio_register_async_data_callback. More...
 
MBG_ASYNC_DATA_RESET_FNCasync_data_reset_fnc
 See mbgextio_register_async_data_reset_callback. More...
 
MBG_TLV_RCV_STATE tlv_rcv_state
 
union MBG_MSG_CTL_s::st st
 
void * priv_data
 

Detailed Description

A generic message send and receive control structure.

Definition at line 1972 of file gpsserio.h.

Field Documentation

◆ async_data_handler_fnc

MBG_ASYNC_DATA_HANDLER_FNC* MBG_MSG_CTL_s::async_data_handler_fnc

◆ async_data_reset_fnc

◆ async_msg_handler_fnc

◆ conn_type

int MBG_MSG_CTL_s::conn_type

◆ dev_has_receiver_info

bool MBG_MSG_CTL_s::dev_has_receiver_info

Definition at line 1986 of file gpsserio.h.

Referenced by chk_get_rcvr_info().

◆ dev_mutex

MBG_MUTEX MBG_MSG_CTL_s::dev_mutex

Mutex to serialize device access.

Definition at line 1978 of file gpsserio.h.

Referenced by dev_open_finish_setup(), mbgextio_close_connection(), mbgextio_fw_ufu_flash(), mbgextio_get_event_value_idx(), mbgextio_get_xmr_status_idx(), mbgextio_rcv_msg(), mbgextio_req_data(), mbgextio_req_data_idx(), mbgextio_send_database_cmd(), mbgextio_set_ant_cable_len(), mbgextio_set_database_settings_idx(), mbgextio_set_enable_flags(), mbgextio_set_event_settings_idx(), mbgextio_set_fdm_tdev(), mbgextio_set_gnss_mode_settings(), mbgextio_set_gpio_settings_idx(), mbgextio_set_holdover_interval(), mbgextio_set_hq_rx_settings(), mbgextio_set_hq_tx_settings(), mbgextio_set_ignore_lock(), mbgextio_set_ims_fdm_output_settings_idx(), mbgextio_set_ims_fdm_settings(), mbgextio_set_io_port_settings_idx(), mbgextio_set_ip4_settings(), mbgextio_set_irig_rx_settings(), mbgextio_set_irig_tx_settings(), mbgextio_set_led_settings_idx(), mbgextio_set_lne_port_settings_idx(), mbgextio_set_net_dns_srch_dom_idx(), mbgextio_set_net_dns_srvr_idx(), mbgextio_set_net_glb_cfg_settings(), mbgextio_set_net_intf_addr_settings_idx(), mbgextio_set_net_intf_link_settings_idx(), mbgextio_set_net_intf_route_settings_idx(), mbgextio_set_ntp_clnt_mode_cfg(), mbgextio_set_ntp_glb_info(), mbgextio_set_ntp_misc_orphan_mode_settings(), mbgextio_set_ntp_peer_settings_idx(), mbgextio_set_ntp_refclk_cfg_settings_idx(), mbgextio_set_ntp_srv_mode_cfg(), mbgextio_set_ntp_symm_key_settings_idx(), mbgextio_set_ntp_trusted_key_settings_idx(), mbgextio_set_opt_settings(), mbgextio_set_port_parm(), mbgextio_set_port_settings_idx(), mbgextio_set_pos_lla(), mbgextio_set_pout_settings_idx(), mbgextio_set_ptp_cfg_settings(), mbgextio_set_ptp_uc_master_settings_idx(), mbgextio_set_ptp_v1_current_dataset(), mbgextio_set_ptp_v1_default_dataset(), mbgextio_set_ptp_v1_parent_dataset(), mbgextio_set_ptp_v1_port_dataset_idx(), mbgextio_set_ptp_v1_time_properties_dataset(), mbgextio_set_ptp_v2_current_dataset(), mbgextio_set_ptp_v2_default_dataset(), mbgextio_set_ptp_v2_parent_dataset(), mbgextio_set_ptp_v2_port_dataset_idx(), mbgextio_set_ptp_v2_time_properties_dataset(), mbgextio_set_pwr_ctl(), mbgextio_set_ref_offs(), mbgextio_set_scu_stat_settings(), mbgextio_set_snmp_glb_settings(), mbgextio_set_snmp_v12_settings_idx(), mbgextio_set_snmp_v12_trap_settings_idx(), mbgextio_set_snmp_v3_settings_idx(), mbgextio_set_snmp_v3_trap_settings_idx(), mbgextio_set_svc_settings_idx(), mbgextio_set_synth(), mbgextio_set_syslog_glb_settings(), mbgextio_set_syslog_settings_idx(), mbgextio_set_time(), mbgextio_set_time_scale_settings(), mbgextio_set_tr_distance(), mbgextio_set_tzcode(), mbgextio_set_tzdl(), mbgextio_set_ucap_net_glb_settings(), mbgextio_set_ucap_net_recv_settings_idx(), mbgextio_set_user_level_settings_idx(), mbgextio_set_user_mngmnt_settings(), mbgextio_set_user_settings_idx(), mbgextio_set_utc_parm(), mbgextio_set_xmr_settings_idx(), mbgextio_setup_receiver_info(), mbgextio_xmt_cmd(), mbgextio_xmt_cmd_u32(), mbgextio_xmt_cmd_us(), and mbgextio_xmt_msg().

◆ device_flags

uint32_t MBG_MSG_CTL_s::device_flags

◆ msg_rcv_timeout

ulong MBG_MSG_CTL_s::msg_rcv_timeout

Binary message receive timeout [ms].

Definition at line 1983 of file gpsserio.h.

Referenced by mbgextio_rcv_msg_unlocked().

◆ nack_handler_fnc

MBG_NACK_HANDLER_FNC* MBG_MSG_CTL_s::nack_handler_fnc

◆ priv_data

void* MBG_MSG_CTL_s::priv_data

Definition at line 2041 of file gpsserio.h.

Referenced by dev_open_finish_setup().

◆ rcv

◆ st

◆ tlv_rcv_state

MBG_TLV_RCV_STATE MBG_MSG_CTL_s::tlv_rcv_state

While TLV messages are handled, this structure is used temporarily by some API functions to track the state of the TLV messages.

Definition at line 1996 of file gpsserio.h.

◆ xdev_features

MBG_XDEV_FEATURES MBG_MSG_CTL_s::xdev_features

Receiver info plus extended device features.

Definition at line 1987 of file gpsserio.h.

Referenced by mbgextio_chk_user_perm(), mbgextio_dev_has_ant_cable_length(), mbgextio_dev_has_ant_info(), mbgextio_dev_has_bvar_stat(), mbgextio_dev_has_clk_res_info(), mbgextio_dev_has_cmd_save_cfg(), mbgextio_dev_has_database(), mbgextio_dev_has_enable_flags(), mbgextio_dev_has_evt_log(), mbgextio_dev_has_ext_sys_info(), mbgextio_dev_has_fw_mngmnt(), mbgextio_dev_has_gnss_mode(), mbgextio_dev_has_gpio(), mbgextio_dev_has_gps_stat_info(), mbgextio_dev_has_ims(), mbgextio_dev_has_io_ports(), mbgextio_dev_has_irig_rx(), mbgextio_dev_has_irig_tx(), mbgextio_dev_has_lan_ip4(), mbgextio_dev_has_led_api(), mbgextio_dev_has_lne_api(), mbgextio_dev_has_monitoring(), mbgextio_dev_has_net_cfg(), mbgextio_dev_has_ntp(), mbgextio_dev_has_pos_lla(), mbgextio_dev_has_pos_xyz(), mbgextio_dev_has_prog_pulses(), mbgextio_dev_has_ptp(), mbgextio_dev_has_push_msgs(), mbgextio_dev_has_pwr_ctl_api(), mbgextio_dev_has_pzf(), mbgextio_dev_has_raw_irig_data(), mbgextio_dev_has_reboot(), mbgextio_dev_has_req_ttm(), mbgextio_dev_has_scu_stat(), mbgextio_dev_has_serouts(), mbgextio_dev_has_service(), mbgextio_dev_has_synth(), mbgextio_dev_has_tainted_cfg(), mbgextio_dev_has_time_scale(), mbgextio_dev_has_time_ttm(), mbgextio_dev_has_tlv_api(), mbgextio_dev_has_transactions(), mbgextio_dev_has_tzcode(), mbgextio_dev_has_tzdl(), mbgextio_dev_has_ucap(), mbgextio_dev_has_ucap_net(), mbgextio_dev_has_up_conv(), mbgextio_dev_has_user_auth(), mbgextio_dev_has_user_mngmnt(), mbgextio_dev_has_xbp(), mbgextio_dev_has_xmulti_ref(), mbgextio_dev_is_bus_lvl_dev(), mbgextio_dev_is_dcf(), mbgextio_dev_is_gnss(), mbgextio_dev_is_gps(), mbgextio_dev_is_tcr(), mbgextio_dev_supp_tlv_diag_file(), mbgextio_dev_supp_tlv_exec_cmd(), mbgextio_dev_supp_tlv_file_req(), mbgextio_dev_supp_tlv_fw_rollback(), mbgextio_dev_supp_tlv_fw_update(), mbgextio_dev_supp_tlv_ntp_license(), mbgextio_dev_supp_tlv_ptpv1_license(), mbgextio_dev_supp_tlv_ptpv2_license(), mbgextio_dev_supp_tlv_time_monitor_license(), mbgextio_dev_supp_tlv_ufu(), mbgextio_get_receiver_info_addr(), and mbgextio_setup_xdevfeat().

◆ xmt

MBG_MSG_XMT_CTL MBG_MSG_CTL_s::xmt

Definition at line 1975 of file gpsserio.h.

Referenced by dev_open_finish_setup(), mbgextio_fw_ufu_flash(), mbgextio_get_xmt_buffer_addr(), mbgextio_get_xmt_buffer_size(), mbgextio_send_database_cmd(), mbgextio_set_ant_cable_len(), mbgextio_set_database_settings_idx(), mbgextio_set_enable_flags(), mbgextio_set_event_settings_idx(), mbgextio_set_fdm_tdev(), mbgextio_set_gnss_mode_settings(), mbgextio_set_gpio_settings_idx(), mbgextio_set_holdover_interval(), mbgextio_set_hq_rx_settings(), mbgextio_set_hq_tx_settings(), mbgextio_set_ignore_lock(), mbgextio_set_ims_fdm_output_settings_idx(), mbgextio_set_ims_fdm_settings(), mbgextio_set_io_port_settings_idx(), mbgextio_set_ip4_settings(), mbgextio_set_irig_rx_settings(), mbgextio_set_irig_tx_settings(), mbgextio_set_led_settings_idx(), mbgextio_set_lne_port_settings_idx(), mbgextio_set_net_dns_srch_dom_idx(), mbgextio_set_net_dns_srvr_idx(), mbgextio_set_net_glb_cfg_settings(), mbgextio_set_net_intf_addr_settings_idx(), mbgextio_set_net_intf_link_settings_idx(), mbgextio_set_net_intf_route_settings_idx(), mbgextio_set_ntp_clnt_mode_cfg(), mbgextio_set_ntp_glb_info(), mbgextio_set_ntp_misc_orphan_mode_settings(), mbgextio_set_ntp_peer_settings_idx(), mbgextio_set_ntp_refclk_cfg_settings_idx(), mbgextio_set_ntp_srv_mode_cfg(), mbgextio_set_ntp_symm_key_settings_idx(), mbgextio_set_ntp_trusted_key_settings_idx(), mbgextio_set_opt_settings(), mbgextio_set_port_parm(), mbgextio_set_port_settings_idx(), mbgextio_set_pos_lla(), mbgextio_set_pout_settings_idx(), mbgextio_set_ptp_cfg_settings(), mbgextio_set_ptp_uc_master_settings_idx(), mbgextio_set_ptp_v1_current_dataset(), mbgextio_set_ptp_v1_default_dataset(), mbgextio_set_ptp_v1_parent_dataset(), mbgextio_set_ptp_v1_port_dataset_idx(), mbgextio_set_ptp_v1_time_properties_dataset(), mbgextio_set_ptp_v2_current_dataset(), mbgextio_set_ptp_v2_default_dataset(), mbgextio_set_ptp_v2_parent_dataset(), mbgextio_set_ptp_v2_port_dataset_idx(), mbgextio_set_ptp_v2_time_properties_dataset(), mbgextio_set_pwr_ctl(), mbgextio_set_ref_offs(), mbgextio_set_scu_stat_settings(), mbgextio_set_snmp_glb_settings(), mbgextio_set_snmp_v12_settings_idx(), mbgextio_set_snmp_v12_trap_settings_idx(), mbgextio_set_snmp_v3_settings_idx(), mbgextio_set_snmp_v3_trap_settings_idx(), mbgextio_set_svc_settings_idx(), mbgextio_set_synth(), mbgextio_set_syslog_glb_settings(), mbgextio_set_syslog_settings_idx(), mbgextio_set_time(), mbgextio_set_time_scale_settings(), mbgextio_set_tr_distance(), mbgextio_set_tzcode(), mbgextio_set_tzdl(), mbgextio_set_ucap_net_glb_settings(), mbgextio_set_ucap_net_recv_settings_idx(), mbgextio_set_user_level_settings_idx(), mbgextio_set_user_mngmnt_settings(), mbgextio_set_user_settings_idx(), mbgextio_set_utc_parm(), mbgextio_set_xmr_settings_idx(), and mbgextio_xmt_msg().


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