EPTF_MQTT_LGen_Definitions

Purpose

This module contains the definitions for the MQTT load generator component

Module depends on

  • EPTF_MQTT_Transport_Definitions
  • <EPTF_CLL_LGenBase_Definitions>
  • <EPTF_CLL_Logging_Definitions>
  • <EPTF_CLL_FBQ_Definitions>
  • <EPTF_CLL_Common_Definitions>
  • <Socket_API_Definitions>
  • <MQTT_v3_1_1_Types>

Module Parameters

tsp_EPTF_MQTT_LGen_debugtsp_EPTF_MQTT_LGen_debug - boolean - Enabled/disable debug logging
tsp_EPTF_MQTT_LGen_debugVerbosetsp_EPTF_MQTT_LGen_debugVerbose - boolean - Enabled/disable verbosity of debug logging
tsp_EPTF_MQTT_LGen_maxBindableCtxtsp_EPTF_MQTT_LGen_maxBindableCtx - integer - Maximum number of context to bind(?)
tsp_EPTF_MQTT_LGen_templatestsp_EPTF_MQTT_LGen_templates - MQTT_Template_List - MQTT message template definitions for sending
tsp_EPTF_MQTT_PUBLISH_responseWatchdogtsp_EPTF_MQTT_PUBLISH_responseWatchdog - float - Watchdog timer value to wait responses to an MQTT PUBLISH message
tsp_EPTF_MQTT_SUBSCRIBE_responseWatchdogtsp_EPTF_MQTT_SUBSCRIBE_responseWatchdog - float - Watchdog timer value to wait responses to an MQTT SUBSCRIBE message

Events

MQTT transport successc_MQTT_eventIdx_transportSucc, c_MQTT_eventName_transportSucc
MQTT transport failc_MQTT_eventIdx_transportFail, c_MQTT_eventName_transportFail
MQTT transport establishedc_MQTT_eventIdx_transportEstablished, <c_MQTT_eventName_established>
MQTT transport closedc_MQTT_eventIdx_transportClosed, c_MQTT_eventName_transportClosed
CONNACK acceptedc_MQTT_eventIdx_CONNACK_Accepted, c_MQTT_eventName_CONNACK_Accepted
CONNAK refusedc_MQTT_eventIdx_CONNACK_Refused, c_MQTT_eventName_CONNACK_Refused
SUBACK acceptedc_MQTT_eventIdx_SUBACK_Accepted, c_MQTT_eventName_SUBACK_Accepted SUBACK refused c_MQTT_eventIdx_SUBACK_Refused, c_MQTT_eventName_SUBACK_Refused
UNSUBACKc_MQTT_eventIdx_UNSUBACK, c_MQTT_eventName_UNSUBACK
PUBLISHc_MQTT_eventIdx_PUBLISH, c_MQTT_eventName_PUBLISH
PING requestc_MQTT_eventIdx_PING_Request, c_MQTT_eventName_PING_Request
PING responsec_MQTT_eventIdx_PING_Response, c_MQTT_eventName_PING_Response
PUBACKc_MQTT_eventIdx_PUBACK, c_MQTT_eventName_PUBACK
PUBRECc_MQTT_eventIdx_PUBREC, c_MQTT_eventName_PUBREC
PUBRELc_MQTT_eventIdx_PUBREL, c_MQTT_eventName_PUBREL
PUBCOMPc_MQTT_eventIdx_PUBCOMP, c_MQTT_eventName_PUBCOMP
PUBLISH timeoutc_MQTT_eventIdx_PUBLISH_Timeout, c_MQTT_eventName_PUBLISH_Timeout
SUBSCRIBE timeoutc_MQTT_eventIdx_SUBSCRIBE_Timeout, c_MQTT_eventName_SUBSCRIBE_Timeout

TestSteps

MQTT initf_MQTT_step_init, c_MQTT_stepIdx_init, c_MQTT_stepName_init
MQTT cleanUpf_MQTT_step_cleanUp, c_MQTT_stepIdx_init, c_MQTT_stepIdx_init
set local addressf_MQTT_step_setLocalAddress_byVars, c_MQTT_stepIdx_setLocalAddress_byVars, c_MQTT_stepName_setLocalAddress_byVars
set remote addressf_MQTT_step_setRemoteAddress_byVars, c_MQTT_stepIdx_setRemoteAddress_byVars, c_MQTT_stepName_setRemoteAddress_byVars
transport connectf_MQTT_step_transportConnect, c_MQTT_stepIdx_transportConnect, c_MQTT_stepName_transportConnect
transport closef_MQTT_step_transportClose, c_MQTT_stepIdx_transportClose, c_MQTT_stepName_transportClose
start listeningf_MQTT_step_startListening, c_MQTT_stepIdx_startListening, c_MQTT_stepName_startListening
load MQTT templatef_MQTT_step_loadTemplate_byIntIdx, c_MQTT_stepIdx_loadTemplate_byIntIdx, c_MQTT_stepName_loadTemplate_byIntIdx f_MQTT_step_loadTemplate_byStringId, c_MQTT_stepIdx_loadTemplate_byStringId, c_MQTT_stepName_loadTemplate_byStringId
send messagef_MQTT_step_send, c_MQTT_stepIdx_send, c_MQTT_stepName_send
set topicf_MQTT_step_setTopic_stringParam, c_MQTT_stepIdx_setTopic_stringParam, c_MQTT_stepName_setTopic_stringParam f_MQTT_step_setTopic_add_stringParam, c_MQTT_stepIdx_setTopic_add_stringParam, c_MQTT_stepName_setTopic_add_stringParam f_MQTT_step_setTopic_add_varParams, c_MQTT_stepIdx_setTopic_add_varParams, c_MQTT_stepName_setTopic_add_varParams f_MQTT_step_setTopic_add_clientId, c_MQTT_stepIdx_setTopic_add_clientId, c_MQTT_stepName_setTopic_add_clientId
set QoSf_MQTT_step_setQos_intParam, c_MQTT_stepIdx_setQos_intParam, c_MQTT_stepName_setQos_intParam
set publish messagef_MQTT_step_setPublishMessage_stringParam, c_MQTT_stepIdx_setPublishMessage_stringParam, c_MQTT_stepName_setPublishMessage_stringParam f_MQTT_step_setPublishMessage_add_stringParam, c_MQTT_stepIdx_setPublishMessage_add_stringParam, c_MQTT_stepName_setPublishMessage_add_stringParam f_MQTT_step_setPublishMessage_add_varParams, c_MQTT_stepIdx_setPublishMessage_add_varParams, c_MQTT_stepName_setPublishMessage_add_varParams f_MQTT_step_setPublishMessage_add_clientId, c_MQTT_stepIdx_setPublishMessage_add_clientId, c_MQTT_stepName_setPublishMessage_add_clientId
MQTTf_MQTT_step_reportPingResponse, c_MQTT_stepIdx_reportPingResponse, c_MQTT_stepName_reportPingResponse
MQTTf_MQTT_step_reportPublishResponse, c_MQTT_stepIdx_reportPublishResponse, c_MQTT_stepName_reportPublishResponse

Class Diagram

