PCAN-Basic.NET Library Documentation
WorkerGet
Retrieves the amount of available messages currently contained in the default receive queue (index 0).
Definition
Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0
The amount of messages currently contained in the default receive queue (index 0).
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 4.9.0
C#
public int GetAvailableMessagesCount()VB
Public Function GetAvailableMessagesCount As IntegerC++
public:
int GetAvailableMessagesCount()Return Value
Int32The amount of messages currently contained in the default receive queue (index 0).
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 retrieve the amount of messages contained in the default receive queue (index 0).
In case of failure, an error messages is written to the console output using English as output language.
C#
// 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. ");
// 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}");
}VB
' 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()} messages in the default receive queue. ")
' 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 TryC++
// Create the object using the default configuration
//
Worker^ myWorker = gcnew Worker();
try
{
// Activate the worker object
//
PcanBasicException^ error;
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());
// 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);
}