Bridge #include <Bridge.h> Inheritance diagram for Bridge: Bridge (Component *_owner) short debug () Virtual function to debug the component. SComponentInfo * hasMethod (ushort id, String method) short list () virtual short onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void *user, Component *src) Handles incoming messages. SComponentInfo * registerMemberFunction (ushort id, Component *clazz, char *method, ComponentFnPtr ptr) short setup () Virtual function to set up the component. Public Member Functions inherited from Component void clearFlag (byte flag) Clears a specific flag for the component. Component () Default constructor for the Component class. Component (String _name) Constructor for the Component class with a specified name. Component (String _name, short _id) Constructor for the Component class with a specified name and ID. Component (String _name, short _id, int _flags) Constructor for the Component class with a specified name, ID, and flags. Component (String _name, short _id, int _flags, Component *_owner) Constructor for the Component class with a specified name, ID, flags, and owner. virtual short debug (short val0, short val1) Virtual function to debug the component. virtual short destroy () Virtual function to destroy the component. void disable () Disables the component. void enable () Enables the component. bool enabled () Checks if the component is enabled. bool hasFlag (byte flag) Checks if the component has a specific flag. virtual short info () Virtual function to display information about the component. virtual short info (short val0, short val1) Virtual function to display information about the component. virtual short loop () Virtual function to run the component in a loop. virtual short onError (short id, short error) virtual short onRawResponse (short size, uint8_t rxBuffer[]) virtual short onRegisterMethods (Bridge *bridge) virtual short onResponse (short error) void setFlag (byte flag) Sets a specific flag for the component. ~Component () Destructor for the Component class. Public Member Functions inherited from ModbusGateway short getAddress () MB_FC getFunctionCode () short getNumberAddresses () virtual String getRegisterDescription (short flags=0) const char * getRegisterMode () ModbusGateway () ModbusGateway (short _addr) ModbusGateway (short _addr, short _fc) void setAddress (short _addr) void setFunctionCode (MB_FC fc) void setGateway (Mudbus *mudbus) void setNumberAddresses (short _nbAddr) void setRegisterMode (MB_REGISTER_MODE mode) static constexpr char * METHOD_DELIMITER = C_STR(":") Static Public Attributes inherited from Component static const int COMPONENT_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP The default run flags for a component. static const int COMPONENT_NO_ID = 0 The default ID for a component. Public Attributes inherited from Component int flags The run flags for the component. const short id The ID of the component. millis_t last The last tick time in milliseconds. String name The name of the component. int nFlags The network capabilities of the component. millis_t now The current time in milliseconds. Component * owner The owner of the component. Public Attributes inherited from ModbusGateway short addr MB_FC fn uchar lastMQSlot Mudbus * mudbus short nbAddr short registerMode

Definition at line 26 of file Bridge.h.

BridgeBridge BridgeBridge Bridge::Bridge (Component * _owner) Definition at line 19 of file Bridge.cpp. 00019 : Component("Bridge", 0, Component::COMPONENT_DEFAULT, _owner) 00020 { 00021 }

debugBridge Bridgedebug short Bridge::debug ( )[virtual] Virtual function to debug the component. stream The stream to output the debug information to. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 41 of file Bridge.cpp. 00042 { 00043 return E_OK; 00044 }

hasMethodBridge BridgehasMethod SComponentInfo * Bridge::hasMethod (ushort id, String method) Definition at line 28 of file Bridge.cpp. 00029 { 00030 uchar s = componentList.size(); 00031 for (uchar i = 0; i < s; i++) 00032 { 00033 SComponentInfo *val = componentList.at(i); 00034 if (val->key == id && val->methodName.equals(methodName)) 00035 { 00036 return val; 00037 } 00038 } 00039 return NULL; 00040 }

listBridge Bridgelist short Bridge::list ( ) Definition at line 45 of file Bridge.cpp. 00046 { 00047 uchar s = componentList.size(); 00048 for (uchar i = 0; i < s; i++) 00049 { 00050 SComponentInfo *val = componentList.at(i); 00051 Log.verboseln("\tRegistered Method: %d::%s::%s", val->key, ((Component *)val->instance)->name.c_str(), val->methodName.c_str()); 00052 } 00053 return E_OK; 00054 }