Summary
EPTF_MQTT_LGen_DefinitionsThis module contains the definitions for the MQTT load generator component
tsp_EPTF_MQTT_LGen_debugEnabled/disable debug logging
tsp_EPTF_MQTT_LGen_debugVerboseEnabled/disable verbosity of debug logging
tsp_EPTF_MQTT_LGen_maxBindableCtxCan be used to limit the maximum number of contexts set it to -1 otherwise.
tsp_EPTF_MQTT_LGen_templatesMQTT message template definitions for sending
tsp_EPTF_MQTT_PUBLISH_responseWatchdogWatchdog timer value to wait responses to an MQTT PUBLISH message
tsp_EPTF_MQTT_SUBSCRIBE_responseWatchdogWatchdog timer value to wait responses to an MQTT SUBSCRIBE message
MQTT_TemplateGrouping a <MQTT_v3_1_1_ReqResp> with an id
MQTT_Template_ListList of MQTT_Template
MQTT_Template_DBStoring MQTT_Template instances
MQTT_SessionModels and MQTT session
MQTT_Session_StateStates of an MQTT_Session state machine
MQTT_Session_ListList of MQTT_Session
MQTT_Session_DBStoring MQTT_Session instances
MQTT_SubscriptionModels an MQTT subscription
MQTT_Subscription_StateStates of an MQTT_Subscription state machine
MQTT_Subscription_ListList of MQTT_Subscription
MQTT_Subscription_DBStoring MQTT_Subscription instances
MQTT_PublishModels an MQTT publish
MQTT_Publish_SideSide of an MQTT_Publish
MQTT_Publish_StateState of an MQTT_Publish
MQTT_PublishQos1_StateQos1 state of an MQTT_Publish_State
MQTT_PublishQos2_StateQos2 state of an MQTT_Publish_State
MQTT_Publish_ListList of MQTT_Publish
MQTT_Publish_DBStoring MQTT_Publish instances
MQTT_StepCtxType that stores the most important pointers
MQTT_Address_ListList of <Socket>
MQTT_Address_DBStoring <Socket> instances
fcb_EPTF_MQTT_messageReceivedCall-back function type for reporting received MQTT messages
EPTF_MQTT_LGen_CTMQTT load generator component
c_MQTT_eventIdx_transportSuccInteger constant for the MQTT transport succesful indication
c_MQTT_eventName_transportSuccCharstring constant for the MQTT transport succesful indication
c_MQTT_eventIdx_transportFailInteger constant for the MQTT transport fail indication
c_MQTT_eventName_transportFailCharstring constant for the MQTT transport fail indication
c_MQTT_eventIdx_transportEstablishedInteger constant for the MQTT transport established indication
c_MQTT_eventName_transportEstablishedCharstring constant for the MQTT transport established indication
c_MQTT_eventIdx_transportClosedInteger constant for the MQTT transport closed indication
c_MQTT_eventName_transportClosedCharstring constant for the MQTT transport closed indication
c_MQTT_eventIdx_CONNACK_AcceptedInteger constant for the MQTT CONNACK accepted indication
c_MQTT_eventName_CONNACK_AcceptedCharstring constant for the MQTT CONNACK accepted indication
c_MQTT_eventIdx_CONNACK_RefusedInteger constant for the MQTT CONNACK refused indication
c_MQTT_eventName_CONNACK_RefusedCharstring constant for the MQTT CONNACK refused indication
c_MQTT_eventIdx_SUBACK_AcceptedInteger constant for the MQTT SUBACK accepted indication
c_MQTT_eventName_SUBACK_AcceptedCharstring constant for the MQTT SUBACK accepted indication
c_MQTT_eventIdx_SUBACK_RefusedInteger constant for the MQTT SUBACK refused indication
c_MQTT_eventName_SUBACK_RefusedCharstring constant for the MQTT SUBACK refused indication
c_MQTT_eventIdx_UNSUBACKInteger constant for the MQTT UNSUBACK indication
c_MQTT_eventName_UNSUBACKCharstring constant for the MQTT UNSUBACK indication
c_MQTT_eventIdx_PUBLISHInteger constant for the MQTT PUBLISH indication
c_MQTT_eventName_PUBLISHCharstring constant for the MQTT PUBLISH indication
c_MQTT_eventIdx_PING_RequestInteger constant for the MQTT PING request indication
c_MQTT_eventName_PING_RequestCharstring constant for the MQTT PING request indication
c_MQTT_eventIdx_PING_ResponseInteger constant for the MQTT PING response indication
c_MQTT_eventName_PING_ResponseCharstring constant for the MQTT PING response indication
c_MQTT_eventIdx_PUBACKInteger constant for the MQTT PUBACK indication
c_MQTT_eventName_PUBACKCharstring constant for the MQTT PUBACK indication
c_MQTT_eventIdx_PUBRECInteger constant for the MQTT PUBREC indication
c_MQTT_eventName_PUBRECCharstring constant for the MQTT PUBREC indication
c_MQTT_eventIdx_PUBRELInteger constant for the MQTT PUBREL indication
c_MQTT_eventName_PUBRELCharstring constant for the MQTT PUBREL indication
c_MQTT_eventIdx_PUBCOMPInteger constant for the MQTT PUBCOMP indication
c_MQTT_eventName_PUBCOMPCharstring constant for the MQTT PUBCOMP indication
c_MQTT_eventIdx_PUBLISH_TimeoutInteger constant for the MQTT PUBLISH timeout indication
c_MQTT_eventName_PUBLISH_TimeoutCharstring constant for the MQTT PUBLISH timeout indication
c_MQTT_eventIdx_SUBSCRIBE_TimeoutInteger constant for the MQTT SUBSCRIBE timeout indication
c_MQTT_eventName_SUBSCRIBE_TimeoutCharstring constant for the MQTT SUBSCRIBE timeout indication
c_MQTT_stepIdx_initInteger constant for the MQTT init test step
c_MQTT_stepName_initCharstring constant for the MQTT init test step
c_MQTT_stepIdx_cleanUpInteger constant for the MQTT clean up test step
c_MQTT_stepName_cleanUpCharstring constant for the MQTT clean up test step
c_MQTT_stepIdx_setLocalAddressInteger constant for the MQTT set local address
c_MQTT_stepName_setLocalAddressInteger constant for the MQTT set local address
c_MQTT_stepIdx_setLocalAddress_byVarsInteger constant for the MQTT set local address by variables test step
c_MQTT_stepName_setLocalAddress_byVarsInteger constant for the MQTT set local address by variables test step
c_MQTT_stepIdx_setRemoteAddressInteger constant for the MQTT set remote address
c_MQTT_stepName_setRemoteAddressInteger constant for the MQTT set remote address
c_MQTT_stepIdx_setRemoteAddress_byVarsInteger constant for the MQTT set remote address by variables test step
c_MQTT_stepName_setRemoteAddress_byVarsInteger constant for the MQTT set remote address by variables test step
c_MQTT_stepIdx_transportConnectInteger constant for the MQTT transport connect test step
c_MQTT_stepName_transportConnectCharstring constant for the MQTT transport connect test step
c_MQTT_stepIdx_transportCloseInteger constant for the MQTT transport close test step
c_MQTT_stepName_transportCloseCharstring constant for the MQTT transport close test step
c_MQTT_stepIdx_startListeningInteger constant for the MQTT start listening test step
c_MQTT_stepName_startListeningCharstring constant for the MQTT start listening test step
c_MQTT_stepIdx_loadTemplate_byIntIdxInteger constant for the MQTT load template by integer idx pointer test step
c_MQTT_stepName_loadTemplate_byIntIdxCharstring constant for the MQTT load template by integer idx pointer test step
c_MQTT_stepIdx_loadTemplate_byStringIdInteger constant for the MQTT load template by string id test step
c_MQTT_stepName_loadTemplate_byStringIdCharstring constant for the MQTT load template by string id test step
c_MQTT_stepIdx_sendInteger constant for the MQTT send test step
c_MQTT_stepName_sendCharstring constant for the MQTT send test step
c_MQTT_stepIdx_setTopic_stringParamInteger constant for the MQTT set topic by string parameter test step
c_MQTT_stepName_setTopic_stringParamCharstring constant for the MQTT set topic by string parameter test step
c_MQTT_stepIdx_setTopic_add_stringParamInteger constant for the MQTT set topic by adding a string test step
c_MQTT_stepName_setTopic_add_stringParamCharstring constant for the MQTT set topic by adding a string test step
c_MQTT_stepIdx_setTopic_add_varParamsInteger constant for the MQTT set topic by adding variable parameters test step
c_MQTT_stepName_setTopic_add_varParamsCharstring constant for the MQTT set topic by adding variable parameters test step
c_MQTT_stepIdx_setTopic_add_clientIdInteger constant for the MQTT set topic by adding the client id test step
c_MQTT_stepName_setTopic_add_clientIdCharstring constant for the MQTT set topic by adding the client id test step
c_MQTT_stepIdx_setQos_intParamInteger constant for the MQTT set QoS using integer parameter test step
c_MQTT_stepName_setQos_intParamCharstring constant for the MQTT set QoS using integer parameter test step
c_MQTT_stepIdx_setPublishMessage_stringParamInteger constant for the MQTT set publish message using a string parameter test step
c_MQTT_stepName_setPublishMessage_stringParamCharstring constant for the MQTT set publish message using a string parameter test step
c_MQTT_stepIdx_setPublishMessage_add_stringParamInteger constant for the MQTT set publish by adding a string parameter test step
c_MQTT_stepName_setPublishMessage_add_stringParamCharstring constant for the MQTT set publish by adding a string parameter test step
c_MQTT_stepIdx_setPublishMessage_add_varParamsInteger constant for the MQTT set publish by adding variable parameters test step
c_MQTT_stepName_setPublishMessage_add_varParamsCharstring constant for the MQTT set publish by adding variable parameters test step
c_MQTT_stepIdx_setPublishMessage_add_clientIdInteger constant for the MQTT set publish by adding the client id test step
c_MQTT_stepName_setPublishMessage_add_clientIdCharstring constant for the MQTT set publish by adding the client id test step
c_MQTT_stepIdx_reportPingResponseInteger constant for the MQTT enabling/disabling the reporting of a ping response test step
c_MQTT_stepName_reportPingResponseCharstring constant for the MQTT enabling/disabling the reporting of a ping response test step
c_MQTT_stepIdx_reportPublishResponseInteger constant for the MQTT enabling/disabling the reporting of a publish response test step
c_MQTT_stepName_reportPublishResponseCharstring constant for the MQTT enabling/disabling the reporting of a publish response test step

tsp_EPTF_MQTT_LGen_debug

Purpose

Enabled/disable debug logging

Type

boolean

Default value

false

tsp_EPTF_MQTT_LGen_debugVerbose

Purpose

Enabled/disable verbosity of debug logging

Type

boolean

Default value

false

tsp_EPTF_MQTT_LGen_maxBindableCtx

Purpose

Can be used to limit the maximum number of contexts set it to -1 otherwise.

Type

integer

Default value

-1

tsp_EPTF_MQTT_LGen_templates

Purpose

MQTT message template definitions for sending

Type

MQTT_Template_List

Default value

Empty list: {}

tsp_EPTF_MQTT_PUBLISH_responseWatchdog

Purpose

Watchdog timer value to wait responses to an MQTT PUBLISH message

Type

float

Default value

Empty list: {}

tsp_EPTF_MQTT_SUBSCRIBE_responseWatchdog

Purpose

Watchdog timer value to wait responses to an MQTT SUBSCRIBE message

Type

float

Default value

Empty list: {}

MQTT_Template

type record MQTT_Template

Purpose

Grouping a <MQTT_v3_1_1_ReqResp> with an id

Elements

idcharstring - identifier
msg<MQTT_v3_1_1_ReqResp> - MQTT PDU

MQTT_Template_List

type record of MQTT_Template MQTT_Template_List

Purpose

List of MQTT_Template

MQTT_Template_DB

type record MQTT_Template_DB

Purpose

Storing MQTT_Template instances

Class

Elements

dataMQTT_Template_List - elements
hashRefcharstring2int hash reference

Related Functions

MQTT_Session

type record MQTT_Session

Purpose

Models and MQTT session

Class

FSM Diagram of a MQTT session

Elements

