WorkerClearReceiveQueue Method

Discards all available messages from the default receive queue (index 0).

Definition

Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0

public void ClearReceiveQueue()

Public Sub ClearReceiveQueue

C++

public:
void ClearReceiveQueue()

Remarks

Unlike the Api class, the Worker class doesn't clear the receive queues on disconnect. A Worker object muss explicitly be instructed to clear its receive queues when deactivating the connection, i.e. by calling the Stop method, or by calling the ClearReceiveQueue/ClearAllReceiveQueues methods at any time.

This implies, that an application can keep processing messages after a connection to a PCAN Channel has been terminated.

Example

The following example shows how to clear the default receive queue (index 0).

In case of failure, an error messages is written to the console output using English as output language.

// Create the object using the default configuration
//
Worker myWorker = new Worker();

try
{ 
    // Activate the worker object
    //
    myWorker.Start();
    Console.WriteLine("The Worker object was activated successfully.");

    // Wait for sometime to get messages in the receive queue
    //
    Console.WriteLine("Waiting for messages......");
    System.Threading.Thread.Sleep(5000);

    // Get and show the amount of messages contained in the default receive queue (index 0)
    //
    Console.WriteLine($"There are {myWorker.GetAvailableMessagesCount()} messages in the default receive queue. ");

    // Clear the default receive queue and show the amount of messages in it again
    //
    myWorker.ClearReceiveQueue();
    Console.WriteLine($"There are {myWorker.GetAvailableMessagesCount()} messages in the default receive queue, after clearing it. ");

    // Deactivate the worker object, when it is no longer needed
    //
    myWorker.Stop();
    Console.WriteLine("The Worker object was deactivated.");
}
catch(Exception ex)
{
    Console.WriteLine($"An exception occurred by activating the Worker object. {ex.Message}");
}

' Create the object using the default configuration
'
Dim myWorker As Worker = New Worker()

Try
    ' Activate the worker object
    '
    myWorker.Start()
    Console.WriteLine("The Worker object was activated successfully.")

    ' Wait for sometime to get messages in the receive queue
    '
    Console.WriteLine("Waiting for messages......")
    Threading.Thread.Sleep(5000)

    ' Get and show the amount of messages contained in the default receive queue (index 0)
    '
    Console.WriteLine($"There are {myWorker.GetAvailableMessagesCount(0)} messages in the default receive queue. ")

    ' Clear the second receive queue and show the amount of messages in it again
    '
    myWorker.ClearReceiveQueue()
    Console.WriteLine($"There are {myWorker.GetAvailableMessagesCount()} messages in the default receive queue, after clearing it. ")

    ' Deactivate the worker object, when it is no longer needed
    '
    myWorker.[Stop]()
    Console.WriteLine("The Worker object was deactivated.")
Catch ex As Exception
    Console.WriteLine($"An exception occurred by activating the Worker object. {ex.Message}")
End Try

C++

// Create the object using the default configuration
//
Worker^ myWorker = gcnew Worker();

try
{
    // Activate the worker object
    //
    myWorker->Start(false, false, false);
    Console::WriteLine("The Worker object was activated successfully.");

    // Wait for sometime to get messages in the receive queue
    //
    Console::WriteLine("Waiting for messages......");
    System::Threading::Thread::Sleep(5000);

    // Get and show the amount of messages contained in the default receive queue (index 0)
    //
    Console::WriteLine("There are {0} messages in the default receive queue. ", myWorker->GetAvailableMessagesCount());

    //  Clear the default receive queue and show the amount of messages in it again
    //
    myWorker->ClearReceiveQueue();
    Console::WriteLine("There are {0} messages in the default receive queue, after clearing it. ", myWorker->GetAvailableMessagesCount());

    // Deactivate the worker object, when it is no longer needed
    //
    myWorker->Stop(false, false, false);
    Console::WriteLine("The Worker object was deactivated.");
}
catch (Exception^ ex)
{
    Console::WriteLine("An exception occurred by activating the Worker object. {0}", ex->Message);
}

WorkerClearReceiveQueue Method

Definition

Remarks

Example

See Also

Reference