1.1.2.4.21 DRV_G3_MACRT_EnableTX Function

C

void DRV_G3_MACRT_EnableTX (
    const DRV_HANDLE handle, 
    bool enable 
);

Summary

Enables/Disables PLC transmission.

Description

This function allows a client to enable or disable the PLC tranmission. If there is any transmission on going, it will be cancelled and notified through the TX confirm callback.

For PL360 this function does nothing.

Precondition

DRV_G3_MACRT_Open must have been called to obtain a valid opened device handle.

Parameters

ParamDescription
handleA valid open-instance handle, returned from the driver's open routine
enableSet true to enable PLC tranmission. Set false to disable it.

Returns

None.

Example

DRV_HANDLE handle; // Returned from DRV_G3_MACRT_Open

while (true)
{
    // ...
    if (cancel_tx)
    {
        DRV_G3_MACRT_EnableTX (handle, false);
    }
    else
    {
        DRV_G3_MACRT_EnableTX (handle, true);
    }
    // ...
}

Remarks

This function is only available for PL460 (MCC configuration).