eIdxinteger - pointer to the entity that owns the session
fsmIdxinteger - pointer to the fsm that owns the session
localAddressIdxinteger - pointer to the local address in v_MQTT_addressDB
remoteAddressIdxinteger - pointer to the remote address in v_MQTT_addressDB
clientIdcharstring - the client ID used in the session
keepAliveTimefloat - timer used for sending keep alive messages
nextPacketIdinteger - id used for the next packet
subscriptionRefs<EPTF_IntegerList> - pointer to subscriptions in v_MQTT_subscriptionDB MQTT_Subscription_DB
publishRefs<EPTF_IntegerList> - pointer to publications in v_MQTT_publishDB MQTT_Publish_DB
keepaliveTimerinteger - reference for the keep alive timer in the scheduler
reportPingResponseboolean - enable/disable reporting of ping responses
reportPublishResponseboolean - enable/disabled reporting of publish responses
stateMQTT_Session_State - state of an MQTT session

Related Functions

MQTT_Session_State

Purpose

States of an MQTT_Session state machine

Elements

  • DISCONNECTED
  • CONNECTING
  • CONNECTED
  • REMOVING

MQTT_Session_List

type record of MQTT_Session MQTT_Session_List

Purpose

List of MQTT_Session

MQTT_Session_DB

type record MQTT_Session_DB

Purpose

Storing MQTT_Session instances

Class

Elements

queue<EPTF_FreeBusyQueue> - free-busy queue to provide dynamic array
dataMQTT_Session_List - elements
hashRefstr2int hash reference

Related Functions

MQTT_Subscription

type record MQTT_Subscription

Purpose

Models an MQTT subscription

Class

Elements

sessionIdxinteger - the session, the subscription belongs to
watchdogTimerinteger - reference to the watchod timer
request<MQTT_v3_1_1_Subscribe> - the MQTT PDU that initialized the subscription (optional)
stateMQTT_Subscription_State - state of an MQTT subscription

Related Functions

  • <f_EPTF_MQTT_subscription_fromSession>(inout EPTF_MQTT_PDU p_msg, in integer p_subIdx)
  • <f_EPTF_MQTT_subscription_fromEnv>(inout EPTF_MQTT_PDU p_msg, in integer p_subIdx)
  • <f_EPTF_MQTT_subscription_setState>(in integer p_subIdx, in MQTT_Subscription_State p_nextState)
  • <f_EPTF_MQTT_subscription_remove>(in integer p_subIdx)

FSM Diagram of a MQTT subscription

MQTT_Subscription_State

Purpose

States of an MQTT_Subscription state machine

Elements

  • UNSUBSCRIBED
  • SUBSCRIBING
  • SUBSCRIBED
  • UNSUBSCRIBING
  • REMOVING

MQTT_Subscription_List

type record of MQTT_Subscription MQTT_Subscription_List

Purpose

List of MQTT_Subscription

MQTT_Subscription_DB

type record MQTT_Subscription_DB

Purpose

Storing MQTT_Subscription instances

Class

Elements

queue<EPTF_FreeBusyQueue> - free-busy queue to provide dynamic array
dataMQTT_Subscription_List - elements
hashRefstr2int hash reference

Related Functions

MQTT_Publish

type record MQTT_Publish

Purpose

Models an MQTT publish

Class

Elements

sessionIdxinteger - the session, the subscription belongs to
packetIdinteger - packet id
watchdogTimerinteger - reference to the watchdog timer in the scheduler
sideMQTT_Publish_Side - originating or terminating side of the publication
stateMQTT_Publish_State - state of an MQTT publish

Related Functions

FSM Diagram of a MQTT publish

MQTT_Publish_Side

Purpose

Side of an MQTT_Publish

Elements

  • ORIG
  • TERM

MQTT_Publish_State

type union MQTT_Publish_State

Purpose

State of an MQTT_Publish

Elements

qos1MQTT_PublishQos1_State - QoS1 state
qos2MQTT_PublishQos2_State - QoS2 state
createdboolean - just created
removingboolean - currently removing

MQTT_PublishQos1_State

Purpose

Qos1 state of an MQTT_Publish_State

Elements

  • CREATED
  • PUBLISHED
  • ACKNOWLEDGED

MQTT_PublishQos2_State

Purpose

Qos2 state of an MQTT_Publish_State

Elements

  • CREATED
  • PUBLISHED
  • RECEIVED
  • RELEASED
  • COMPLETE

MQTT_Publish_List

type record of MQTT_Publish MQTT_Publish_List

Purpose

List of MQTT_Publish

MQTT_Publish_DB

type record MQTT_Publish_DB

Purpose

Storing MQTT_Publish instances

Class

Elements

queue<EPTF_FreeBusyQueue> - free-busy queue to provide dynamic array
dataMQTT_Publish_List - elements
hashRefstr2int hash reference

Related Functions

MQTT_StepCtx

type record MQTT_StepCtx

Purpose

Type that stores the most important pointers

Elements

eIdxinteger - entity index
fsmIdxinteger - fsm index
sessionIdxinteger - MQTT session index MQTT_Session

MQTT_Address_List

type record of Socket MQTT_Address_List

Purpose

List of <Socket>

MQTT_Address_DB

type record MQTT_Address_DB

Purpose

Storing <Socket> instances

Class

Elements

queue<EPTF_FreeBusyQueue> - free-busy queue to provide dynamic array
dataMQTT_Address_List - elements
hashRefstr2int hash reference

Related Functions

fcb_EPTF_MQTT_messageReceived

type function fcb_EPTF_MQTT_messageReceived(
   in EPTF_MQTT_PDU pl_message
) runs on self

Purpose

Call-back function type for reporting received MQTT messages

Elements

pl_messagein EPTF_MQTT_PDU - received MQTT message

EPTF_MQTT_LGen_CT

type component EPTF_MQTT_LGen_CT extends EPTF_MQTT_Transport_User_CT, EPTF_LGenBase_CT, EPTF_Logging_CT

Purpose

MQTT load generator component

Class

Extensions

Ports

-

Timers

-

Variables

v_MQTT_initializedboolean - Flag to indicate that if init function was already called
v_MQTT_bIdxinteger - Name of the NAS_EPS LGen component
v_MQTT_loggingMaskIdinteger - logging mask id
v_MQTT_ctxMQTT_StepCtx - collection of the most important pointers
v_MQTT_sessionMQTT_Session - temporary variable for a MQTT_Session
v_MQTT_subscriptionMQTT_Subscription - temporary variable for a MQTT_Subscription
v_MQTT_publishMQTT_Publish - temporary variable for a MQTT_Publish
v_MQTT_msgToProcessEPTF_MQTT_PDU - message to process
v_MQTT_msgToSendEPTF_MQTT_PDU - message to send
vf_MQTT_msgReceivedfcb_EPTF_MQTT_messageReceived - Function hook for reporting received messages

Instance databases

v_MQTT_addressDBMQTT_Address_DB - address database of <Socket>
v_MQTT_templateDBMQTT_Template_DB - template database MQTT_Template
v_MQTT_sessionDBMQTT_Session_DB - MQTT session database of MQTT_Session
v_MQTT_subscriptionDBMQTT_Subscription_DB - MQTT subscription database of MQTT_Subscription
v_MQTT_publishDBMQTT_Publish_DB - MQTT publish database of MQTT_Session

Related Functions

c_MQTT_eventIdx_transportSucc

const integer c_MQTT_eventIdx_transportSucc := 0

Purpose

Integer constant for the MQTT transport succesful indication

c_MQTT_eventName_transportSucc

const charstring c_MQTT_eventName_transportSucc := "MQTT transport: succ rsp"

Purpose

Charstring constant for the MQTT transport succesful indication

c_MQTT_eventIdx_transportFail

const integer c_MQTT_eventIdx_transportFail := 1

Purpose

Integer constant for the MQTT transport fail indication

c_MQTT_eventName_transportFail

const charstring c_MQTT_eventName_transportFail := "MQTT transport: fail rsp"

Purpose

Charstring constant for the MQTT transport fail indication

c_MQTT_eventIdx_transportEstablished

const integer c_MQTT_eventIdx_transportEstablished := 2

Purpose

Integer constant for the MQTT transport established indication

c_MQTT_eventName_transportEstablished

const charstring c_MQTT_eventName_transportEstablished := "MQTT transport: connection established"

Purpose

Charstring constant for the MQTT transport established indication

c_MQTT_eventIdx_transportClosed

const integer c_MQTT_eventIdx_transportClosed := 3

Purpose

Integer constant for the MQTT transport closed indication

c_MQTT_eventName_transportClosed

const charstring c_MQTT_eventName_transportClosed := "MQTT transport: connection closed"

Purpose

Charstring constant for the MQTT transport closed indication

c_MQTT_eventIdx_CONNACK_Accepted

const integer c_MQTT_eventIdx_CONNACK_Accepted := 4

Purpose

Integer constant for the MQTT CONNACK accepted indication

c_MQTT_eventName_CONNACK_Accepted

const charstring c_MQTT_eventName_CONNACK_Accepted := "MQTT rsp: CONNACK Accepted"

Purpose

Charstring constant for the MQTT CONNACK accepted indication

c_MQTT_eventIdx_CONNACK_Refused

const integer c_MQTT_eventIdx_CONNACK_Refused := 5

Purpose

Integer constant for the MQTT CONNACK refused indication

c_MQTT_eventName_CONNACK_Refused

const charstring c_MQTT_eventName_CONNACK_Refused := "MQTT rsp: CONNACK Refused"

Purpose

Charstring constant for the MQTT CONNACK refused indication

c_MQTT_eventIdx_SUBACK_Accepted

const integer c_MQTT_eventIdx_SUBACK_Accepted := 6

Purpose

Integer constant for the MQTT SUBACK accepted indication

c_MQTT_eventName_SUBACK_Accepted

