Document metadata
Application name |
CSK_Module_MultiUDPSocket |
|---|---|
Version |
1.0.0 |
Date |
2025-09-29 |
Author |
SICK AG |
Crowns
- C
- M
CSK_Module_MultiUDPSocket
Short description
Auto generated Crown (not needed)
CSK_MultiUDPSocket
Short description
Module to provide UDP socket functionality for multiple instances. Other modules can access its features / settings.
This module provides a UI for all relevant features.
Typically the features of this module are used like this (check also main script of this module):
1) Setup the UDP socket configuration
- Select instance via 'setSelectedInstance'.
- Set interface via 'setInterface'.
- Set IP address of UDP data receiver via 'setIP'.
- Set port via 'setPort'.
- Connect to server via 'setConnectionStatus'.
2) Forward content via UDP socket, also by other modules
To send content via UDP, there are different possibilities.
You can make use of 'transmitData[NUM]' to directly send the content with this function (NUM = instnace to use).
Additionally it is possible to configure the module to listen / wait for specific events of other modules/apps and to forward their content via UDP.
This can be used e.g. to listen to 'OtherModule.OnNewResult'-events and to forward the results via UDP (data will be converted to data type 'string').
To do so make use of 'addEventToForward' (via script) or 'addEventToForwardViaUI' (event needs to be preset via 'setEventToForward').
Overview
Functions
addEventToForward()
Short description
Add an event to register to and to forward the content of its first parameter (as string) to UDP socket.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
event |
STRING |
1 |
Name of event to register to. |
Sample (auto-generated)
CSK_MultiUDPSocket.addEventToForward(event)
addEventToForwardViaUI()
Short description
Add event to register to and forward content (first event parameter as string) to UDP socket via UI (event needs to be prefilled on UI / via "setEventToForward").
Sample (auto-generated)
CSK_MultiUDPSocket.addEventToForwardViaUI()
addInstance()
Short description
Function to add an additional instance.
Sample (auto-generated)
CSK_MultiUDPSocket.addInstance()
clearFlowConfigRelevantConfiguration()
Short description
Function to clear FlowConfig relevant configurations.
Sample (auto-generated)
CSK_MultiUDPSocket.clearFlowConfigRelevantConfiguration()
deleteEventToForward()
Short description
Remove event to forward content.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
event |
STRING |
1 |
Eventname |
Sample (auto-generated)
CSK_MultiUDPSocket.deleteEventToForward(event)
deleteEventToForwardViaUI()
Short description
Remove event preselected via UI.
Sample (auto-generated)
CSK_MultiUDPSocket.deleteEventToForwardViaUI()
getInstancesAmount()
Short description
Get the amount of created instances of this module
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
amount |
INT |
1 |
Amount of created instances. |
Sample (auto-generated)
amount = CSK_MultiUDPSocket.getInstancesAmount()
getParameters()
Short description
Function to get all parameters of the client in JSON format.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
instanceNo |
INT |
1 |
Number of instance to get parameters from. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
jsonParameters |
STRING |
1 |
JSON string with all parameters. |
Sample (auto-generated)
jsonParameters = CSK_MultiUDPSocket.getParameters(instanceNo)
getStatusModuleActive()
Short description
Function to get status if module is active.
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
status = CSK_MultiUDPSocket.getStatusModuleActive()
loadParameters()
Short description
Load parameters for this module from the CSK_PersistentData module if possible and use them.
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
success |
BOOL |
1 |
Success to load parameters. |
Sample (auto-generated)
success = CSK_MultiUDPSocket.loadParameters()
pageCalled()
Short description
Function to register "On Resume" of the ModuleName_Model UI ( (only helper function)
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
empty |
STRING |
1 |
Empty string |
Sample (auto-generated)
empty = CSK_MultiUDPSocket.pageCalled()
receiveViaUI()
Short description
Function to trigger receive function of current selected instance.
Sample (auto-generated)
CSK_MultiUDPSocket.receiveViaUI()
resetInstances()
Short description
Function to reset instances to one single instance. IMPORTANT: As instances start their own threads, the module needs to be restarted if new instances are needed… (see AppEngine docu for "Script.startScript")
Sample (auto-generated)
CSK_MultiUDPSocket.resetInstances()
resetModule()
Short description
Function to reset main configuration of module.
Sample (auto-generated)
CSK_MultiUDPSocket.resetModule()
selectEventToForwardViaUI()
Short description
Select an event to forward the content of its first parameter via UDP socket via UI.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
selection |
STRING |
1 |
Selected event. |
Sample (auto-generated)
CSK_MultiUDPSocket.selectEventToForwardViaUI(selection)
sendParameters()
Short description
Send parameters to CSK_PersistentData module if possible to save them.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
noDataSave |
BOOL |
? |
[Optional] Set to TRUE if the data should NOT be saved immediately after sending. |
Sample (auto-generated)
CSK_MultiUDPSocket.sendParameters(noDataSave)
setConnectionStatus()
Short description
Function to set status UDP socket bind status.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiUDPSocket.setConnectionStatus(status)
setDataToTransmit()
Short description
Function to preset data to transmit via UDP sicket.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
data |
STRING |
1 |
Data |
Sample (auto-generated)
CSK_MultiUDPSocket.setDataToTransmit(data)
setEventToForward()
Short description
Preset event to register to and forward content to UDP socket via UI.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
value |
STRING |
1 |
Event to register to. |
Sample (auto-generated)
CSK_MultiUDPSocket.setEventToForward(value)
setFlowConfigPriority()
Short description
Function to configure if FlowConfig should have priority for FlowConfig relevant configuration.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiUDPSocket.setFlowConfigPriority(status)
setInterface()
Short description
Function to set interface to use for UDP socket communicaiton.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
interface |
STRING |
1 |
Interface |
Sample (auto-generated)
CSK_MultiUDPSocket.setInterface(interface)
setIP()
Short description
Function to set IP to transmit data via UDP socket.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
ip |
STRING |
1 |
IP |
Sample (auto-generated)
CSK_MultiUDPSocket.setIP(ip)
setLoadOnReboot()
Short description
Configure if this module should load its saved parameters at app- / device- boot up
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Set status |
Sample (auto-generated)
CSK_MultiUDPSocket.setLoadOnReboot(status)
setPackFormat()
Short description
Function to set format to pack data as binary data to transmit.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
format |
STRING |
1 |
Format string for LUA string.pack function. |
Sample (auto-generated)
CSK_MultiUDPSocket.setPackFormat(format)
setParameterName()
Short description
Function to set the name of the parameters if saved/loaded via the "PersistentData" CSK-module
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
name |
STRING |
1 |
Name of the parameter |
Sample (auto-generated)
CSK_MultiUDPSocket.setParameterName(name)
setPort()
Short description
Function to set port to bind UDP socket.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
port |
INT |
1 |
Port |
Sample (auto-generated)
CSK_MultiUDPSocket.setPort(port)
setReceiveDiscardIfFull()
Short description
Function to set status what frame to drop in case the receive queue is full.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status (TRUE to drop oldest frame, FALSE to drop newest frame). |
Sample (auto-generated)
CSK_MultiUDPSocket.setReceiveDiscardIfFull(status)
setReceiveQueueSize()
Short description
Function to set size of queue for receive function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
size |
INT |
1 |
Size |
Sample (auto-generated)
CSK_MultiUDPSocket.setReceiveQueueSize(size)
setReceiveTimeout()
Short description
Function to set timeout for receive function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
time |
INT |
1 |
Time in ms. |
Sample (auto-generated)
CSK_MultiUDPSocket.setReceiveTimeout(time)
setReceiveWarnOverruns()
Short description
Function to set if warnings should be raised if receive function overruns.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiUDPSocket.setReceiveWarnOverruns(status)
setSelectedInstance()
Short description
Select one of the multiple instances
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
instance |
INT |
1 |
Instance to select |
Sample (auto-generated)
CSK_MultiUDPSocket.setSelectedInstance(instance)
transmitData()
Short description
Function to transmit data via UDP socket.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
data |
BINARY |
1 |
Data |
Sample (auto-generated)
CSK_MultiUDPSocket.transmitData(data)
transmitDataNUM()
Short description
Example of dynamically served function to transmit data on specific instance.
NUM will be replaced by the number of instance (e.g. "transmitData1").
INFO: Other modules can check via "Script.isServedAsFunction" if function of sepecific instance exists.
Needs then to be called via "Script.callFunction".
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
data |
BINARY |
1 |
Data to transmit. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
numberOfBytesTransmitted |
INT |
1 |
Number of bytes transmitted ('0' if error). |
Sample (auto-generated)
numberOfBytesTransmitted = CSK_MultiUDPSocket.transmitDataNUM(data)
transmitDataViaUI()
Short description
Function to transmit preset data in UI via UDP socket.
Sample (auto-generated)
CSK_MultiUDPSocket.transmitDataViaUI()
Events
OnDataLoadedOnReboot
Short description
Event to call if module tried to load parameters and should be ready.
Sample (auto-generated)
function handleOnDataLoadedOnReboot()
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnNewDataNUM
Short description
Example of dynamically created event to provide received data of instance.
NUM will be replaced by the number of instance (e.g. "OnNewData1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
data |
BINARY |
1 |
Data |
Sample (auto-generated)
function handleOnNewDataNUM(data)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewDataNUM", "handleOnNewDataNUM")
OnNewDataToTransmit
Short description
Notify data to send.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
data |
STRING |
1 |
Data to transmit. |
Sample (auto-generated)
function handleOnNewDataToTransmit(data)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewDataToTransmit", "handleOnNewDataToTransmit")
OnNewEventToForward
Short description
Notify event to register to and to forward its content to UDP socket.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
eventName |
STRING |
1 |
Name of event |
Sample (auto-generated)
function handleOnNewEventToForward(eventName)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewEventToForward", "handleOnNewEventToForward")
OnNewEventToForwardList
Short description
Notify list of events to register to and to forward its content to UDP socket.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
list |
STRING |
1 |
List |
Sample (auto-generated)
function handleOnNewEventToForwardList(list)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewEventToForwardList", "handleOnNewEventToForwardList")
OnNewInstanceList
Short description
Event to provide list of created instances
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
list |
STRING |
1 |
List of created instances |
Sample (auto-generated)
function handleOnNewInstanceList(list)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewInstanceList", "handleOnNewInstanceList")
OnNewInterfaceList
Short description
Notify list of available interfaces for UDP connection.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
list |
STRING |
1 |
List of interfaces. |
Sample (auto-generated)
function handleOnNewInterfaceList(list)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewInterfaceList", "handleOnNewInterfaceList")
OnNewLog
Short description
Notfiy latest log.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
log |
STRING |
1 |
Log entries. |
Sample (auto-generated)
function handleOnNewLog(log)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewLog", "handleOnNewLog")
OnNewParameterName
Short description
Notify name of persistent data parameter
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
name |
STRING |
1 |
Parameter name |
Sample (auto-generated)
function handleOnNewParameterName(name)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewParameterName", "handleOnNewParameterName")
OnNewProcessingParameter
Short description
Event to share processing parameters to the instances.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
objectNo |
INT |
1 |
Number of the instance to receive the parameter |
parameter |
STRING |
1 |
Name of the parameter |
value |
AUTO |
[?*] |
Optional value of the parameter. |
value2 |
INT |
[?*] |
Optional parameter. |
Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, value2)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewProcessingParameter", "handleOnNewProcessingParameter")
OnNewSelectedInstance
Short description
Notify if new instance is selected
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
selectedObject |
INT |
1 |
Selected instance |
Sample (auto-generated)
function handleOnNewSelectedInstance(selectedObject)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewSelectedInstance", "handleOnNewSelectedInstance")
OnNewStatusConnectionStatus
Short description
Notify if UDP socket should be connected.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusConnectionStatus(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusConnectionStatus", "handleOnNewStatusConnectionStatus")
OnNewStatusCSKStyle
Short description
Notify UI style to use for CSK modules.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
theme |
STRING |
1 |
UI style |
Sample (auto-generated)
function handleOnNewStatusCSKStyle(theme)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
OnNewStatusCurrentConnection
Short description
Notify if UDP socket is currently connected.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusCurrentConnection(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusCurrentConnection", "handleOnNewStatusCurrentConnection")
OnNewStatusDiscardIfFull
Short description
Notify status if oldest frame in receive queue should be dropped (TRUE) or newest one (FALSE) if queue is full.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusDiscardIfFull(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusDiscardIfFull", "handleOnNewStatusDiscardIfFull")
OnNewStatusFlowConfigPriority
Short description
Notify if FlowConfig should have priority for FlowConfig relevant configurations.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusFlowConfigPriority(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
OnNewStatusInterface
Short description
Notify interface to use for UDP socket.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
interface |
STRING |
1 |
Interface |
Sample (auto-generated)
function handleOnNewStatusInterface(interface)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusInterface", "handleOnNewStatusInterface")
OnNewStatusIP
Short description
Notify IP to transmit data to via UDP socket.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
ip |
STRING |
1 |
IP |
Sample (auto-generated)
function handleOnNewStatusIP(ip)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusIP", "handleOnNewStatusIP")
OnNewStatusLoadParameterOnReboot
Short description
Notify status if parameters should be loaded on app-/device- boot up
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusLoadParameterOnReboot(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
OnNewStatusModuleIsActive
Short description
Notify if module can be used on device.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusModuleIsActive(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
OnNewStatusModuleVersion
Short description
Notify version of module.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
version |
STRING |
1 |
Version |
Sample (auto-generated)
function handleOnNewStatusModuleVersion(version)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewStatusPackFormat
Short description
Notify format to pack data to send binary data.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
format |
STRING |
1 |
Format |
Sample (auto-generated)
function handleOnNewStatusPackFormat(format)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusPackFormat", "handleOnNewStatusPackFormat")
OnNewStatusPort
Short description
Notify port to bind UDP socket.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
port |
INT |
1 |
Port |
Sample (auto-generated)
function handleOnNewStatusPort(port)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusPort", "handleOnNewStatusPort")
OnNewStatusQueueSizeReceive
Short description
Notify queue size of receive function.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
size |
INT |
1 |
Size |
Sample (auto-generated)
function handleOnNewStatusQueueSizeReceive(size)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusQueueSizeReceive", "handleOnNewStatusQueueSizeReceive")
OnNewStatusReceiveTimeout
Short description
Notify timeout in ms to wait for received data. 0 means directly return.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
timeout |
INT |
1 |
Timeout in ms. |
Sample (auto-generated)
function handleOnNewStatusReceiveTimeout(timeout)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusReceiveTimeout", "handleOnNewStatusReceiveTimeout")
OnNewStatusWarnOverruns
Short description
Notify status to show warnings on overruns of receive function.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusWarnOverruns(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewStatusWarnOverruns", "handleOnNewStatusWarnOverruns")
OnNewValueToForwardNUM
Short description
Example of dynamically created event to forward data from instance thread to Controler app, e.g. to forward values to UI.
NUM will be replaced by the number of instance (e.g. "OnNewResult1")+
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
eventname |
STRING |
1 |
Eventname to use to forward value. |
value |
AUTO |
1 |
Value to forward. |
Sample (auto-generated)
function handleOnNewValueToForwardNUM(eventname, value)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
OnNewValueUpdateNUM
Short description
Example of dynamically created event to sync paramters between instance threads and Controller part of app.
NUM will be replaced by the number of instance (e.g. "OnNewResult1")
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
instance |
INT |
1 |
Instance new value is coming from. |
parameter |
STRING |
1 |
Name of the paramter to update/sync |
value |
AUTO |
1 |
Value to update |
selectedObject |
INT |
? |
Optionally if internal parameter should be used for internal objects. |
Sample (auto-generated)
function handleOnNewValueUpdateNUM(instance, parameter, value, selectedObject)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
OnPersistentDataModuleAvailable
Short description
Notify status if features of PersistendData CSK module are available
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnPersistentDataModuleAvailable(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
OnUserLevelAdminActive
Short description
Status of Admin userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
OnUserLevelMaintenanceActive
Short description
Status of Maintenance userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
OnUserLevelOperatorActive
Short description
Status of Operator userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
OnUserLevelServiceActive
Short description
Status of Service userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
-- Do something
end
Script.register("CSK_MultiUDPSocket.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
MultiUDPSocket_FC
Short description
Crown to provide CSK_FlowConfig relevant features.
Overview
MultiUDPSocket_FC.OnReceive
Short description
Provide received UDP data.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiUDPSocket_FC.OnReceive.create(Instance)
register()
Short description
Internally used CSK_FlowConfig register function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
eventname |
STRING |
1 |
Internal parameter (not used). |
callback |
STRING |
1 |
Internally used callback function. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
success |
BOOL |
1 |
Success of register process. |
Sample (auto-generated)
success = MultiUDPSocket_FC.OnReceive.register(handle, eventname, callback)
Events
OnNewData
Short description
Provide received UDP data.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
OnNewData |
STRING |
1 |
'CSK_MultiUDPSocket.OnNewData[InstanceNUM]' Parameter: 1: Data content (BINARY) |
Sample (auto-generated)
function handleOnNewData(handle, OnNewData)
-- Do something
end
Script.register("MultiUDPSocket_FC.OnReceive.OnNewData", "handleOnNewData")
MultiUDPSocket_FC.Transmit
Short description
Set source of incoming data to forward via UDP.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiUDPSocket_FC.Transmit.create(Instance)
transmit()
Short description
Set source of incoming data to forward via UDP.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
source1 |
STRING |
? |
Source1 of data to forward via websocket. Parameter: 1: Data content (BINARY) |
source2 |
STRING |
? |
Source2 of data to forward via websocket. Parameter: 1: Data content (BINARY) |
source3 |
STRING |
? |
Source3 of data to forward via websocket. Parameter: 1: Data content (BINARY) |
source4 |
STRING |
? |
Source4 of data to forward via websocket. Parameter: 1: Data content (BINARY) |
Sample (auto-generated)
MultiUDPSocket_FC.Transmit.transmit(handle, source1, source2, source3, source4)
Enumerations
MultiUDPSocket_FC.ResultType
Types of results to provide.
| Value | Name | Description |
|---|---|---|
TOTAL_SUBRESULTS |
TOTAL_SUBRESULTS |
TotalResult + optional sub results (see 'setResultOutput') concatenated as a string. |
TOTAL_RESULT |
TOTAL_RESULT |
TotalResult as boolean. |