• Home
• Function/Function Block Reference
• PLCnext Controller Function Blocks
• Device Information
• NETLOAD_LIMITER_STATISTIC

NETLOAD_LIMITER_STATISTIC

Type	Function block
Description	The function block allows to get or reset Netload Limiter statistics of network interfaces.
Notes	Function blocks have to be instantiated. The instance name of the function block has to be declared in the 'Variables' table of the POU where the FB is going to be used. The instance name must be unique within the POU.
Parameters	Inputs REQ Data type: BOOL Description: If there is a rising edge at REQ, the Netload Limiter statistic for the NETWORK_INTERFACE_ID will be retrieved. If the operation has been finished and the outputs DONE or ERROR are TRUE, REQ must be set to FALSE to allow a new request or reset. Note REQ = TRUE and RESET = TRUE at the same time will neither start a request nor a reset. That means also that after executing a request the outputs REQ and RESET have to be false to enable a new request or reset. RESET Data type: BOOL Description: If there is a rising edge at RESET, the Netload Limiter statistic for the NETWORK_INTERFACE_ID will be reset. If the operation has been finished and the outputs DONE or ERROR are TRUE, RESET must be set to FALSE to allow a new request or reset. If NETWORK_INTERFACE_ID = 0, the Netload Limiter statistics of all network interfaces will be reset. Note REQ = TRUE and RESET = TRUE at the same time will neither start a request nor a reset. That means also that after executing a reset the REQ and RESET have to be false to enable a new request or reset. NETWORK_INTERFACE_ID Data type: BYTE Description: The ID of the network interface, the request or reset is executed for. The first network interface has the ID 1. Outputs DONE Data type: BOOL Description: TRUE: The operation is finished, and no error occurred. DONE remains TRUE until a falling edge at REQ or RESET occurs. BUSY Data type: BOOL Description: TRUE: The function block is executing the operation. ERROR remains TRUE until a falling edge at REQ or RESET occurs. ERROR Data type: BOOL Description: If an error occurs, the ERROR output is set to TRUE. As long as ERROR = TRUE, the STATUS output indicates information about the cause. The STATUS output will be reset at a falling edge at the REQ or RESET input. See below for a description of the possible error codes. STATUS Data type: DWORD Description: Provides the error code in the event of an error (ERROR = TRUE). See below for a description of the possible error codes. STATISTIC_RESULT Data type: NETLOAD_LIMITER_STATISTIC_RESULT Description: IF REQ = TRUE and DONE = TRUE, STATISTIC_RESULT contains the Netload Limiter statistic of the network interface with ID NETWORK_INTERFACE_ID. NETLOAD_LIMITER_STATISTIC_RESULT structure elements Structure element Data type Description NETWORK_INTERFACE_ID BYTE Contains the ID of the network interface. PACKET_LIMITER LIMITER_STATISTIC Contains the statistic of the Packet Limiter. The unit of the elements MOVING_AVERAGE, MOVING_AVERAGE_MAX, and PEAK is 'Packets per ms'. BYTE_LIMITER LIMITER_STATISTIC Contains the statistic of the ByteLimiter. The unit of the elements MOVING_AVERAGE, MOVING_AVERAGE_MAX, and PEAK is 'Byte per ms'. DURATION_SINCE_LAST_RESET ULINT Contains the time (in μs) since the statistic was reset the last time. LIMITER_STATISTIC structure elements Structure element Data type Description MOVING_AVERAGE UDINT Moving average (over 1 s). The unit depends on the limiter and is packets/byte per milliseconds. MOVING_AVERAGE_MAX UDINT Max. value of MOVING_AVERAGE. The unit depends on the limiter and is packets/byte per milliseconds. PEAK UDINT Highest value. The unit depends on the limiter and is packets/byte per milliseconds. LIMITING_DURATION ULINT Duration (in μs) the limiter was limiting (accumulated). LIMITING_EVENT_COUNT UDINT Number of limiting events that occurred since last reset.
Error codes	Error codes at the STATUS output Error code Meaning 0 No error occurred. 1 Unknown interface 2 Limit value is out of range. 3 Network interface does not support the Netload Limiter function. 4 An internal error occurred in the Rsc service. 5 Invalid inputs: REQ and RESET cannot be triggered simultaneously. 6 An internal error occurred in the function block.