const charstring c_MQTT_eventName_SUBACK_Accepted := "MQTT rsp: SUBACK Accepted"

Purpose

Charstring constant for the MQTT SUBACK accepted indication

c_MQTT_eventIdx_SUBACK_Refused

const integer c_MQTT_eventIdx_SUBACK_Refused := 7

Purpose

Integer constant for the MQTT SUBACK refused indication

c_MQTT_eventName_SUBACK_Refused

const charstring c_MQTT_eventName_SUBACK_Refused := "MQTT rsp: SUBACK Refused"

Purpose

Charstring constant for the MQTT SUBACK refused indication

c_MQTT_eventIdx_UNSUBACK

const integer c_MQTT_eventIdx_UNSUBACK := 8

Purpose

Integer constant for the MQTT UNSUBACK indication

c_MQTT_eventName_UNSUBACK

const charstring c_MQTT_eventName_UNSUBACK := "MQTT rsp: UNSUBACK"

Purpose

Charstring constant for the MQTT UNSUBACK indication

c_MQTT_eventIdx_PUBLISH

const integer c_MQTT_eventIdx_PUBLISH := 9

Purpose

Integer constant for the MQTT PUBLISH indication

c_MQTT_eventName_PUBLISH

const charstring c_MQTT_eventName_PUBLISH := "MQTT req: PUBLISH"

Purpose

Charstring constant for the MQTT PUBLISH indication

c_MQTT_eventIdx_PING_Request

const integer c_MQTT_eventIdx_PING_Request := 10

Purpose

Integer constant for the MQTT PING request indication

c_MQTT_eventName_PING_Request

const charstring c_MQTT_eventName_PING_Request := "MQTT req: PING"

Purpose

Charstring constant for the MQTT PING request indication

c_MQTT_eventIdx_PING_Response

const integer c_MQTT_eventIdx_PING_Response := 11

Purpose

Integer constant for the MQTT PING response indication

c_MQTT_eventName_PING_Response

const charstring c_MQTT_eventName_PING_Response := "MQTT rsp: PING"

Purpose

Charstring constant for the MQTT PING response indication

c_MQTT_eventIdx_PUBACK

const integer c_MQTT_eventIdx_PUBACK := 12

Purpose

Integer constant for the MQTT PUBACK indication

c_MQTT_eventName_PUBACK

const charstring c_MQTT_eventName_PUBACK := "MQTT rsp: PUBACK"

Purpose

Charstring constant for the MQTT PUBACK indication

c_MQTT_eventIdx_PUBREC

const integer c_MQTT_eventIdx_PUBREC := 13

Purpose

Integer constant for the MQTT PUBREC indication

c_MQTT_eventName_PUBREC

const charstring c_MQTT_eventName_PUBREC := "MQTT rsp: PUBREC"

Purpose

Charstring constant for the MQTT PUBREC indication

c_MQTT_eventIdx_PUBREL

const integer c_MQTT_eventIdx_PUBREL := 14

Purpose

Integer constant for the MQTT PUBREL indication

c_MQTT_eventName_PUBREL

const charstring c_MQTT_eventName_PUBREL := "MQTT req: PUBREL"

Purpose

Charstring constant for the MQTT PUBREL indication

c_MQTT_eventIdx_PUBCOMP

const integer c_MQTT_eventIdx_PUBCOMP := 15

Purpose

Integer constant for the MQTT PUBCOMP indication

c_MQTT_eventName_PUBCOMP

const charstring c_MQTT_eventName_PUBCOMP := "MQTT rsp: PUBCOMP"

Purpose

Charstring constant for the MQTT PUBCOMP indication

c_MQTT_eventIdx_PUBLISH_Timeout

const integer c_MQTT_eventIdx_PUBLISH_Timeout := 16

Purpose

Integer constant for the MQTT PUBLISH timeout indication

c_MQTT_eventName_PUBLISH_Timeout

const charstring c_MQTT_eventName_PUBLISH_Timeout := "MQTT timeout: PUBLISH Timeout"

Purpose

Charstring constant for the MQTT PUBLISH timeout indication

c_MQTT_eventIdx_SUBSCRIBE_Timeout

const integer c_MQTT_eventIdx_SUBSCRIBE_Timeout := 17

Purpose

Integer constant for the MQTT SUBSCRIBE timeout indication

c_MQTT_eventName_SUBSCRIBE_Timeout

const charstring c_MQTT_eventName_SUBSCRIBE_Timeout := "MQTT timeout: SUBSCRIBE Timeout"

Purpose

Charstring constant for the MQTT SUBSCRIBE timeout indication

c_MQTT_stepIdx_init

const integer c_MQTT_stepIdx_init := 0

Purpose

Integer constant for the MQTT init test step

Related Function

c_MQTT_stepName_init

const charstring c_MQTT_stepName_init := "MQTT Applib: init"

Purpose

Charstring constant for the MQTT init test step

Related Function

c_MQTT_stepIdx_cleanUp

const integer c_MQTT_stepIdx_cleanUp := 1

Purpose

Integer constant for the MQTT clean up test step

Related Function

c_MQTT_stepName_cleanUp

const charstring c_MQTT_stepName_cleanUp := "MQTT Applib: cleanUp"

Purpose

Charstring constant for the MQTT clean up test step

Related Function

c_MQTT_stepIdx_setLocalAddress

const integer c_MQTT_stepIdx_setLocalAddress := 2

Purpose

Integer constant for the MQTT set local address

Related Function

c_MQTT_stepName_setLocalAddress

const charstring c_MQTT_stepName_setLocalAddress := "MQTT Applib: setLocalAddress"

Purpose

Integer constant for the MQTT set local address

Related Function

c_MQTT_stepIdx_setLocalAddress_byVars

const integer c_MQTT_stepIdx_setLocalAddress_byVars := 3

Purpose

Integer constant for the MQTT set local address by variables test step

Related Function

c_MQTT_stepName_setLocalAddress_byVars

const charstring c_MQTT_stepName_setLocalAddress_byVars := "MQTT Applib: setLocalAddress_byVars"

Purpose

Integer constant for the MQTT set local address by variables test step

Related Function

c_MQTT_stepIdx_setRemoteAddress

const integer c_MQTT_stepIdx_setRemoteAddress := 4

Purpose

Integer constant for the MQTT set remote address

Related Function

c_MQTT_stepName_setRemoteAddress

const charstring c_MQTT_stepName_setRemoteAddress := "MQTT Applib: setRemoteAddress"

Purpose

Integer constant for the MQTT set remote address

Related Function

c_MQTT_stepIdx_setRemoteAddress_byVars

const integer c_MQTT_stepIdx_setRemoteAddress_byVars := 5

Purpose

Integer constant for the MQTT set remote address by variables test step

Related Function

c_MQTT_stepName_setRemoteAddress_byVars

const charstring c_MQTT_stepName_setRemoteAddress_byVars := "MQTT Applib: setRemoteAddress_byVars"

Purpose

Integer constant for the MQTT set remote address by variables test step

Related Function

c_MQTT_stepIdx_transportConnect

const integer c_MQTT_stepIdx_transportConnect := 6

Purpose

Integer constant for the MQTT transport connect test step

Related Function

c_MQTT_stepName_transportConnect

const charstring c_MQTT_stepName_transportConnect := "MQTT Applib: transportConnect"

Purpose

Charstring constant for the MQTT transport connect test step

Related Function

c_MQTT_stepIdx_transportClose

const integer c_MQTT_stepIdx_transportClose := 7

Purpose

Integer constant for the MQTT transport close test step

Related Function

c_MQTT_stepName_transportClose

const charstring c_MQTT_stepName_transportClose := "MQTT Applib: transportClose"

Purpose

Charstring constant for the MQTT transport close test step

Related Function

c_MQTT_stepIdx_startListening

const integer c_MQTT_stepIdx_startListening := 8

Purpose

Integer constant for the MQTT start listening test step

Related Function

c_MQTT_stepName_startListening

const charstring c_MQTT_stepName_startListening := "MQTT Applib: startListening"

Purpose

Charstring constant for the MQTT start listening test step

Related Function

c_MQTT_stepIdx_loadTemplate_byIntIdx

const integer c_MQTT_stepIdx_loadTemplate_byIntIdx := 9

Purpose

Integer constant for the MQTT load template by integer idx pointer test step

Related Function

c_MQTT_stepName_loadTemplate_byIntIdx

const charstring c_MQTT_stepName_loadTemplate_byIntIdx := "MQTT Applib: loadTemplate_byIntIdx"

Purpose

Charstring constant for the MQTT load template by integer idx pointer test step

Related Function

c_MQTT_stepIdx_loadTemplate_byStringId

const integer c_MQTT_stepIdx_loadTemplate_byStringId := 10

Purpose

Integer constant for the MQTT load template by string id test step

Related Function

c_MQTT_stepName_loadTemplate_byStringId

const charstring c_MQTT_stepName_loadTemplate_byStringId := "MQTT Applib: loadTemplate_byStringId"

Purpose

Charstring constant for the MQTT load template by string id test step

Related Function

c_MQTT_stepIdx_send

const integer c_MQTT_stepIdx_send := 11

Purpose

Integer constant for the MQTT send test step

Related Function

c_MQTT_stepName_send

const charstring c_MQTT_stepName_send := "MQTT Applib: send"

Purpose

Charstring constant for the MQTT send test step

Related Function

c_MQTT_stepIdx_setTopic_stringParam

const integer c_MQTT_stepIdx_setTopic_stringParam := 12

Purpose

Integer constant for the MQTT set topic by string parameter test step

Related Function

c_MQTT_stepName_setTopic_stringParam

const charstring c_MQTT_stepName_setTopic_stringParam := "MQTT Applib: setTopic_stringParam"

Purpose

Charstring constant for the MQTT set topic by string parameter test step

