sven
/
libicsneo
mirror of https://github.com/intrepidcs/libicsneo.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added the ability to block on getMessages until a message arrives

pull/4/head
Paul Hollinsky 2018-11-09 16:28:48 -05:00
parent 35bd5139b2
commit 77d694c662
5 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api/icsneoc/icsneoc.cpp
View File

@ -188,7 +188,7 @@ bool icsneo_disableMessagePolling(const neodevice_t* device) {
return device->device->disableMessagePolling(); return device->device->disableMessagePolling();
} }
bool icsneo_getMessages(const neodevice_t* device, neomessage_t* messages, size_t* items) { bool icsneo_getMessages(const neodevice_t* device, neomessage_t* messages, size_t* items, uint64_t timeout) {
if(!icsneo_isValidNeoDevice(device)) { if(!icsneo_isValidNeoDevice(device)) {
ErrorManager::GetInstance().add(APIError::InvalidNeoDevice); ErrorManager::GetInstance().add(APIError::InvalidNeoDevice);
return false; return false;
@ -207,7 +207,7 @@ bool icsneo_getMessages(const neodevice_t* device, neomessage_t* messages, size_
std::vector<std::shared_ptr<Message>>& storage = polledMessageStorage[device->device]; std::vector<std::shared_ptr<Message>>& storage = polledMessageStorage[device->device];
if(!device->device->getMessages(storage, *items)) if(!device->device->getMessages(storage, *items, std::chrono::milliseconds(timeout)))
return false; return false;
*items = storage.size(); *items = storage.size();

2
api/icsneolegacy/icsneolegacy.cpp
View File

@ -111,7 +111,7 @@ int icsneoGetMessages(void* hObject, icsSpyMessage* pMsg, int* pNumberOfMessages
neodevice_t* device = (neodevice_t*)hObject; neodevice_t* device = (neodevice_t*)hObject;
size_t messageCount = 20000; size_t messageCount = 20000;
if(!icsneo_getMessages(device, messages, &messageCount)) if(!icsneo_getMessages(device, messages, &messageCount, 0))
return false; return false;
*pNumberOfMessages = (int)messageCount; *pNumberOfMessages = (int)messageCount;

8
device/device.cpp
View File

@ -99,7 +99,7 @@ std::vector<std::shared_ptr<Message>> Device::getMessages() {
return ret; return ret;
} }
bool Device::getMessages(std::vector<std::shared_ptr<Message>>& container, size_t limit) { bool Device::getMessages(std::vector<std::shared_ptr<Message>>& container, size_t limit, std::chrono::milliseconds timeout) {
// A limit of zero indicates no limit // A limit of zero indicates no limit
if(limit == 0) if(limit == 0)
limit = (size_t)-1; limit = (size_t)-1;
@ -110,7 +110,11 @@ bool Device::getMessages(std::vector<std::shared_ptr<Message>>& container, size_
if(container.size() < limit) if(container.size() < limit)
container.resize(limit); container.resize(limit);
size_t actuallyRead = pollingContainer.try_dequeue_bulk(container.data(), limit); size_t actuallyRead;
if(timeout != std::chrono::milliseconds(0))
actuallyRead = pollingContainer.wait_dequeue_bulk_timed(container.data(), limit, timeout);
else
actuallyRead = pollingContainer.try_dequeue_bulk(container.data(), limit);
if(container.size() > actuallyRead) if(container.size() > actuallyRead)
container.resize(actuallyRead); container.resize(actuallyRead);

4
include/icsneo/device/device.h
View File

@ -50,7 +50,7 @@ public:
void enableMessagePolling(); void enableMessagePolling();
bool disableMessagePolling(); bool disableMessagePolling();
std::vector<std::shared_ptr<Message>> getMessages(); std::vector<std::shared_ptr<Message>> getMessages();
bool getMessages(std::vector<std::shared_ptr<Message>>& container, size_t limit = 0); bool getMessages(std::vector<std::shared_ptr<Message>>& container, size_t limit = 0, std::chrono::milliseconds timeout = std::chrono::milliseconds(0));
size_t getCurrentMessageCount() { return pollingContainer.size_approx(); } size_t getCurrentMessageCount() { return pollingContainer.size_approx(); }
size_t getPollingMessageLimit() { return pollingMessageLimit; } size_t getPollingMessageLimit() { return pollingMessageLimit; }
void setPollingMessageLimit(size_t newSize) { void setPollingMessageLimit(size_t newSize) {
@ -145,7 +145,7 @@ private:
void updateLEDState(); void updateLEDState();
size_t pollingMessageLimit = 20000; size_t pollingMessageLimit = 20000;
moodycamel::ConcurrentQueue<std::shared_ptr<Message>> pollingContainer; moodycamel::BlockingConcurrentQueue<std::shared_ptr<Message>> pollingContainer;
void enforcePollingMessageLimit(); void enforcePollingMessageLimit();
}; };

16
include/icsneo/icsneoc.h
View File

@ -188,6 +188,8 @@ extern bool DLLExport icsneo_disableMessagePolling(const neodevice_t* device);
* \param[out] messages A pointer to a buffer which neomessage_t structures will be written to. NULL can be passed, which will write the current message count to size. * \param[out] messages A pointer to a buffer which neomessage_t structures will be written to. NULL can be passed, which will write the current message count to size.
* \param[inout] items A pointer to a size_t which, prior to the call, * \param[inout] items A pointer to a size_t which, prior to the call,
* holds the maximum number of messages to be written, and after the call holds the number of messages written. * holds the maximum number of messages to be written, and after the call holds the number of messages written.
* \param[in] timeout The number of milliseconds to wait for a message to arrive. A value of 0 indicates a non-blocking call.
* Querying for the current message count is always asynchronous and ignores this value.
* \returns True if the messages were read out successfully (even if there were no messages to read) or if the count was read successfully. * \returns True if the messages were read out successfully (even if there were no messages to read) or if the count was read successfully.
* *
* Messages are available using this function if icsneo_goOnline() and icsneo_enableMessagePolling() have been called. * Messages are available using this function if icsneo_goOnline() and icsneo_enableMessagePolling() have been called.
@ -202,12 +204,15 @@ extern bool DLLExport icsneo_disableMessagePolling(const neodevice_t* device);
* The memory for the data pointer within the neomessage_t is managed by the API. Do *not* attempt to free the data pointer. * The memory for the data pointer within the neomessage_t is managed by the API. Do *not* attempt to free the data pointer.
* The memory will become invalid the next time icsneo_getMessages() is called for this device. * The memory will become invalid the next time icsneo_getMessages() is called for this device.
* *
* \warning Do not call icsneo_close() while another thread is waiting on icsneo_getMessages().
* Always allow the other thread to timeout first!
*
* ``` C * ``` C
* size_t messageCount; * size_t messageCount;
* bool result = icsneo_getMessages(device, NULL, &messageCount); // Reading the message count * bool result = icsneo_getMessages(device, NULL, &messageCount, 0); // Reading the message count
* // Handle errors here * // Handle errors here
* neomessage_t* messages = malloc(messageCount * sizeof(neomessage_t)); // It is also possible and encouraged to use a static buffer * neomessage_t* messages = malloc(messageCount * sizeof(neomessage_t)); // It is also possible and encouraged to use a static buffer
* result = icsneo_getMessages(device, messages, &messageCount); * result = icsneo_getMessages(device, messages, &messageCount, 0); // Non-blocking
* // Handle errors here * // Handle errors here
* for(size_t i = 0; i < messageCount; i++) { * for(size_t i = 0; i < messageCount; i++) {
* switch(messages[i].type) { * switch(messages[i].type) {
@ -227,7 +232,7 @@ extern bool DLLExport icsneo_disableMessagePolling(const neodevice_t* device);
* free(messages); * free(messages);
* ``` * ```
*/ */
extern bool DLLExport icsneo_getMessages(const neodevice_t* device, neomessage_t* messages, size_t* items); extern bool DLLExport icsneo_getMessages(const neodevice_t* device, neomessage_t* messages, size_t* items, uint64_t timeout);
/** /**
* \brief Get the maximum number of messages which will be held in the API managed buffer for the specified hardware. * \brief Get the maximum number of messages which will be held in the API managed buffer for the specified hardware.
@ -335,7 +340,8 @@ extern bool DLLExport icsneo_settingsApplyDefaultsTemporary(const neodevice_t* d
* \param[in] newBaudrate The requested baudrate, with no multipliers. (i.e. 500K CAN should be represented as 500000) * \param[in] newBaudrate The requested baudrate, with no multipliers. (i.e. 500K CAN should be represented as 500000)
* \returns True if the baudrate could be set. * \returns True if the baudrate could be set.
* *
* In the case of CAN, this function sets the standard CAN baudrate. See icsneo_setFDBaudrate() to set the baudrate for (the baudrate-switched portion of) CAN FD. * In the case of CAN, this function sets the standard CAN baudrate.
* See icsneo_setFDBaudrate() to set the baudrate for (the baudrate-switched portion of) CAN FD.
* *
* Call icsneo_settingsApply() or similar to make the changes active on the device. * Call icsneo_settingsApply() or similar to make the changes active on the device.
*/ */
@ -550,7 +556,7 @@ fn_icsneo_enableMessagePolling icsneo_enableMessagePolling;
typedef bool(*fn_icsneo_disableMessagePolling)(const neodevice_t* device); typedef bool(*fn_icsneo_disableMessagePolling)(const neodevice_t* device);
fn_icsneo_disableMessagePolling icsneo_disableMessagePolling; fn_icsneo_disableMessagePolling icsneo_disableMessagePolling;
typedef bool(*fn_icsneo_getMessages)(const neodevice_t* device, neomessage_t* messages, size_t* items); typedef bool(*fn_icsneo_getMessages)(const neodevice_t* device, neomessage_t* messages, size_t* items, uint64_t timeout);
fn_icsneo_getMessages icsneo_getMessages; fn_icsneo_getMessages icsneo_getMessages;
typedef size_t(*fn_icsneo_getPollingMessageLimit)(const neodevice_t* device); typedef size_t(*fn_icsneo_getPollingMessageLimit)(const neodevice_t* device);