MX Foundation 4
Functions
Connection
Multiprotocol Functions Reference » System

Functions

uint32 mxfServerConnect (const char *url, const char *userName, const char *password, uint64 exclusive, HMXF_SERVER *server)
 
uint32 mxfConnectEthernet (const char *url, const char *userName, const char *password, uint64 exclusive, HMXF_SERVER *server)
 
uint32 mxfConnectPCIE (HMXF_SERVER *server)
 
uint32 mxfConnectUSB (uint64 usbDeviceNumber, HMXF_SERVER *server)
 
uint32 mxfServerDisconnect (HMXF_SERVER server)
 

Detailed Description

Function Documentation

uint32 mxfServerConnect ( const char *  url,
const char *  userName,
const char *  password,
uint64  exclusive,
HMXF_SERVER *  server 
)
C#
public static extern UInt32 mxfServerConnect(string url, string username, string password, UInt64 exclusive, out UInt64 server);

Connects to MX Foundation's server (local or Ethernet).

An Ethernet client can have a maximum of 64 open connections to Ethernet servers.

Parameters
[in]urlurl or IPv4 network address in dot-decimal notation (max 128 characters). For local connection, use 0.0.0.0 as url.
[in]userNameuser name (max 128 characters). For local connection, user name must be an empty string.
[in]passwordpassword (max 128 characters). For local connection, password must be an empty string.
[in]exclusivespecify if exclusive control of the server is required (TRUE/FALSE). For local connection, exclusive must be false.
[out]serverserver handle returned
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
See Client/Server chapter for more information about connection and privileges.
Availability:
Available in MX Foundation 4.0 and later. Deprecated, use mxfConnectEthernet(), mxfConnectPCIE() or mxfConnectUSB() instead.
See also
mxfConnectEthernet()
mxfConnectPCIE()
mxfConnectUSB()
mxfServerVersionGet()
mxfServerDisconnect()
Examples:
adc.c, adc_buffer_threshold.c, adc_internal_calib.c, adc_sampling.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar429_selftest.c, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar664_sampling.c, ar664_sampling.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.c, ar708_sampling.cs, ar708_trigger.c, ar708_trigger.cs, ar708_tx_error_injection.c, ar708_tx_error_injection.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bc.c, ascb_bm.c, ascb_user.c, async.c, async.cs, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, canbus_sampling.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, csdb_rx_sampling.cs, dac.c, dac_buffer_threshold.c, dac_relative_timing.c, device_info.c, device_info.cs, discrete.c, discrete.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexadc_sampling.c, flexdac.c, flexdac_buffer_threshold.c, flexdac_relative_timing.c, flexdio.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_fifo_sampling.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, ipm_async_rs485_9bit.c, irigb_1pps.c, irigb_1pps.cs, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, mil1553_embedded_update_embedded.c, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, pulse.c, relaybox.c, relaybox.cs, relaybox_demo.c, relaybox_demo.cs, selfTests.c, selfTests.cs, write_read_async.c, and write_read_async.cs.
uint32 mxfConnectEthernet ( const char *  url,
const char *  userName,
const char *  password,
uint64  exclusive,
HMXF_SERVER *  server 
)
C#
public static extern UInt32 mxfConnectEthernet(string url, string username, string password, UInt64 exclusive, out UInt64 server);

Connects to MX Foundation's Ethernet server.

An Ethernet client can have a maximum of 64 open connections to Ethernet servers.

Parameters
[in]urlurl or IPv4 network address in dot-decimal notation (max 128 characters).
[in]userNameuser name (max 128 characters).
[in]passwordpassword (max 128 characters).
[in]exclusivespecify if exclusive control of the server is required (TRUE/FALSE).
[out]serverserver handle returned
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
See Client/Server chapter for more information about connection and privileges.
Availability:
Available in MX Foundation 4.6.4 and later.
See also
mxfConnectPCIE()
mxfConnectUSB()
mxfServerVersionGet()
mxfServerDisconnect()
Examples:
async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, csdb_flexsmp.c, csdb_flexsmp.cs, hdlc_flexsmp.c, and hdlc_flexsmp.cs.
uint32 mxfConnectPCIE ( HMXF_SERVER *  server)
C#
public static extern UInt32 mxfConnectPCIE(out UInt64 server);

Connects to MX Foundation's local server.

Parameters
[out]serverserver handle returned
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
See Client/Server chapter for more information about connection.
Availability:
Available in MX Foundation 4.6.4 and later.
See also
mxfConnectEthernet()
mxfConnectUSB()
mxfServerVersionGet()
mxfServerDisconnect()
Examples:
async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, csdb_flexsmp.c, csdb_flexsmp.cs, hdlc_flexsmp.c, and hdlc_flexsmp.cs.
uint32 mxfConnectUSB ( uint64  usbDeviceNumber,
HMXF_SERVER *  server 
)
C#
public static extern UInt32 mxfConnectUSB(UInt64 usbDeviceNumber, out UInt64 server);

Connects to MX Foundation's server over USB. mxfSystemUSBDetect() function must be called before this function. Only one connection is allowed by USB device.

Parameters
[in]usbDeviceNumberindex of MAXT USB device (0 for first device, 1 for second device, ...).
[out]serverserver handle returned
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.6.4 and later.
See also
mxfConnectEthernet()
mxfConnectPCIE()
mxfSystemUSBDetect()
mxfServerDisconnect()
uint32 mxfServerDisconnect ( HMXF_SERVER  server)
C#
public static extern UInt32 mxfServerDisconnect(UInt64 server);

Disconnects a client application from a MX Foundation's server.

Parameters
[in]serverserver handle
Returns
MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.
Availability:
Available in MX Foundation 4.0 and later.
See also
mxfConnectEthernet()
mxfConnectPCIE()
mxfConnectUSB()
Examples:
adc.c, adc_buffer_threshold.c, adc_internal_calib.c, adc_sampling.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_comm_queues.c, ar429_comm_queues.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar429_selftest.c, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_error_injection_detection.c, ar629_error_injection_detection.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar629_updating_data_sampling.c, ar629_updating_data_sampling.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar664_sampling.c, ar664_sampling.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_event_handler.c, ar708_event_handler.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.c, ar708_sampling.cs, ar708_trigger.c, ar708_trigger.cs, ar708_tx_error_injection.c, ar708_tx_error_injection.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_embedded_recorder.c, ar717_embedded_recorder.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bc.c, ascb_bm.c, ascb_user.c, async.c, async.cs, async_flexsmp.c, async_flexsmp.cs, async_flexsmp_rs232.c, async_flexsmp_rs232.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, canbus_sampling.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_flexsmp.c, csdb_flexsmp.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, csdb_rx_sampling.cs, dac.c, dac_buffer_threshold.c, dac_relative_timing.c, device_info.c, device_info.cs, discrete.c, discrete.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_Multi.c, discrete_Multi.cs, discrete_pulse_clock.c, discrete_pulse_clock.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexadc_sampling.c, flexdac.c, flexdac_buffer_threshold.c, flexdac_relative_timing.c, flexdio.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_fifo_sampling.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_flexsmp.c, hdlc_flexsmp.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, ipm_async_rs485_9bit.c, irigb_1pps.c, irigb_1pps.cs, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_async_to_1553.cs, mil1553_embedded_update_embedded.c, mil1553_embedded_update_host.c, mil1553_embedded_update_host.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, pulse.c, relaybox.c, relaybox.cs, relaybox_demo.c, relaybox_demo.cs, selfTests.c, selfTests.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.
Updated 10/23/2023