Related Function

c_MQTT_stepIdx_setTopic_add_stringParam

const integer c_MQTT_stepIdx_setTopic_add_stringParam := 13

Purpose

Integer constant for the MQTT set topic by adding a string test step

Related Function

c_MQTT_stepName_setTopic_add_stringParam

const charstring c_MQTT_stepName_setTopic_add_stringParam := "MQTT Applib: setTopic_add_stringParam"

Purpose

Charstring constant for the MQTT set topic by adding a string test step

Related Function

c_MQTT_stepIdx_setTopic_add_varParams

const integer c_MQTT_stepIdx_setTopic_add_varParams := 14

Purpose

Integer constant for the MQTT set topic by adding variable parameters test step

Related Function

c_MQTT_stepName_setTopic_add_varParams

const charstring c_MQTT_stepName_setTopic_add_varParams := "MQTT Applib: setTopic_add_varParams"

Purpose

Charstring constant for the MQTT set topic by adding variable parameters test step

Related Function

c_MQTT_stepIdx_setTopic_add_clientId

const integer c_MQTT_stepIdx_setTopic_add_clientId := 15

Purpose

Integer constant for the MQTT set topic by adding the client id test step

Related Function

c_MQTT_stepName_setTopic_add_clientId

const charstring c_MQTT_stepName_setTopic_add_clientId := "MQTT Applib: setTopic_add_clientId"

Purpose

Charstring constant for the MQTT set topic by adding the client id test step

Related Function

c_MQTT_stepIdx_setQos_intParam

const integer c_MQTT_stepIdx_setQos_intParam := 16

Purpose

Integer constant for the MQTT set QoS using integer parameter test step

Related Function

c_MQTT_stepName_setQos_intParam

const charstring c_MQTT_stepName_setQos_intParam := "MQTT Applib: setQos_intParam"

Purpose

Charstring constant for the MQTT set QoS using integer parameter test step

Related Function

c_MQTT_stepIdx_setPublishMessage_stringParam

const integer c_MQTT_stepIdx_setPublishMessage_stringParam := 17

Purpose

Integer constant for the MQTT set publish message using a string parameter test step

Related Function

c_MQTT_stepName_setPublishMessage_stringParam

const charstring c_MQTT_stepName_setPublishMessage_stringParam := "MQTT Applib: setPublishMessage_stringParam"

Purpose

Charstring constant for the MQTT set publish message using a string parameter test step

Related Function

c_MQTT_stepIdx_setPublishMessage_add_stringParam

const integer c_MQTT_stepIdx_setPublishMessage_add_stringParam := 18

Purpose

Integer constant for the MQTT set publish by adding a string parameter test step

Related Function

c_MQTT_stepName_setPublishMessage_add_stringParam

const charstring c_MQTT_stepName_setPublishMessage_add_stringParam := "MQTT Applib: setPublishMessage_add_stringParam"

Purpose

Charstring constant for the MQTT set publish by adding a string parameter test step

Related Function

c_MQTT_stepIdx_setPublishMessage_add_varParams

const integer c_MQTT_stepIdx_setPublishMessage_add_varParams := 19

Purpose

Integer constant for the MQTT set publish by adding variable parameters test step

Related Function

c_MQTT_stepName_setPublishMessage_add_varParams

const charstring c_MQTT_stepName_setPublishMessage_add_varParams := "MQTT Applib: setPublishMessage_add_varParams"

Purpose

Charstring constant for the MQTT set publish by adding variable parameters test step

Related Function

c_MQTT_stepIdx_setPublishMessage_add_clientId

const integer c_MQTT_stepIdx_setPublishMessage_add_clientId := 20

Purpose

Integer constant for the MQTT set publish by adding the client id test step

Related Function

c_MQTT_stepName_setPublishMessage_add_clientId

const charstring c_MQTT_stepName_setPublishMessage_add_clientId := "MQTT Applib: setPublishMessage_add_clientId"

Purpose

Charstring constant for the MQTT set publish by adding the client id test step

Related Function

c_MQTT_stepIdx_reportPingResponse

const integer c_MQTT_stepIdx_reportPingResponse := 21

Purpose

Integer constant for the MQTT enabling/disabling the reporting of a ping response test step

Related Function

c_MQTT_stepName_reportPingResponse

const charstring c_MQTT_stepName_reportPingResponse := "MQTT Applib: reportPingResponse"

Purpose

Charstring constant for the MQTT enabling/disabling the reporting of a ping response test step

Related Function

c_MQTT_stepIdx_reportPublishResponse

const integer c_MQTT_stepIdx_reportPublishResponse := 22

Purpose

Integer constant for the MQTT enabling/disabling the reporting of a publish response test step

Related Function

c_MQTT_stepName_reportPublishResponse

const charstring c_MQTT_stepName_reportPublishResponse := "MQTT Applib: reportPublishResponse"

Purpose

Charstring constant for the MQTT enabling/disabling the reporting of a publish response test step

Related Function