onMessageBridge BridgeonMessage short Bridge::onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void * user, Component * src)[virtual] Handles incoming messages. This function is called when a message is received by the component. It processes the message and returns a short value indicating the status of the operation. id The ID of the message. verb The type of operation to be performed. flags The flags associated with the message. user A pointer to user-defined data. src The source component that sent the message. A short value indicating the status of the operation. Reimplemented from Component. Definition at line 111 of file Bridge.cpp. 00112 { 00113 00114 #ifdef BRIDGE_DEBUG_CALL_METHOD 00115 Log.verboseln("Bridge::onMessage: %d::%d::%d::%s - from ", id, verb, flags, CC_STR(user), src->name.c_str()); 00116 #endif 00117 00118 switch (verb) 00119 { 00120 case E_CALLS::EC_USER: 00121 case E_CALLS::EC_NONE: 00122 case E_CALLS::EC_COMMAND: 00123 case E_CALLS::EC_FUNC: 00124 { 00125 return E_OK; 00126 } 00127 case E_CALLS::EC_METHOD: 00128 { 00129 char *strings[4]; 00130 char *ptr = NULL; 00131 byte index = 0; 00132 ptr = strtok(C_STR(user), CC_STR(Bridge::METHOD_DELIMITER)); 00133 00134 while (ptr != NULL && index < NB_PAYLOAD_ELEMENTS) 00135 { 00136 strings[index] = ptr; 00137 index++; 00138 ptr = strtok(NULL, CC_STR(Bridge::METHOD_DELIMITER)); 00139 } 00140 00141 char *_method = strings[0]; 00142 00143 SComponentInfo *method = hasMethod(id, _method); 00144 if (method) 00145 { 00146 short arg0 = convertTo<short>(CC_STR(strings[1])); 00147 short arg1 = convertTo<short>(CC_STR(strings[2])); 00148 Component *component = (Component *)method->instance; 00149 ComponentFnPtr ptr = method->mPtr; 00150 short ret = (component->*ptr)(arg0, arg1); 00151 #ifdef BRIDGE_DEBUG_CALL_METHOD 00152 Log.verboseln("Called method: %s(%d)::%s with : %d | %d = %d", component->name.c_str(), id, _method, arg0, arg1, ret); 00153 #endif 00154 return ret; 00155 } 00156 else 00157 { 00158 #ifdef BRIDGE_DEBUG_CALL_METHOD 00159 Log.errorln("Method not found: %d::%s", id, _method); 00160 list(); 00161 #endif 00162 } 00163 return E_OK; 00164 } 00165 } 00166 return E_NOT_FOUND; 00167 }

registerMemberFunctionBridge BridgeregisterMemberFunction SComponentInfo * Bridge::registerMemberFunction (ushort id, Component * clazz, char * method, ComponentFnPtr ptr) Definition at line 56 of file Bridge.cpp. 00057 { 00058 #ifdef DISABLE_BRIDGE 00059 // #pragma message("Bridge::registerMemberFunction : Bridge is disabled!") 00060 return NULL; 00061 #endif 00062 #ifndef DISABLE_BRIDGE 00063 if (!clazz) 00064 { 00065 // Log.verboseln("Register member method: %d : invalid class", id); 00066 return NULL; 00067 } 00068 00069 if (!strlen(method)) 00070 { 00071 // Log.verboseln("Register member method: %d : invalid method name", id); 00072 return NULL; 00073 } 00074 if (!id) 00075 { 00076 // Log.verboseln("Register member method: %d : invalid component id", id); 00077 return NULL; 00078 } 00079 if (componentList.size() > MAX_COMPONENTS) 00080 { 00081 // Log.errorln("Bridge::registerMemberFunction : Max components reached : %d", MAX_COMPONENTS); 00082 return NULL; 00083 } 00084 SComponentInfo *meth = hasMethod(id, method); 00085 if (meth) 00086 { 00087 #ifdef BRIDGE_DEBUG_REGISTER 00088 Log.verboseln("Register class member: %s::%s already registered!", clazz, method); 00089 #endif 00090 } 00091 else 00092 { 00093 meth = new SComponentInfo(id, clazz, method, ptr); 00094 componentList.push_back(meth); 00095 #ifdef BRIDGE_DEBUG_REGISTER 00096 if (clazz->name) 00097 { 00098 Log.verboseln("Register member method: %s (%d)::%s", clazz->name.c_str(), id, method); 00099 } 00100 else 00101 { 00102 Log.verboseln("Register member method: %d::%s : invalid name", id, method); 00103 } 00104 #endif 00105 } 00106 return meth; 00107 #endif 00108 return NULL; 00109 }

setupBridge Bridgesetup short Bridge::setup ( )[virtual] Virtual function to set up the component. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 22 of file Bridge.cpp. 00023 { 00024 componentList.setStorage(componentsArray); 00025 return E_OK; 00026 }

METHOD_DELIMITERBridge BridgeMETHOD_DELIMITER constexpr char* Bridge::METHOD_DELIMITER = C_STR(":")[static], [constexpr] Definition at line 46 of file Bridge.h.

The documentation for this class was generated from the following files: Bridge.hBridge.cpp