Bridge Class Reference

#include <Bridge.h>

Inheritance diagram for Bridge:

Public Member Functions
	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 Public Attributes
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.

Additional Inherited Members
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

Detailed Description

Definition at line 26 of file Bridge.h.

Constructor & Destructor Documentation

Bridge()

Bridge::Bridge

(

Component *

_owner

)

Definition at line 19 of file Bridge.cpp.

                                : Component("Bridge", 0, Component::COMPONENT_DEFAULT, _owner)
{
}

Member Function Documentation

debug()

short Bridge::debug ( )

virtual

Virtual function to debug the component.

Parameters

stream

The stream to output the debug information to.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

Definition at line 41 of file Bridge.cpp.

{
    return E_OK;
}

hasMethod()

SComponentInfo * Bridge::hasMethod	(	ushort	id,
		String	method )

Definition at line 28 of file Bridge.cpp.

{
    uchar s = componentList.size();
    for (uchar i = 0; i < s; i++)
    {
        SComponentInfo *val = componentList.at(i);
        if (val->key == id && val->methodName.equals(methodName))
        {
            return val;
        }
    }
    return NULL;
}

list()

short Bridge::list

(

)

Definition at line 45 of file Bridge.cpp.

{
    uchar s = componentList.size();
    for (uchar i = 0; i < s; i++)
    {
        SComponentInfo *val = componentList.at(i);
        Log.verboseln("\tRegistered Method:  %d::%s::%s", val->key, ((Component *)val->instance)->name.c_str(), val->methodName.c_str());
    }
    return E_OK;
}

onMessage()

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.

Parameters

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.

Returns

A short value indicating the status of the operation.

Reimplemented from Component.

Definition at line 111 of file Bridge.cpp.

{
 
#ifdef BRIDGE_DEBUG_CALL_METHOD
    Log.verboseln("Bridge::onMessage: %d::%d::%d::%s - from ", id, verb, flags, CC_STR(user), src->name.c_str());
#endif
 
    switch (verb)
    {
    case E_CALLS::EC_USER:
    case E_CALLS::EC_NONE:
    case E_CALLS::EC_COMMAND:
    case E_CALLS::EC_FUNC:
    {
        return E_OK;
    }
    case E_CALLS::EC_METHOD:
    {
        char *strings[4];
        char *ptr = NULL;
        byte index = 0;
        ptr = strtok(C_STR(user), CC_STR(Bridge::METHOD_DELIMITER));
 
        while (ptr != NULL && index < NB_PAYLOAD_ELEMENTS)
        {
            strings[index] = ptr;
            index++;
            ptr = strtok(NULL, CC_STR(Bridge::METHOD_DELIMITER));
        }
 
        char *_method = strings[0];
 
        SComponentInfo *method = hasMethod(id, _method);
        if (method)
        {
            short arg0 = convertTo<short>(CC_STR(strings[1]));
            short arg1 = convertTo<short>(CC_STR(strings[2]));
            Component *component = (Component *)method->instance;
            ComponentFnPtr ptr = method->mPtr;
            short ret = (component->*ptr)(arg0, arg1);
#ifdef BRIDGE_DEBUG_CALL_METHOD
            Log.verboseln("Called method: %s(%d)::%s with : %d | %d = %d", component->name.c_str(), id, _method, arg0, arg1, ret);
#endif
            return ret;
        }
        else
        {
#ifdef BRIDGE_DEBUG_CALL_METHOD
            Log.errorln("Method not found: %d::%s", id, _method);
            list();
#endif
        }
        return E_OK;
    }
    }
    return E_NOT_FOUND;
}

registerMemberFunction()

SComponentInfo * Bridge::registerMemberFunction	(	ushort	id,
		Component *	clazz,
		char *	method,
		ComponentFnPtr	ptr )

Definition at line 56 of file Bridge.cpp.

{
    #ifdef DISABLE_BRIDGE
        // #pragma message("Bridge::registerMemberFunction : Bridge is disabled!")
        return NULL;
    #endif
#ifndef DISABLE_BRIDGE
    if (!clazz)
    {
        // Log.verboseln("Register member method: %d : invalid class", id);
        return NULL;
    }
 
    if (!strlen(method))
    {
        // Log.verboseln("Register member method: %d : invalid method name", id);
        return NULL;
    }
    if (!id)
    {
        // Log.verboseln("Register member method: %d : invalid component id", id);
        return NULL;
    }
    if (componentList.size() > MAX_COMPONENTS)
    {
        // Log.errorln("Bridge::registerMemberFunction : Max components reached : %d", MAX_COMPONENTS);
        return NULL;
    }
    SComponentInfo *meth = hasMethod(id, method);
    if (meth)
    {
#ifdef BRIDGE_DEBUG_REGISTER
        Log.verboseln("Register class member: %s::%s already registered!", clazz, method);
#endif
    }
    else
    {
        meth = new SComponentInfo(id, clazz, method, ptr);
        componentList.push_back(meth);
#ifdef BRIDGE_DEBUG_REGISTER
        if (clazz->name)
        {
            Log.verboseln("Register member method: %s (%d)::%s", clazz->name.c_str(), id, method);
        }
        else
        {
            Log.verboseln("Register member method: %d::%s : invalid name", id, method);
        }
#endif
    }
    return meth;
#endif
    return NULL;
}

setup()

short Bridge::setup ( )

virtual

Virtual function to set up the component.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

Definition at line 22 of file Bridge.cpp.

{
    componentList.setStorage(componentsArray);
    return E_OK;
}

Member Data Documentation

METHOD_DELIMITER

constexpr char* Bridge::METHOD_DELIMITER = C_STR(":")

staticconstexpr

Definition at line 46 of file Bridge.h.

---

The documentation for this class was generated from the following files:

• Bridge.h
• Bridge.cpp