type record MQTT_Template
Grouping a MQTT_v3_1_1_ReqResp with an id
type record of MQTT_Template MQTT_Template_List
List of MQTT_Template
type record MQTT_Template_DB
Storing MQTT_Template instances
type record MQTT_Session
Models and MQTT session
type record of MQTT_Session MQTT_Session_List
List of MQTT_Session
type record MQTT_Session_DB
Storing MQTT_Session instances
type record MQTT_Subscription
Models an MQTT subscription
type record of MQTT_Subscription MQTT_Subscription_List
List of MQTT_Subscription
type record MQTT_Subscription_DB
Storing MQTT_Subscription instances
type record MQTT_Publish
Models an MQTT publish
type union MQTT_Publish_State
State of an MQTT_Publish
type record of MQTT_Publish MQTT_Publish_List
List of MQTT_Publish
type record MQTT_Publish_DB
Storing MQTT_Publish instances
type record MQTT_StepCtx
Type that stores the most important pointers
type record of Socket MQTT_Address_List
List of Socket
type record MQTT_Address_DB
Storing Socket instances
type function fcb_EPTF_MQTT_messageReceived(
   in EPTF_MQTT_PDU pl_message
) runs on self
Call-back function type for reporting received MQTT messages
type component EPTF_MQTT_LGen_CT extends EPTF_MQTT_Transport_User_CT, EPTF_LGenBase_CT, EPTF_Logging_CT
MQTT load generator component
const integer c_MQTT_eventIdx_transportSucc := 0
Integer constant for the MQTT transport succesful indication
const charstring c_MQTT_eventName_transportSucc := "MQTT transport: succ rsp"
Charstring constant for the MQTT transport succesful indication
const integer c_MQTT_eventIdx_transportFail := 1
Integer constant for the MQTT transport fail indication
const charstring c_MQTT_eventName_transportFail := "MQTT transport: fail rsp"
Charstring constant for the MQTT transport fail indication
const integer c_MQTT_eventIdx_transportEstablished := 2
Integer constant for the MQTT transport established indication
const charstring c_MQTT_eventName_transportEstablished := "MQTT transport: connection established"
Charstring constant for the MQTT transport established indication
const integer c_MQTT_eventIdx_transportClosed := 3
Integer constant for the MQTT transport closed indication
const charstring c_MQTT_eventName_transportClosed := "MQTT transport: connection closed"
Charstring constant for the MQTT transport closed indication
const integer c_MQTT_eventIdx_CONNACK_Accepted := 4
Integer constant for the MQTT CONNACK accepted indication
const charstring c_MQTT_eventName_CONNACK_Accepted := "MQTT rsp: CONNACK Accepted"
Charstring constant for the MQTT CONNACK accepted indication
const integer c_MQTT_eventIdx_CONNACK_Refused := 5
Integer constant for the MQTT CONNACK refused indication
const charstring c_MQTT_eventName_CONNACK_Refused := "MQTT rsp: CONNACK Refused"
Charstring constant for the MQTT CONNACK refused indication
const integer c_MQTT_eventIdx_SUBACK_Accepted := 6
Integer constant for the MQTT SUBACK accepted indication
const charstring c_MQTT_eventName_SUBACK_Accepted := "MQTT rsp: SUBACK Accepted"
Charstring constant for the MQTT SUBACK accepted indication
const integer c_MQTT_eventIdx_SUBACK_Refused := 7
Integer constant for the MQTT SUBACK refused indication
const charstring c_MQTT_eventName_SUBACK_Refused := "MQTT rsp: SUBACK Refused"
Charstring constant for the MQTT SUBACK refused indication
const integer c_MQTT_eventIdx_UNSUBACK := 8
Integer constant for the MQTT UNSUBACK indication
const charstring c_MQTT_eventName_UNSUBACK := "MQTT rsp: UNSUBACK"
Charstring constant for the MQTT UNSUBACK indication
const integer c_MQTT_eventIdx_PUBLISH := 9
Integer constant for the MQTT PUBLISH indication
const charstring c_MQTT_eventName_PUBLISH := "MQTT req: PUBLISH"
Charstring constant for the MQTT PUBLISH indication
const integer c_MQTT_eventIdx_PING_Request := 10
Integer constant for the MQTT PING request indication
const charstring c_MQTT_eventName_PING_Request := "MQTT req: PING"
Charstring constant for the MQTT PING request indication
const integer c_MQTT_eventIdx_PING_Response := 11
Integer constant for the MQTT PING response indication
const charstring c_MQTT_eventName_PING_Response := "MQTT rsp: PING"
Charstring constant for the MQTT PING response indication
const integer c_MQTT_eventIdx_PUBACK := 12
Integer constant for the MQTT PUBACK indication
const charstring c_MQTT_eventName_PUBACK := "MQTT rsp: PUBACK"
Charstring constant for the MQTT PUBACK indication
const integer c_MQTT_eventIdx_PUBREC := 13
Integer constant for the MQTT PUBREC indication
const charstring c_MQTT_eventName_PUBREC := "MQTT rsp: PUBREC"
Charstring constant for the MQTT PUBREC indication
const integer c_MQTT_eventIdx_PUBREL := 14
Integer constant for the MQTT PUBREL indication
const charstring c_MQTT_eventName_PUBREL := "MQTT req: PUBREL"
Charstring constant for the MQTT PUBREL indication
const integer c_MQTT_eventIdx_PUBCOMP := 15
Integer constant for the MQTT PUBCOMP indication
const charstring c_MQTT_eventName_PUBCOMP := "MQTT rsp: PUBCOMP"
Charstring constant for the MQTT PUBCOMP indication
const integer c_MQTT_eventIdx_PUBLISH_Timeout := 16
Integer constant for the MQTT PUBLISH timeout indication
const charstring c_MQTT_eventName_PUBLISH_Timeout := "MQTT timeout: PUBLISH Timeout"
Charstring constant for the MQTT PUBLISH timeout indication
const integer c_MQTT_eventIdx_SUBSCRIBE_Timeout := 17
Integer constant for the MQTT SUBSCRIBE timeout indication
const charstring c_MQTT_eventName_SUBSCRIBE_Timeout := "MQTT timeout: SUBSCRIBE Timeout"
Charstring constant for the MQTT SUBSCRIBE timeout indication
const integer c_MQTT_stepIdx_init := 0
Integer constant for the MQTT init test step
const charstring c_MQTT_stepName_init := "MQTT Applib: init"
Charstring constant for the MQTT init test step
const integer c_MQTT_stepIdx_cleanUp := 1
Integer constant for the MQTT clean up test step
const charstring c_MQTT_stepName_cleanUp := "MQTT Applib: cleanUp"
Charstring constant for the MQTT clean up test step
const integer c_MQTT_stepIdx_setLocalAddress := 2
Integer constant for the MQTT set local address
const charstring c_MQTT_stepName_setLocalAddress := "MQTT Applib: setLocalAddress"
Integer constant for the MQTT set local address
const integer c_MQTT_stepIdx_setLocalAddress_byVars := 3
Integer constant for the MQTT set local address by variables test step
const charstring c_MQTT_stepName_setLocalAddress_byVars := "MQTT Applib: setLocalAddress_byVars"
Integer constant for the MQTT set local address by variables test step
const integer c_MQTT_stepIdx_setRemoteAddress := 4
Integer constant for the MQTT set remote address
const charstring c_MQTT_stepName_setRemoteAddress := "MQTT Applib: setRemoteAddress"
Integer constant for the MQTT set remote address
const integer c_MQTT_stepIdx_setRemoteAddress_byVars := 5
Integer constant for the MQTT set remote address by variables test step
const charstring c_MQTT_stepName_setRemoteAddress_byVars := "MQTT Applib: setRemoteAddress_byVars"
Integer constant for the MQTT set remote address by variables test step
const integer c_MQTT_stepIdx_transportConnect := 6
Integer constant for the MQTT transport connect test step
const charstring c_MQTT_stepName_transportConnect := "MQTT Applib: transportConnect"
Charstring constant for the MQTT transport connect test step
const integer c_MQTT_stepIdx_transportClose := 7
Integer constant for the MQTT transport close test step
const charstring c_MQTT_stepName_transportClose := "MQTT Applib: transportClose"
Charstring constant for the MQTT transport close test step
const integer c_MQTT_stepIdx_startListening := 8
Integer constant for the MQTT start listening test step
const charstring c_MQTT_stepName_startListening := "MQTT Applib: startListening"
Charstring constant for the MQTT start listening test step
const integer c_MQTT_stepIdx_loadTemplate_byIntIdx := 9
Integer constant for the MQTT load template by integer idx pointer test step
const charstring c_MQTT_stepName_loadTemplate_byIntIdx := "MQTT Applib: loadTemplate_byIntIdx"
Charstring constant for the MQTT load template by integer idx pointer test step
const integer c_MQTT_stepIdx_loadTemplate_byStringId := 10
Integer constant for the MQTT load template by string id test step
const charstring c_MQTT_stepName_loadTemplate_byStringId := "MQTT Applib: loadTemplate_byStringId"
Charstring constant for the MQTT load template by string id test step
const integer c_MQTT_stepIdx_send := 11
Integer constant for the MQTT send test step
const charstring c_MQTT_stepName_send := "MQTT Applib: send"
Charstring constant for the MQTT send test step
const integer c_MQTT_stepIdx_setTopic_stringParam := 12
Integer constant for the MQTT set topic by string parameter test step
const charstring c_MQTT_stepName_setTopic_stringParam := "MQTT Applib: setTopic_stringParam"
Charstring constant for the MQTT set topic by string parameter test step
const integer c_MQTT_stepIdx_setTopic_add_stringParam := 13
Integer constant for the MQTT set topic by adding a string test step
const charstring c_MQTT_stepName_setTopic_add_stringParam := "MQTT Applib: setTopic_add_stringParam"
Charstring constant for the MQTT set topic by adding a string test step
const integer c_MQTT_stepIdx_setTopic_add_varParams := 14
Integer constant for the MQTT set topic by adding variable parameters test step
const charstring c_MQTT_stepName_setTopic_add_varParams := "MQTT Applib: setTopic_add_varParams"
Charstring constant for the MQTT set topic by adding variable parameters test step
const integer c_MQTT_stepIdx_setTopic_add_clientId := 15
Integer constant for the MQTT set topic by adding the client id test step
const charstring c_MQTT_stepName_setTopic_add_clientId := "MQTT Applib: setTopic_add_clientId"
Charstring constant for the MQTT set topic by adding the client id test step
const integer c_MQTT_stepIdx_setQos_intParam := 16
Integer constant for the MQTT set QoS using integer parameter test step
const charstring c_MQTT_stepName_setQos_intParam := "MQTT Applib: setQos_intParam"
Charstring constant for the MQTT set QoS using integer parameter test step
const integer c_MQTT_stepIdx_setPublishMessage_stringParam := 17
Integer constant for the MQTT set publish message using a string parameter test step
const charstring c_MQTT_stepName_setPublishMessage_stringParam := "MQTT Applib: setPublishMessage_stringParam"
Charstring constant for the MQTT set publish message using a string parameter test step
const integer c_MQTT_stepIdx_setPublishMessage_add_stringParam := 18
Integer constant for the MQTT set publish by adding a string parameter test step
const charstring c_MQTT_stepName_setPublishMessage_add_stringParam := "MQTT Applib: setPublishMessage_add_stringParam"
Charstring constant for the MQTT set publish by adding a string parameter test step
const integer c_MQTT_stepIdx_setPublishMessage_add_varParams := 19
Integer constant for the MQTT set publish by adding variable parameters test step
const charstring c_MQTT_stepName_setPublishMessage_add_varParams := "MQTT Applib: setPublishMessage_add_varParams"
Charstring constant for the MQTT set publish by adding variable parameters test step
const integer c_MQTT_stepIdx_setPublishMessage_add_clientId := 20
Integer constant for the MQTT set publish by adding the client id test step
const charstring c_MQTT_stepName_setPublishMessage_add_clientId := "MQTT Applib: setPublishMessage_add_clientId"
Charstring constant for the MQTT set publish by adding the client id test step
const integer c_MQTT_stepIdx_reportPingResponse := 21
Integer constant for the MQTT enabling/disabling the reporting of a ping response test step
const charstring c_MQTT_stepName_reportPingResponse := "MQTT Applib: reportPingResponse"
Charstring constant for the MQTT enabling/disabling the reporting of a ping response test step
const integer c_MQTT_stepIdx_reportPublishResponse := 22
Integer constant for the MQTT enabling/disabling the reporting of a publish response test step
const charstring c_MQTT_stepName_reportPublishResponse := "MQTT Applib: reportPublishResponse"
Charstring constant for the MQTT enabling/disabling the reporting of a publish response test step
This module contains the definitions of callback functions for the Applib user API
Enabled/disable debug logging
Enabled/disable verbosity of debug logging
Can be used to limit the maximum number of contexts set it to -1 otherwise.
MQTT message template definitions for sending
Watchdog timer value to wait responses to an MQTT PUBLISH message
Watchdog timer value to wait responses to an MQTT SUBSCRIBE message
function f_MQTT_step_init(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test Step to dynamically allocate and initialize the MQTT FSM context for the caller FSM.
function f_MQTT_step_cleanUp(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test Step to free up the MQTT FSM context for the caller FSM.
function f_MQTT_step_setLocalAddress_byVars(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the local address in the entity context.
function f_MQTT_step_setRemoteAddress_byVars(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the remote address in the FSM context.
function f_MQTT_step_transportConnect(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
The test step expects that local and remote socket adresses are set in the addressDB.
function f_MQTT_step_transportClose(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
The test step expects that a transport endpoint is set in the addressDB as a local address.
function f_MQTT_step_startListening(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
The test step expects that a transport endpoint is set in the addressDB as a local address.
function f_MQTT_step_loadTemplate_byIntIdx(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to load a MQTT_Template from tsp_EPTF_MQTT_LGen_templates into v_MQTT_msgToSend (which can be sent using the send test step) by its integer index in test step args.
function f_MQTT_step_loadTemplate_byStringId(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to load a MQTT_Template from tsp_EPTF_MQTT_LGen_templates into v_MQTT_msgToSend (which can be sent using the send test step) by its string Id.
function f_MQTT_step_send(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to send out an MQTT message from v_MQTT_msgToSend.
function f_MQTT_step_setTopic_stringParam(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the string value referred by the test step argument as the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.
function f_MQTT_step_setTopic_add_stringParam(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to add the string value referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.
function f_MQTT_step_setTopic_add_varParams(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to add the string value of variables referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.
function f_MQTT_step_setTopic_add_clientId(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to add client ID in the current session to the topic in the first subscription in SUBSCRIBE and to PUBLISH message.
function f_MQTT_step_setQos_intParam(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the QoS level in SUBSCRIBE and PUBLISH messages using test step arguments
function f_MQTT_step_setPublishMessage_stringParam(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the content of the payload in PUBLISH message.
function f_MQTT_step_setPublishMessage_add_stringParam(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to concatenate a string to the content of the PUBLISH message
function f_MQTT_step_setPublishMessage_add_varParams(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to add the content of a set of variables to the payload of a PUBLISH message.
function f_MQTT_step_setPublishMessage_add_clientId(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to add client ID of the current session to the payload of a PUBLISH message.
function f_MQTT_step_reportPingResponse(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the report ping response to enable/disable using using step arguments.
function f_MQTT_step_reportPublishResponse(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the report publish response to enable/disable using step arguments
function f_EPTF_MQTT_templateDB_init() runs on EPTF_MQTT_LGen_CT
Initializes the v_MQTT_templateDB MQTT_Template_DB database by adding the templates given in tsp_EPTF_MQTT_LGen_templates
function f_EPTF_MQTT_templateDB_add(
   in MQTT_Template p_template
) runs on EPTF_MQTT_LGen_CT return integer
Adds a new element to the v_MQTT_templateDB MQTT_Template_DB database
function f_EPTF_MQTT_templateDB_lookUp(
   in charstring p_id
) runs on EPTF_MQTT_LGen_CT return integer
Gets the index of an MQTT_Template element in v_MQTT_templateDB MQTT_Template_DB database
function f_EPTF_MQTT_templateDB_get(
   in integer p_idx,
   inout MQTT_v3_1_1_ReqResp p_pdu
) runs on EPTF_MQTT_LGen_CT
Retrieves an element from the v_MQTT_templateDB MQTT_Template_DB database
function f_EPTF_MQTT_templateDB_cleanUp() runs on EPTF_MQTT_LGen_CT
Cleans up the reserved resources of the v_MQTT_templateDB MQTT_Template_DB database
States of an MQTT_Session state machine
function f_EPTF_MQTT_session_fromApp(
   inout EPTF_MQTT_PDU p_msg,
   in integer p_sIdx
) runs on EPTF_MQTT_LGen_CT
This is the entry point for an MQTT session fsm handling events coming from the application layer (e.g.
type record EPTF_MQTT_PDU
Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information
function f_EPTF_MQTT_session_fromEnv(
   inout EPTF_MQTT_PDU p_msg,
   in integer p_sIdx
) runs on EPTF_MQTT_LGen_CT
This is the entry point for an MQTT session fsm from the environment layer (e.g.
function f_EPTF_MQTT_session_keepalive(
   in EPTF_ScheduledAction pl_action,
   in integer pl_eventIndex
) runs on EPTF_MQTT_LGen_CT return boolean
Handles the T_keepalive timer event in the MQTT_Session FSM
function f_EPTF_MQTT_session_startT_keepalive(
   in integer pl_sIdx,
   in float pl_time
) runs on EPTF_MQTT_LGen_CT return boolean
Starts the T_keepalive timer for an MQTT_Session FSM
function f_EPTF_MQTT_session_cancelT_keepalive(
   in integer pl_sessionIdx
) runs on EPTF_MQTT_LGen_CT
Cancels the T_keepalive timer of an MQTT_Session FSM
function f_EPTF_MQTT_session_getNextPacketId(
   in MQTT_StepCtx p_ctx
) runs on EPTF_MQTT_LGen_CT return integer
Sets the value of the packet id field in the next message to be sent in a session
function f_EPTF_MQTT_session_setState(
   in integer p_sessionIdx,
   in MQTT_Session_State p_nextState
) runs on EPTF_MQTT_LGen_CT
Sets a new state for an MQTT_Session FSM
function f_EPTF_MQTT_session_send(
   in integer p_sessionIdx,
   inout EPTF_MQTT_PDU p_msg
) runs on EPTF_MQTT_LGen_CT
Sends a message to the transort layer with type EPTF_MQTT_PDU and the provided session index
function f_EPTF_MQTT_session_registerSubscription(
   in integer p_sessionIdx,
   in integer p_subIdx
) runs on EPTF_MQTT_LGen_CT
Adds a subscription index to an MQTT_Session
function f_EPTF_MQTT_session_deregisterSubscription(
   in integer p_sessionIdx,
   in integer p_subIdx
) runs on EPTF_MQTT_LGen_CT
Removes a subscription index from MQTT_Session
function f_EPTF_MQTT_session_registerPublish(
   in integer p_sessionIdx,
   in integer p_pubIdx
) runs on EPTF_MQTT_LGen_CT
Adds a publish index to an MQTT_Session
function f_EPTF_MQTT_session_deregisterPublish(
   in integer p_sessionIdx,
   in integer p_pubIdx
) runs on EPTF_MQTT_LGen_CT
Removes a publish index from an MQTT_Session
function f_EPTF_MQTT_session_remove(
   in integer p_sessionIdx
) runs on EPTF_MQTT_LGen_CT
Releases all resources related to an MQTT_Session and removes it from the MQTT_Session_DB
function f_EPTF_MQTT_sessionDB_init() runs on EPTF_MQTT_LGen_CT
Initializes the v_MQTT_sessionDB MQTT_Session_DB database and adds its hash to v_MQTT_sessionDB.hashRef
function f_EPTF_MQTT_sessionDB_add(
   in MQTT_Session p_session
) runs on EPTF_MQTT_LGen_CT return integer
Adds a new element to the v_MQTT_sessionDB MQTT_Session_DB database
function f_EPTF_MQTT_sessionDB_lookUp(
   in Socket p_sock
) runs on EPTF_MQTT_LGen_CT return integer
Gets the index of a session in v_MQTT_sessionDB MQTT_Session_DB database by its socket address
function f_EPTF_MQTT_sessionDB_get(
   in integer p_idx,
   inout MQTT_Session p_session
) runs on EPTF_MQTT_LGen_CT return boolean
Retrieves a session’s data from the v_MQTT_sessionDB MQTT_Session_DB database
function f_EPTF_MQTT_sessionDB_setKey(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT
Sets the hash of the local socket address of a session by the session index
function f_EPTF_MQTT_sessionDB_check(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT return boolean
Checks if a session element exists in the v_MQTT_sessionDB MQTT_Session_DB database
function f_EPTF_MQTT_sessionDB_remove(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT
Removes an element from the v_MQTT_sessionDB MQTT_Session_DB database and releases its resources
function f_EPTF_MQTT_sessionDB_addrHash(in Socket p_sock) return charstring
Converts a socket address in Socket type format to the string format “IP address:<port number>” to be used as a hash key
function f_EPTF_MQTT_sessionDB_cleanUp() runs on EPTF_MQTT_LGen_CT
Cleans up the reserved resources of the v_MQTT_sessionDB MQTT_Session_DB database
States of an MQTT_Subscription state machine
function f_EPTF_MQTT_subscriptionDB_init() runs on EPTF_MQTT_LGen_CT
Initializes the v_MQTT_subscriptionDB MQTT_Subscription_DB database
function f_EPTF_MQTT_subscriptionDB_add(
   in MQTT_Subscription p_sub
) runs on EPTF_MQTT_LGen_CT return integer
Adds a new element to the v_MQTT_subscriptionDB MQTT_Subscription_DB database
function f_EPTF_MQTT_subscriptionDB_setKey_packetId(
   in integer p_idx,
   in integer p_sessionIdx,
   in integer p_packetId
) runs on EPTF_MQTT_LGen_CT
Insert an integer element to the subscription hashmap, key is composed from session ID and packet ID
function f_EPTF_MQTT_subscriptionDB_removeKey_packetId(
   in integer p_idx,
   in integer p_sessionIdx,
   in integer p_packetId
) runs on EPTF_MQTT_LGen_CT
Removes the element from the subscription hashmap identified by its session ID and packet ID
function f_EPTF_MQTT_subscriptionDB_lookUp_packetId(
   in integer p_sessionIdx,
   in integer p_packetId
) runs on EPTF_MQTT_LGen_CT return integer
Gets the index of an MQTT_Subscription element in v_MQTT_subscriptionDB MQTT_Subscription_DB database by a session ID and packet ID
function f_EPTF_MQTT_subscriptionDB_lookUp_topicName(
   in integer p_sessionIdx,
   in charstring p_topicName
) runs on EPTF_MQTT_LGen_CT return integer
Gets the index of an MQTT_Subscription element in v_MQTT_subscriptionDB MQTT_Subscription_DB database by a session ID and packet ID
function f_EPTF_MQTT_subscriptionDB_get(
   in integer p_idx,
   inout MQTT_Subscription p_sub
) runs on EPTF_MQTT_LGen_CT return boolean
Retrieves an element from the v_MQTT_subscriptionDB MQTT_Subscription_DB database
function f_EPTF_MQTT_subscriptionDB_check(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT return boolean
Checks if an element at an index exists the v_MQTT_subscriptionDB MQTT_Subscription_DB database
function f_EPTF_MQTT_subscriptionDB_remove(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT
Removes an element from the v_MQTT_subscriptionDB MQTT_Subscription_DB database
function f_EPTF_MQTT_subscriptionDB_packetIdHash(
   in integer p_sessionIdx,
   in integer p_packetId
) return charstring
Converts a pair of session ID & packet ID to the string format “session_sessionId:id_packetId” to be used as hash key
function f_EPTF_MQTT_subscriptionDB_topicHash(
   in integer p_sessionIdx,
   in charstring p_topic
) return charstring
Converts a pair of session ID & topic to the string format “session_sessionId:topic_topic” to be used as hash key
function f_EPTF_MQTT_subscriptionDB_cleanUp() runs on EPTF_MQTT_LGen_CT
Cleans up the reserved resources of the v_MQTT_subscriptionDB MQTT_Subscription_DB database
Side of an MQTT_Publish
function f_EPTF_MQTT_publish_fromSession(
   inout EPTF_MQTT_PDU p_msg,
   in integer p_pubIdx
) runs on EPTF_MQTT_LGen_CT
Handles a publish transaction in case of QoS 1 and QoS 2 fsm requested by the application layer (e.g.
function f_EPTF_MQTT_publish_fromEnv(
   inout EPTF_MQTT_PDU p_msg,
   in integer p_pubIdx
) runs on EPTF_MQTT_LGen_CT
Handles PUBLISH and publish response (PUB REC/PUB REL/PUB COMP) messages received from the peer (i.e.
function f_EPTF_MQTT_publish_watchdog(
   in EPTF_ScheduledAction pl_action,
   in integer pl_eventIndex
) runs on EPTF_MQTT_LGen_CT return boolean
Handles the T_watchdog event in the MQTT_Publish FSM
function f_EPTF_MQTT_publish_startT_watchdog(
   in integer pl_pIdx,
   in float pl_time
) runs on EPTF_MQTT_LGen_CT return boolean
Start a T_watchdog timer in the MQTT_Publish FSM
function f_EPTF_MQTT_publish_cancelT_watchdog(
   in integer pl_publishIdx
) runs on EPTF_MQTT_LGen_CT
Cancels the T_watchdog timer of an MQTT_Publish FSM
function f_EPTF_MQTT_publish_setState(
   in integer p_pubIdx,
   in MQTT_Publish_State p_nextState
) runs on EPTF_MQTT_LGen_CT
Sets the new state of a MQTT_Publish FSM
function f_EPTF_MQTT_publish_remove(
   in integer p_pubIdx
) runs on EPTF_MQTT_LGen_CT
Releaseing resources of an MQTT_Publish FSM
Qos1 state of an MQTT_Publish_State
Qos2 state of an MQTT_Publish_State
function f_EPTF_MQTT_publishDB_init() runs on EPTF_MQTT_LGen_CT
Initializes the v_MQTT_publishDB MQTT_Publish_DB database and creates its hashmap
function f_EPTF_MQTT_publishDB_add(
   in MQTT_Publish p_pub
) runs on EPTF_MQTT_LGen_CT return integer
Adds a new element to the v_MQTT_publishDB MQTT_Publish_DB database
function f_EPTF_MQTT_publishDB_lookUp(
   in integer p_sessionIdx,
   in integer p_packetId
) runs on EPTF_MQTT_LGen_CT return integer
Gets the index of an MQTT_Publish element in v_MQTT_publishDB MQTT_Publish_DB database by its session and packet id-s
function f_EPTF_MQTT_publishDB_get(
   in integer p_idx,
   inout MQTT_Publish p_pub
) runs on EPTF_MQTT_LGen_CT return boolean
Retrieves an element from the v_MQTT_publishDB MQTT_Publish_DB database
function f_EPTF_MQTT_publishDB_check(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT return boolean
Checks if an element exists in the v_MQTT_publishDB MQTT_Publish_DB database
function f_EPTF_MQTT_publishDB_remove(
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT
Removes an element from the v_MQTT_publishDB MQTT_Publish_DB database
function f_EPTF_MQTT_publishDB_packetIdHash(
   in integer p_sessionIdx,
   in integer p_packetId
) return charstring
Converts a pair of session ID & packet ID to the string format “session_sessionId:id_packetId” to be used as a hash key
function f_EPTF_MQTT_publishDB_cleanUp() runs on EPTF_MQTT_LGen_CT
Cleans up the reserved resources of the v_MQTT_publishDB MQTT_Publish_DB database
function f_EPTF_MQTT_addressDB_init() runs on EPTF_MQTT_LGen_CT
Function to initialize the addressDB
function f_EPTF_MQTT_addressDB_add(
   in Socket p_addr,
   inout integer p_idx
) runs on EPTF_MQTT_LGen_CT
Add a socket address to the addressDB and return its index if no such entry yet, or return its index if already exists
function f_EPTF_MQTT_addressDB_lookUp(
   in Socket p_sock
) runs on EPTF_MQTT_LGen_CT return integer
Get the index of a socket entry in addressDB
function f_EPTF_MQTT_addressDB_get(
   inout Socket p_addr,
   in integer p_idx
) runs on EPTF_MQTT_LGen_CT
Get a socket address from the addressDB by its index
function f_EPTF_MQTT_addressDB_Socket2String(Socket p_sock) return charstring
Converts a socket address in Socket type format to the string format “IP address:<port number>” to be used as hash key
function f_EPTF_MQTT_addressDB_cleanUp() runs on EPTF_MQTT_LGen_CT
Function to clean up the address database and release its resources
type component EPTF_MQTT_Transport_User_CT
Base component type for a MQTT transport user realization
function f_EPTF_MQTT_LGen_init(in charstring pl_name) runs on EPTF_MQTT_LGen_CT
The main initialization function for the EPTF_MQTT_LGen_CT component type
function f_EPTF_MQTT_LGen_initLogging() runs on EPTF_MQTT_LGen_CT
Initializing CLL’s logging feature on the EPTF_MQTT_LGen_CT component type
function f_MQTT_cleanUp() runs on EPTF_MQTT_LGen_CT
The main clean up function for the EPTF_MQTT_LGen_CT component type
function f_MQTT_eCtxBind(
   in integer pl_eIdx
) runs on EPTF_MQTT_LGen_CT return EPTF_IntegerList
This function is called by the CLL for each entity instance created on a particular instace of EPTF_MQTT_LGen_CT
function f_MQTT_eCtxUnbind(in integer pl_eIdx) runs on EPTF_MQTT_LGen_CT
The reverse operation of f_MQTT_eCtxBind.
function f_MQTT_eCtxReset(in integer pl_eIdx) runs on EPTF_MQTT_LGen_CT
The resources reserved during f_MQTT_eCtxBind are reinitalized (reset).
function f_EPTF_MQTT_declareEvents() runs on EPTF_MQTT_LGen_CT
Declares the FSM events to the CLL framework implemented by EPTF_MQTT_LGen_CT
function f_EPTF_MQTT_declareSteps() runs on EPTF_MQTT_LGen_CT
Declares the FSM steps to the CLL framework implemented by EPTF_MQTT_LGen_CT
function f_EPTF_MQTT_LGen_receiveMessage(
   in EPTF_MQTT_PDU pl_message
) runs on EPTF_MQTT_LGen_CT
The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received EPTF_MQTT_PDU message to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.
function f_EPTF_MQTT_LGen_receiveEvent(
   in ASP_Event p_event
) runs on EPTF_MQTT_LGen_CT
The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received ASP_Event events to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.
function f_EPTF_MQTT_LGen_transportApiResponse(
   in EPTF_MQTT_Transport_Response pl_rsp
) runs on EPTF_MQTT_LGen_CT
The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received EPTF_MQTT_Transport_Response responses to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.
type record EPTF_MQTT_Transport_Response
Type for transport response
function f_EPTF_MQTT_LGen_send(
   inout EPTF_MQTT_PDU p_msg
) runs on EPTF_MQTT_LGen_CT
This function is used to send out a message of a EPTF_MQTT_PDU using the registered function fcb_EPTF_MQTT_Transport_sendMessage of the underlying transport layer instance.
function f_EPTF_MQTT_stack_fromApp(
   inout EPTF_MQTT_PDU p_msg,
   in MQTT_StepCtx p_ctx
) runs on EPTF_MQTT_LGen_CT
This is the main entry point for the MQTT stack realization of the EPTF_MQTT_LGen_CT component that handles messages received from the application layer (e.g.
function f_EPTF_MQTT_stack_fromEnv(
   inout EPTF_MQTT_PDU p_msg
) runs on EPTF_MQTT_LGen_CT
This is the main entry point for the MQTT stack realization of the EPTF_MQTT_LGen_CT component that handles messages received from the environment layer (e.g.
function f_EPTF_MQTT_isFsmInitialized(
   in integer pl_eIdx,
   in integer pl_fsmIdx,
   inout integer pl_sessionIdx
) runs on EPTF_MQTT_LGen_CT return boolean
Checks if an FSM instance has already been initialized
function f_EPTF_MQTT_Logging_VERBOSE(
   in @lazy charstring pl_message
) runs on EPTF_MQTT_LGen_CT
Logging functions for the VERBOSE log level
function f_EPTF_MQTT_Logging_DEBUG(
   in @lazy charstring pl_message
) runs on EPTF_MQTT_LGen_CT
Logging functions for the DEBUG log level
function f_EPTF_MQTT_Logging_WARNING(
   in @lazy charstring pl_message
) runs on EPTF_MQTT_LGen_CT
Logging functions for the WARNING log level
function f_EPTF_MQTT_Logging_ERROR(
   in @lazy charstring pl_message
) runs on EPTF_MQTT_LGen_CT
Logging functions for the ERROR log level
function f_EPTF_MQTT_dispatchEvent(
   in integer pl_eventIdx,
   in integer pl_eIdx,
   in integer pl_fsmCtx,
   in EPTF_IntegerList pl_reportedArgs
) runs on EPTF_MQTT_LGen_CT
Dispatches events to an entity/fsm
function f_MQTT_step_setLocalAddress(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the local address in the entity context.
function f_MQTT_step_setRemoteAddress(
   in EPTF_LGenBase_TestStepArgs pl_ptr
) runs on EPTF_MQTT_LGen_CT
Test step to set the remote address in the FSM context.