477 lines
17 KiB
C++
477 lines
17 KiB
C++
/*
|
|
* Copyright (C) John Baier 2014-2015 <ebusd@ebusd.eu>
|
|
*
|
|
* This file is part of ebusd.
|
|
*
|
|
* ebusd is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* ebusd is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with ebusd. If not, see http://www.gnu.org/licenses/.
|
|
*/
|
|
|
|
#ifndef LIBEBUS_MESSAGE_H_
|
|
#define LIBEBUS_MESSAGE_H_
|
|
|
|
#include "data.h"
|
|
#include "result.h"
|
|
#include "symbol.h"
|
|
#include <string>
|
|
#include <vector>
|
|
#include <deque>
|
|
#include <map>
|
|
|
|
/** \file message.h */
|
|
|
|
using namespace std;
|
|
|
|
class MessageMap;
|
|
|
|
/**
|
|
* Defines parameters of a message sent or received on the bus.
|
|
*/
|
|
class Message
|
|
{
|
|
friend class MessageMap;
|
|
public:
|
|
|
|
/**
|
|
* Construct a new instance.
|
|
* @param circuit the optional circuit name.
|
|
* @param name the message name (unique within the same circuit and type).
|
|
* @param isWrite whether this is a write message.
|
|
* @param isPassive true if message can only be initiated by a participant other than us,
|
|
* false if message can be initiated by any participant.
|
|
* @param comment the comment.
|
|
* @param srcAddress the source address, or @a SYN for any (only relevant if passive).
|
|
* @param dstAddress the destination address, or @a SYN for any (set later).
|
|
* @param id the primary, secondary, and optional further ID bytes.
|
|
* @param data the @a DataField for encoding/decoding the message.
|
|
* @param deleteData whether to delete the @a DataField during destruction.
|
|
* @param pollPriority the priority for polling, or 0 for no polling at all.
|
|
*/
|
|
Message(const string circuit, const string name, const bool isWrite,
|
|
const bool isPassive, const string comment,
|
|
const unsigned char srcAddress, const unsigned char dstAddress,
|
|
const vector<unsigned char> id, DataField* data, const bool deleteData,
|
|
const unsigned char pollPriority);
|
|
|
|
/**
|
|
* Construct a new temporary instance.
|
|
* @param isWrite whether this is a write message.
|
|
* @param isPassive true if message can only be initiated by a participant other than us,
|
|
* false if message can be initiated by any participant.
|
|
* @param pb the primary ID byte.
|
|
* @param sb the secondary ID byte.
|
|
* @param data the @a DataField for encoding/decoding the message.
|
|
*/
|
|
Message(const bool isWrite, const bool isPassive,
|
|
const unsigned char pb, const unsigned char sb,
|
|
DataField* data);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~Message() { if (m_deleteData) delete m_data; }
|
|
|
|
/**
|
|
* Factory method for creating new instances.
|
|
* @param it the iterator to traverse for the definition parts.
|
|
* @param end the iterator pointing to the end of the definition parts.
|
|
* @param defaultsRows a @a vector with rows containing defaults, or NULL.
|
|
* @param templates the @a DataFieldTemplates to be referenced by name, or NULL.
|
|
* @param messages the @a vector to which to add created instances.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
* Note: the caller needs to free the created instances.
|
|
*/
|
|
static result_t create(vector<string>::iterator& it, const vector<string>::iterator end,
|
|
vector< vector<string> >* defaultsRows,
|
|
DataFieldTemplates* templates, vector<Message*>& messages);
|
|
|
|
/**
|
|
* Get the optional circuit name.
|
|
* @return the optional circuit name.
|
|
*/
|
|
string getCircuit() const { return m_circuit; }
|
|
|
|
/**
|
|
* Get the message name (unique within the same circuit and type).
|
|
* @return the message name (unique within the same circuit and type).
|
|
*/
|
|
string getName() const { return m_name; }
|
|
|
|
/**
|
|
* Get whether this is a write message.
|
|
* @return whether this is a write message.
|
|
*/
|
|
bool isWrite() const { return m_isWrite; }
|
|
|
|
/**
|
|
* Get whether message can be initiated only by a participant other than us.
|
|
* @return true if message can only be initiated by a participant other than us,
|
|
* false if message can be initiated by any participant.
|
|
*/
|
|
bool isPassive() const { return m_isPassive; }
|
|
|
|
/**
|
|
* Get the comment.
|
|
* @return the comment.
|
|
*/
|
|
string getComment() const { return m_comment; }
|
|
|
|
/**
|
|
* Get the source address.
|
|
* @return the source address, or @a SYN for any.
|
|
*/
|
|
unsigned char getSrcAddress() const { return m_srcAddress; }
|
|
|
|
/**
|
|
* Get the destination address.
|
|
* @return the destination address, or @a SYN for any.
|
|
*/
|
|
unsigned char getDstAddress() const { return m_dstAddress; }
|
|
|
|
/**
|
|
* Get the command ID bytes.
|
|
* @return the primary, secondary, and optionally further command ID bytes.
|
|
*/
|
|
vector<unsigned char> getId() const { return m_id; }
|
|
|
|
/**
|
|
* Return the key for storing in @a MessageMap.
|
|
* @return the key for storing in @a MessageMap.
|
|
*/
|
|
unsigned long long getKey() { return m_key; }
|
|
|
|
/**
|
|
* Get the polling priority, or 0 for no polling at all.
|
|
* @return the polling priority, or 0 for no polling at all.
|
|
*/
|
|
unsigned char getPollPriority() const { return m_pollPriority; }
|
|
|
|
/**
|
|
* Set the polling priority.
|
|
* @param priority the polling priority, or 0 for no polling at all.
|
|
* @return true when the priority was changed, false otherwise.
|
|
*/
|
|
bool setPollPriority(unsigned char priority);
|
|
|
|
/**
|
|
* Prepare the master @a SymbolString for sending a query or command to the bus.
|
|
* @param srcAddress the source address to set.
|
|
* @param masterData the master data @a SymbolString for writing symbols to.
|
|
* @param input the @a istringstream to parse the formatted value(s) from.
|
|
* @param separator the separator character between multiple fields.
|
|
* @param dstAddress the destination address to set, or @a SYN to keep the address defined during construction.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
*/
|
|
result_t prepareMaster(const unsigned char srcAddress, SymbolString& masterData,
|
|
istringstream& input, char separator=UI_FIELD_SEPARATOR,
|
|
const unsigned char dstAddress=SYN);
|
|
|
|
/**
|
|
* Prepare the slave @a SymbolString for sending an answer to the bus.
|
|
* @param slaveData the slave data @a SymbolString for writing symbols to.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
*/
|
|
result_t prepareSlave(SymbolString& slaveData);
|
|
|
|
/**
|
|
* Decode a singular part of a received message.
|
|
* @param partType the @a PartType of the data.
|
|
* @param data the unescaped data @a SymbolString for reading binary data.
|
|
* @param output the @a ostringstream to append the formatted value to.
|
|
* @param outputFormat the @a OutputFormat options to use.
|
|
* @param leadingSeparator whether to prepend a separator before the formatted value.
|
|
* @param fieldName the optional name of a field to limit the output to.
|
|
* @param fieldIndex the optional index of the named field to limit the output to, or -1.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
*/
|
|
result_t decode(const PartType partType, SymbolString& data,
|
|
ostringstream& output, OutputFormat outputFormat=0,
|
|
bool leadingSeparator=false, const char* fieldName=NULL, signed char fieldIndex=-1);
|
|
|
|
/**
|
|
* Decode all parts of a received message.
|
|
* @param masterData the unescaped master data @a SymbolString to decode.
|
|
* @param slaveData the unescaped slave data @a SymbolString to decode.
|
|
* @param output the @a ostringstream to append the formatted value to.
|
|
* @param outputFormat the @a OutputFormat options to use.
|
|
* @param leadingSeparator whether to prepend a separator before the formatted value.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
*/
|
|
result_t decode(SymbolString& masterData, SymbolString& slaveData,
|
|
ostringstream& output, OutputFormat outputFormat=0,
|
|
bool leadingSeparator=false);
|
|
|
|
/**
|
|
* Decode the value from the last stored data.
|
|
* @param output the @a ostringstream to append the formatted value to.
|
|
* @param outputFormat the @a OutputFormat options to use.
|
|
* @param leadingSeparator whether to prepend a separator before the formatted value.
|
|
* @param fieldName the optional name of a field to limit the output to.
|
|
* @param fieldIndex the optional index of the named field to limit the output to, or -1.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
*/
|
|
result_t decodeLastData(ostringstream& output, OutputFormat outputFormat=0,
|
|
bool leadingSeparator=false, const char* fieldName=NULL, signed char fieldIndex=-1);
|
|
|
|
/**
|
|
* Get the last seen slave data.
|
|
* @return the last seen slave @a SymbolString.
|
|
*/
|
|
SymbolString& getLastSlaveData() { return m_lastSlaveData; }
|
|
|
|
/**
|
|
* Get the time when @a m_lastValue was last stored.
|
|
* @return the time when @a m_lastValue was last stored, or 0 if this message was not decoded yet.
|
|
*/
|
|
time_t getLastUpdateTime() { return m_lastUpdateTime; }
|
|
|
|
/**
|
|
* Get the time when @a m_lastValue was last changed.
|
|
* @return the time when @a m_lastValue was last changed, or 0 if this message was not decoded yet.
|
|
*/
|
|
time_t getLastChangeTime() { return m_lastChangeTime; }
|
|
|
|
/**
|
|
* Get the time when this message was last polled for.
|
|
* @return the time when this message was last polled for, or 0 for never.
|
|
*/
|
|
time_t getLastPollTime() { return m_lastPollTime; }
|
|
|
|
/**
|
|
* Return whether this @a Message needs to be polled after the other one.
|
|
* @param other the other @a Message to compare with.
|
|
* @return true if this @a Message needs to be polled after the other one.
|
|
*/
|
|
bool isLessPollWeight(const Message* other);
|
|
|
|
/**
|
|
* Write the message definition to the @a ostream.
|
|
* @param output the @a ostream to append the formatted value to.
|
|
*/
|
|
void dump(ostream& output);
|
|
|
|
private:
|
|
|
|
/** the optional circuit name. */
|
|
const string m_circuit;
|
|
|
|
/** the message name (unique within the same circuit and type). */
|
|
const string m_name;
|
|
|
|
/** whether this is a write message. */
|
|
const bool m_isWrite;
|
|
|
|
/** true if message can only be initiated by a participant other than us,
|
|
* false if message can be initiated by any participant. */
|
|
const bool m_isPassive;
|
|
|
|
/** the comment. */
|
|
const string m_comment;
|
|
|
|
/** the source address, or @a SYN for any (only relevant if passive). */
|
|
const unsigned char m_srcAddress;
|
|
|
|
/** the destination address, or @a SYN for any (only for temporary scan messages). */
|
|
const unsigned char m_dstAddress;
|
|
|
|
/** the primary, secondary, and optionally further command ID bytes. */
|
|
vector<unsigned char> m_id;
|
|
|
|
/** the key for storing in @a MessageMap. */
|
|
unsigned long long m_key;
|
|
|
|
/** the @a DataField for encoding/decoding the message. */
|
|
DataField* m_data;
|
|
|
|
/** whether to delete the @a DataField during destruction. */
|
|
const bool m_deleteData;
|
|
|
|
/** the priority for polling, or 0 for no polling at all. */
|
|
unsigned char m_pollPriority;
|
|
|
|
/** the last seen master data. */
|
|
SymbolString m_lastMasterData;
|
|
|
|
/** the last seen slave data. */
|
|
SymbolString m_lastSlaveData;
|
|
|
|
/** the system time when the message was last updated, 0 for never. */
|
|
time_t m_lastUpdateTime;
|
|
|
|
/** the system time when the message content was last changed, 0 for never. */
|
|
time_t m_lastChangeTime;
|
|
|
|
/** the number of times this messages was already polled for. */
|
|
unsigned int m_pollCount;
|
|
|
|
/** the system time when this message was last polled for, 0 for never. */
|
|
time_t m_lastPollTime;
|
|
|
|
};
|
|
|
|
|
|
/**
|
|
* A function that compares the weighted poll priority of two @a Message instances.
|
|
*/
|
|
struct compareMessagePriority : binary_function <Message*,Message*,bool> {
|
|
/**
|
|
* Compare the weighted poll priority of the two @a Message instances.
|
|
* @param x the first @a Message.
|
|
* @param y the second @a Message.
|
|
* @return whether @a x is smaller than @a y with regard to their weighted poll priority.
|
|
*/
|
|
bool operator() (Message* x, Message* y) const { return x->isLessPollWeight(y); };
|
|
};
|
|
|
|
|
|
/**
|
|
* Holds a map of all known @a Message instances.
|
|
*/
|
|
class MessageMap : public FileReader<DataFieldTemplates*>
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Construct a new instance.
|
|
*/
|
|
MessageMap() : FileReader<DataFieldTemplates*>::FileReader(true),
|
|
m_minIdLength(4), m_maxIdLength(0), m_messageCount(0), m_passiveMessageCount(0) {}
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~MessageMap() { clear(); }
|
|
|
|
/**
|
|
* Add a @a Message instance to this set.
|
|
* @param message the @a Message instance to add.
|
|
* @return @a RESULT_OK on success, or an error code.
|
|
* Note: the caller may not free the added instance on success.
|
|
*/
|
|
result_t add(Message* message);
|
|
|
|
// @copydoc
|
|
virtual result_t addFromFile(vector<string>::iterator& begin, const vector<string>::iterator end, DataFieldTemplates* arg, vector< vector<string> >* defaults, const string& filename, unsigned int lineNo);
|
|
|
|
/**
|
|
* Find the @a Message instance for the specified circuit and name.
|
|
* @param circuit the optional circuit name.
|
|
* @param name the message name.
|
|
* @param isWrite whether this is a write message.
|
|
* @param isPassive whether this is a passive message.
|
|
* @return the @a Message instance, or NULL.
|
|
* Note: the caller may not free the returned instance.
|
|
*/
|
|
Message* find(const string& circuit, const string& name, const bool isWrite, const bool isPassive=false);
|
|
|
|
/**
|
|
* Find all active get @a Message instances for the specified circuit and name.
|
|
* @param circuit the circuit name, or empty for any.
|
|
* @param name the message name, or empty for any.
|
|
* @param pb the primary ID byte, or -1 for any (default any).
|
|
* @param completeMatch false to also include messages where the circuit and name matches only a part of the given circuit and name (default true).
|
|
* @param withRead true to include read messages (default true).
|
|
* @param withWrite true to include write messages (default false).
|
|
* @param withPassive true to include passive messages (default false).
|
|
* @return the found @a Message instances.
|
|
* Note: the caller may not free the returned instances.
|
|
*/
|
|
deque<Message*> findAll(const string& circuit, const string& name, const short pb=-1, const bool completeMatch=true,
|
|
const bool withRead=true, const bool withWrite=false, const bool withPassive=false);
|
|
|
|
/**
|
|
* Find the @a Message instance for the specified master data.
|
|
* @param master the master @a SymbolString for identifying the @a Message.
|
|
* @return the @a Message instance, or NULL.
|
|
* Note: the caller may not free the returned instance.
|
|
*/
|
|
Message* find(SymbolString& master);
|
|
|
|
/**
|
|
* Find all @a Message instances for the specified master data.
|
|
* @param master the master @a SymbolString for identifying the @a Message.
|
|
* @return the @a Message instance, or NULL.
|
|
* Note: the caller may not free the returned instances.
|
|
*/
|
|
deque<Message*> findAll(SymbolString& master);
|
|
|
|
/**
|
|
* Invalidate cached data of the @a Message and all other instances with a matching name key.
|
|
* @param message the @a Message to invalidate.
|
|
*/
|
|
void invalidateCache(Message* message);
|
|
|
|
/**
|
|
* Add a @a Message to the list of instances to poll.
|
|
* @param message the @a Message to poll.
|
|
*/
|
|
void addPollMessage(Message* message);
|
|
|
|
/**
|
|
* Removes all @a Message instances.
|
|
*/
|
|
void clear();
|
|
|
|
/**
|
|
* Get the number of stored @a Message instances.
|
|
* @param passiveOnly true to count only passive messages, false to count all messages.
|
|
* @return the the number of stored @a Message instances.
|
|
*/
|
|
size_t size(const bool passiveOnly=false) { return passiveOnly ? m_passiveMessageCount : m_messageCount; }
|
|
|
|
/**
|
|
* Get the number of stored @a Message instances with a poll priority.
|
|
* @return the the number of stored @a Message instances with a poll priority.
|
|
*/
|
|
size_t sizePoll() { return m_pollMessages.size(); }
|
|
|
|
/**
|
|
* Get the next @a Message to poll.
|
|
* @return the next @a Message to poll, or NULL.
|
|
* Note: the caller may not free the returned instance.
|
|
*/
|
|
Message* getNextPoll();
|
|
|
|
/**
|
|
* Write the message definitions to the @a ostream.
|
|
* @param output the @a ostream to append the formatted messages to.
|
|
*/
|
|
void dump(ostream& output);
|
|
|
|
private:
|
|
|
|
/** the minimum ID length used by any of the known @a Message instances. */
|
|
unsigned char m_minIdLength;
|
|
|
|
/** the maximum ID length used by any of the known @a Message instances. */
|
|
unsigned char m_maxIdLength;
|
|
|
|
/** the number of distinct @a Message instances stored in @a m_messagesByName. */
|
|
size_t m_messageCount;
|
|
|
|
/** the number of distinct passive @a Message instances stored in @a m_messagesByKey. */
|
|
size_t m_passiveMessageCount;
|
|
|
|
/** the known @a Message instances by lowercase circuit and name. */
|
|
map<string, Message*> m_messagesByName;
|
|
|
|
/** the known @a Message instances by key. */
|
|
map<unsigned long long, Message*> m_messagesByKey;
|
|
|
|
/** the known @a Message instances to poll, by priority. */
|
|
priority_queue<Message*, vector<Message*>, compareMessagePriority> m_pollMessages;
|
|
|
|
};
|
|
|
|
#endif // LIBEBUS_MESSAGE_H_
|