Document metadata
Application name |
CSK_Module_MultiHTTPClient |
---|---|
Version |
2.2.0 |
Date |
2025-05-28 |
Author |
SICK AG |
Crowns
- C
- M
CSK_Module_MultiHTTPClient
Short description
This is an automatically generated CROWN (description not necessary).
Overview
CSK_MultiHTTPClient
Short description
HTTP Client module with ability to create multiple instances running in parallel. Each instance can have multiple requests assigned to it.
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 HTTP client configuration
- Select the client via 'setSelectedInstance'.
- Setup the HTTP client relevant configs like the ethernet interface to use and optional parameters for client authentication, proxy settings, hostname/peer verification etc. Check the related 'set…' functions.
- Activate the client via 'setClientActivated'.
2) Send HTTP requests
- Configure a HTTP request by setting the mode/endpoint/port (see 'set…' functions) and optionally add header keys or request content (payload/body).
- To add a header key, first set the key name via 'setRequestHeaderKey', set a value for this header key via 'setRequestHeaderValue' and add this via 'addHeader' (it is possible to add multiple header keys)
- To add a payload to the request, set the content type via 'setRequestContentType' and set the payload via 'setRequestContent'.
- Now you can send the preconfigured request via 'sendRequestViaUI'.
3) Save requests
It is possible to prepare and save multiple requests per instance. There are some addtional options:
- Give a name for the request via 'setRequestName'.
- If you want to send the request periodically you can activate this via 'setRequestPeriodicState' and setting the cycle time via 'setRequestPeriod'.
- If you want to send the request via event trigger, you can register to an event by set it via 'setRequestRegisteredEvent'.
- Add this request via 'addRequest'.
- INFO: If the used event provides some 'string' content this can be forwarded as payload of the request.
- INFO: The triggered calls for prepared requests will be checked by internal queues. The maximum size of this queues can be set for each client instance via 'setMaxQueueSize'.
- It is possible to edit requests by selecting them with their name via 'setSelectedRequest', change the request parameter via its 'setRequest…'-functions and update it via 'updateRequest'.
- INFO: The request name can NOT be updated. Please delete the request and add a new one to do so.
4) Receive response
The module will dynamically create events to provide the incoming response of the executed requests. Please check the 'OnNewResponseNUM' / 'OnNewResponseNUM_NAME'-event documentation.
Overview
Functions
addEditRequestViaUI()
Short description
Function to add new or edit existing request (if successfully selected via 'setSelectedRequest') via UI by using preconfigured request parameters (see 'setRequest…'-functions).
Sample (auto-generated)
CSK_MultiHTTPClient.addEditRequestViaUI()
addHeader()
Short description
Function to add preconfigured header (see 'setHeaderKey' and 'setHeadervalue').
Sample (auto-generated)
CSK_MultiHTTPClient.addHeader()
addInstance()
Short description
Function to add an additional instance.
Sample (auto-generated)
CSK_MultiHTTPClient.addInstance()
addRequest()
Short description
Function to add new request based on preconfigured parameters.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Name of request. |
mode |
1 |
Mode of request. |
|
endpoint |
STRING |
1 |
Endpoint of request. |
port |
INT |
1 |
Port of request. |
event |
STRING |
1 |
Name of event to get data to send via HTTP request. If not used, fill with ''. |
periodic |
BOOL |
1 |
Status of request is periodic. |
period |
INT |
? |
Optional time of request period in ms. |
protocol |
? |
Optional protocol of request. |
Sample (auto-generated)
CSK_MultiHTTPClient.addRequest(name, mode, endpoint, port, event, periodic, period, protocol)
clearFlowConfigRelevantConfiguration()
Short description
Function to clear FlowConfig relevant configurations.
Sample (auto-generated)
CSK_MultiHTTPClient.clearFlowConfigRelevantConfiguration()
deleteHeader()
Short description
Function to delete preselected header key (see 'selectRequestHeaderKey').
Sample (auto-generated)
CSK_MultiHTTPClient.deleteHeader()
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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.loadParameters()
pageCalled()
Short description
Function to register "OnResume" of the module UI (only as helper function).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
empty |
STRING |
1 |
Empty string (only needed to simplify binding). |
Sample (auto-generated)
empty = CSK_MultiHTTPClient.pageCalled()
removeRequest()
Short description
Function to remove preselected request (see 'setSelectedRequest').
Sample (auto-generated)
CSK_MultiHTTPClient.removeRequest()
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_MultiHTTPClient.resetInstances()
resetModule()
Short description
Function to reset main configuration of module.
Sample (auto-generated)
CSK_MultiHTTPClient.resetModule()
selectRequestHeaderKey()
Short description
Function to select header key to edit.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
selection |
STRING |
1 |
Selection |
Sample (auto-generated)
CSK_MultiHTTPClient.selectRequestHeaderKey(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_MultiHTTPClient.sendParameters(noDataSave)
sendRequestNUM()
Short description
Example of dynamically served function to send a request of a specific instance.
NUM will be replaced by the number of instance (e.g. "sendRequest1").
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 |
---|---|---|---|
mode |
1 |
Mode of request. |
|
endpoint |
STRING |
1 |
Endpoint |
port |
INT |
1 |
Port |
header |
STRING |
? |
Optional list of headers (JSON). |
body |
STRING |
? |
Body content (JSON). |
contentType |
STRING |
? |
Type of content. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
response |
STRING |
1 |
Response (JSON) |
Sample (auto-generated)
response = CSK_MultiHTTPClient.sendRequestNUM(mode, endpoint, port, header, body, contentType)
sendRequestViaUI()
Short description
Function to trigger preconfigured request via UI.
Sample (auto-generated)
CSK_MultiHTTPClient.sendRequestViaUI()
setBasicAuthentication()
Short description
Function to set status to use HTTP basic authentication.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiHTTPClient.setBasicAuthentication(status)
setBasicAuthenticationPassword()
Short description
Function to set password for user of HTTP basic authentication.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
password |
STRING |
1 |
Password |
Sample (auto-generated)
CSK_MultiHTTPClient.setBasicAuthenticationPassword(password)
setBasicAuthenticationUser()
Short description
Function to set user for HTTP basic authentication.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
user |
STRING |
1 |
User |
Sample (auto-generated)
CSK_MultiHTTPClient.setBasicAuthenticationUser(user)
setCABundleFile()
Short description
Function called when uploading CA bundle file for client authentication was finished.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Status if file upload was successful. |
Sample (auto-generated)
CSK_MultiHTTPClient.setCABundleFile(success)
setClientActivated()
Short description
Function to activate the HTTP client.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True to activate. |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientActivated(state)
setClientAuthentication()
Short description
Function to enable client authentication.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True to enable. |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientAuthentication(state)
setClientCertificateFile()
Short description
Function called when uploading client certification file was finished.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientCertificateFile(success)
setClientCertificateKeyFile()
Short description
Function called when uploading client certification key file was finished.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientCertificateKeyFile(success)
setClientCertificateKeyPassphrase()
Short description
Function to set optional passphrase for client certification key.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
passphrase |
STRING |
1 |
Passphrase |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientCertificateKeyPassphrase(passphrase)
setClientCertificateKeyType()
Short description
Function to set type of client certification key.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
keyType |
STRING |
1 |
Type |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientCertificateKeyType(keyType)
setClientCertificateType()
Short description
Function to set type of client cetification.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
certType |
STRING |
1 |
Type |
Sample (auto-generated)
CSK_MultiHTTPClient.setClientCertificateType(certType)
setCookieStore()
Short description
Function to set filename for cookie storage.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
filename |
STRING |
1 |
Filename (like cookieStore.txt, will be placed at public/CSK_HTTPClient/). |
Sample (auto-generated)
CSK_MultiHTTPClient.setCookieStore(filename)
setExtendedResponse()
Short description
Function to set if response should include extended information (e.g. header infos).
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiHTTPClient.setExtendedResponse(status)
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_MultiHTTPClient.setFlowConfigPriority(status)
setHostnameVerification()
Short description
Function to enable hostname verification.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True to enable. |
Sample (auto-generated)
CSK_MultiHTTPClient.setHostnameVerification(state)
setInterface()
Short description
Function to set the ethernet interface for the HTTP client.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
interface |
STRING |
1 |
Ethernet enterface, e.g. 'ETH1'. |
Sample (auto-generated)
CSK_MultiHTTPClient.setInterface(interface)
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_MultiHTTPClient.setLoadOnReboot(status)
setMaxQueueSize()
Short description
Function to set maximum size of request queue to skip new requests.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
size |
INT |
1 |
Maximum size of queue (default is 5). |
Sample (auto-generated)
CSK_MultiHTTPClient.setMaxQueueSize(size)
setParameterName()
Short description
Function to set the name of the parameters if saved/loaded via the CSK_PersistentData module.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Name of the parameter |
Sample (auto-generated)
CSK_MultiHTTPClient.setParameterName(name)
setPeerVerification()
Short description
Function to enable peer verification.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True to enable. |
Sample (auto-generated)
CSK_MultiHTTPClient.setPeerVerification(state)
setProxyEnabledStatus()
Short description
Function to enable or disable proxy.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True to enable. |
Sample (auto-generated)
CSK_MultiHTTPClient.setProxyEnabledStatus(state)
setProxyPassword()
Short description
Function to set proxy password.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
proxyPassword |
STRING |
1 |
Password string. |
Sample (auto-generated)
CSK_MultiHTTPClient.setProxyPassword(proxyPassword)
setProxyPort()
Short description
Function to set proxy port.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
proxyPort |
INT |
1 |
Proxy port number. |
Sample (auto-generated)
CSK_MultiHTTPClient.setProxyPort(proxyPort)
setProxyURL()
Short description
Function to set proxy URL.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
proxyURL |
STRING |
1 |
Proxy URL. |
Sample (auto-generated)
CSK_MultiHTTPClient.setProxyURL(proxyURL)
setProxyUsername()
Short description
Function to set proxy username.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
proxyUsername |
STRING |
1 |
Proxy username. |
Sample (auto-generated)
CSK_MultiHTTPClient.setProxyUsername(proxyUsername)
setRequestContent()
Short description
Function to set body payload e.g. for POST or PUT requests.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
content |
STRING |
1 |
Content string. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestContent(content)
setRequestContentType()
Short description
Function to set type of payload content (see 'setRequestContent').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
contentType |
STRING |
1 |
Content mime-type specifier as described in RFC 2045/2046 (like 'application/json'). |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestContentType(contentType)
setRequestEndpoint()
Short description
Function to set endpoint of currently selected request.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
endpoint |
STRING |
1 |
Endpoint URL. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestEndpoint(endpoint)
setRequestHeaderKey()
Short description
Function to preconfigure header key name (see 'addHeader').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
key |
STRING |
1 |
Key name. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestHeaderKey(key)
setRequestHeaderValue()
Short description
Function to preconfigure header-key value (see 'addHeader').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
value |
STRING |
1 |
Value |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestHeaderValue(value)
setRequestMode()
Short description
Function to set request mode.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
mode |
STRING |
1 |
Mode e.g. 'POST', 'GET', 'PUT', 'DELETE', … |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestMode(mode)
setRequestName()
Short description
Function to set identification name of request.
(Will be used to create a new request via 'addRequest'.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Request name. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestName(name)
setRequestPeriod()
Short description
Function to set cycle time of the request if it is periodic (see 'setRequestPeriodicState').
(Will be set to currently selected request via 'addRequest' or 'updateRequest').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
period |
INT |
1 |
Cycle time in [ms]. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestPeriod(period)
setRequestPeriodicState()
Short description
Function to set if request should be triggered periodically (see 'setRequestPeriod').
(Will be set to currently selected request via 'addRequest' or 'updateRequest').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
'TRUE' to trigger periodically. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestPeriodicState(state)
setRequestPort()
Short description
Function to set port of request.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
port |
INT |
1 |
Port number. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestPort(port)
setRequestRegisteredEvent()
Short description
Preconfigure event that this module should listen to. If this one is notified, it will be linked to internal processing function.
(Will be set to currently selected request via 'addRequest' or 'updateRequest').
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
event |
STRING |
1 |
(external) Event name to listen to. |
Sample (auto-generated)
CSK_MultiHTTPClient.setRequestRegisteredEvent(event)
setSelectedInstance()
Short description
Select one of the multiple instances.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
instance |
INT |
1 |
Instance to select. |
Sample (auto-generated)
CSK_MultiHTTPClient.setSelectedInstance(instance)
setSelectedRequest()
Short description
Function to select request by name.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
requestName |
STRING |
1 |
Name of request. |
Sample (auto-generated)
CSK_MultiHTTPClient.setSelectedRequest(requestName)
setSelectedRequestViaUI()
Short description
Function to select request via UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonRowData |
STRING |
1 |
Raw JSON data from dynamic table containing requests. |
Sample (auto-generated)
CSK_MultiHTTPClient.setSelectedRequestViaUI(jsonRowData)
setVerboseMode()
Short description
Function to set if HTTP client should run in verbose mode.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_MultiHTTPClient.setVerboseMode(status)
updateRequest()
Short description
Function to update request with preconfigured parameters (see 'setRequest…'-functions).
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
requestID |
STRING |
1 |
Name of request to edit. |
Sample (auto-generated)
CSK_MultiHTTPClient.updateRequest(requestID)
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_MultiHTTPClient.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnNewClientCertificateKeyType
Short description
Notify type of client certificate key.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
type |
STRING |
1 |
Key type (PEM, DER) |
Sample (auto-generated)
function handleOnNewClientCertificateKeyType(type)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewClientCertificateKeyType", "handleOnNewClientCertificateKeyType")
OnNewClientCertificateType
Short description
Notify type of client certificate.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
type |
STRING |
1 |
Certificate type (PEM, DER, PKCS12). |
Sample (auto-generated)
function handleOnNewClientCertificateType(type)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewClientCertificateType", "handleOnNewClientCertificateType")
OnNewCookieStore
Short description
Notify filename to use for cookie store.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
filename |
STRING |
1 |
Name of file to store clients cookies. |
Sample (auto-generated)
function handleOnNewCookieStore(filename)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewCookieStore", "handleOnNewCookieStore")
OnNewHeaderKey
Short description
Notify currently selected header key.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
key |
STRING |
1 |
Header key. |
Sample (auto-generated)
function handleOnNewHeaderKey(key)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewHeaderKey", "handleOnNewHeaderKey")
OnNewHeaderList
Short description
Notify current list of headers.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
list |
STRING |
1 |
List of header keys. |
Sample (auto-generated)
function handleOnNewHeaderList(list)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewHeaderList", "handleOnNewHeaderList")
OnNewHeaderValue
Short description
Notify value of currently selected header key.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
value |
STRING |
1 |
Value |
Sample (auto-generated)
function handleOnNewHeaderValue(value)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewHeaderValue", "handleOnNewHeaderValue")
OnNewHostnameVerification
Short description
Event to notfiy status if hostname verification is enabled.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if enabled. |
Sample (auto-generated)
function handleOnNewHostnameVerification(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewHostnameVerification", "handleOnNewHostnameVerification")
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_MultiHTTPClient.OnNewInstanceList", "handleOnNewInstanceList")
OnNewInterface
Short description
Event to notfiy the selected ethernet interface of current client.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
Interface |
STRING |
1 |
Selected interface. |
Sample (auto-generated)
function handleOnNewInterface(Interface)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewInterface", "handleOnNewInterface")
OnNewInterfaceDropdown
Short description
Event to notfiy the list of available interfaces in dropdown.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
InterfaceDropdownContent |
STRING |
1 |
List of available interfaces in JSON format. |
Sample (auto-generated)
function handleOnNewInterfaceDropdown(InterfaceDropdownContent)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewInterfaceDropdown", "handleOnNewInterfaceDropdown")
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_MultiHTTPClient.OnNewParameterName", "handleOnNewParameterName")
OnNewPeerVerification
Short description
Event to notfiy status if hostname verification is enabled.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if enabled. |
Sample (auto-generated)
function handleOnNewPeerVerification(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewPeerVerification", "handleOnNewPeerVerification")
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 |
? |
Value of the parameter. |
value2 |
AUTO |
? |
Value2 of the parameter. |
Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, value2)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProcessingParameter", "handleOnNewProcessingParameter")
OnNewProxyEnableStatus
Short description
Event to notfiy status if proxy is enabled.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if enabled. |
Sample (auto-generated)
function handleOnNewProxyEnableStatus(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProxyEnableStatus", "handleOnNewProxyEnableStatus")
OnNewProxyPassword
Short description
Event to notfiy the proxy password.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProxyPassword |
STRING |
1 |
Password string. |
Sample (auto-generated)
function handleOnNewProxyPassword(ProxyPassword)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProxyPassword", "handleOnNewProxyPassword")
OnNewProxyPort
Short description
Event to notfiy proxy port.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProxyPort |
INT |
1 |
Port number. |
Sample (auto-generated)
function handleOnNewProxyPort(ProxyPort)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProxyPort", "handleOnNewProxyPort")
OnNewProxyURL
Short description
Event to notfiy the proxy URL.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProxyURL |
STRING |
1 |
Proxy URL. |
Sample (auto-generated)
function handleOnNewProxyURL(ProxyURL)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProxyURL", "handleOnNewProxyURL")
OnNewProxyUsername
Short description
Event to notfiy the proxy username.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProxyUsername |
STRING |
1 |
Proxy username. |
Sample (auto-generated)
function handleOnNewProxyUsername(ProxyUsername)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewProxyUsername", "handleOnNewProxyUsername")
OnNewQueueSize
Short description
Notify maximum size of queues for requests.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
size |
INT |
1 |
Maximum size of queues to stop the trigger of new requests. |
Sample (auto-generated)
function handleOnNewQueueSize(size)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewQueueSize", "handleOnNewQueueSize")
OnNewRequestContent
Short description
Event to notfiy request payload.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
requestContent |
STRING |
? |
Request payload. |
Sample (auto-generated)
function handleOnNewRequestContent(requestContent)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestContent", "handleOnNewRequestContent")
OnNewRequestContentType
Short description
Notify content type of request payload.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
type |
STRING |
1 |
Content type. |
Sample (auto-generated)
function handleOnNewRequestContentType(type)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestContentType", "handleOnNewRequestContentType")
OnNewRequestEndpoint
Short description
Event to notfiy the endpoint of chosen request.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
Endpoint |
STRING |
? |
The endpoint URL. |
Sample (auto-generated)
function handleOnNewRequestEndpoint(Endpoint)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestEndpoint", "handleOnNewRequestEndpoint")
OnNewRequestMode
Short description
Event to notfiy the mode of the request.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
RequestMode |
STRING |
1 |
Mode e.g. 'GET', 'POST', 'PUT', 'DELETE', … |
Sample (auto-generated)
function handleOnNewRequestMode(RequestMode)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestMode", "handleOnNewRequestMode")
OnNewRequestName
Short description
Event to notfiy the name identifier of the selected request.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
RequestName |
STRING |
1 |
Name of the request. |
Sample (auto-generated)
function handleOnNewRequestName(RequestName)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestName", "handleOnNewRequestName")
OnNewRequestPeriod
Short description
Event to notfiy the period of the request if it is periodic.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
RequestPeriod |
INT |
1 |
Period in [ms]. |
Sample (auto-generated)
function handleOnNewRequestPeriod(RequestPeriod)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestPeriod", "handleOnNewRequestPeriod")
OnNewRequestPeriodicStatus
Short description
Event to notfiy the status if the selected request is periodic.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if periodic. |
Sample (auto-generated)
function handleOnNewRequestPeriodicStatus(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestPeriodicStatus", "handleOnNewRequestPeriodicStatus")
OnNewRequestPort
Short description
Event to notfiy the port of current request.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
Port |
INT |
1 |
Port number. |
Sample (auto-generated)
function handleOnNewRequestPort(Port)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestPort", "handleOnNewRequestPort")
OnNewRequestsTable
Short description
Event to notfiy the dynamic table content containing all added requests of selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
TableContent |
STRING |
? |
Content of the table in JSON format. |
Sample (auto-generated)
function handleOnNewRequestsTable(TableContent)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewRequestsTable", "handleOnNewRequestsTable")
OnNewResponseMessage
Short description
Event to notfiy response messages to UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ResponseMessage |
STRING |
? |
Message. |
Sample (auto-generated)
function handleOnNewResponseMessage(ResponseMessage)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewResponseMessage", "handleOnNewResponseMessage")
OnNewResponseNUM
Short description
Example of dynamically created event to notify response messages received by specific HTTP client instance.
NUM will be replaced by the number of instance and NAME by the request name (e.g. "OnNewResponse1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
response |
STRING |
1 |
Response of HTTP client request. |
Sample (auto-generated)
function handleOnNewResponseNUM(response)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewResponseNUM", "handleOnNewResponseNUM")
OnNewResponseNUM_NAME
Short description
Example of dynamically created event to provide response of specific request of instance.
NUM will be replaced by the number of instance and NAME by the request name (e.g. "OnNewResponse1_getDateTime").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
reponse |
STRING |
1 |
Response of HTTP client request. |
Sample (auto-generated)
function handleOnNewResponseNUM_NAME(reponse)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewResponseNUM_NAME", "handleOnNewResponseNUM_NAME")
OnNewSelectedHeader
Short description
Event to notfiy the selected header key.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
headerKey |
STRING |
1 |
Selected header key. |
Sample (auto-generated)
function handleOnNewSelectedHeader(headerKey)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewSelectedHeader", "handleOnNewSelectedHeader")
OnNewSelectedInstance
Short description
Event to notfiy the currently selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedObject |
INT |
1 |
Selected instance. |
Sample (auto-generated)
function handleOnNewSelectedInstance(selectedObject)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewSelectedInstance", "handleOnNewSelectedInstance")
OnNewStatusBasicAuthentication
Short description
Notify status if HTTP basic authentication should be used.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusBasicAuthentication(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusBasicAuthentication", "handleOnNewStatusBasicAuthentication")
OnNewStatusBasicAuthenticationUser
Short description
Notify user for basic authentication.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
user |
STRING |
1 |
Username |
Sample (auto-generated)
function handleOnNewStatusBasicAuthenticationUser(user)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusBasicAuthenticationUser", "handleOnNewStatusBasicAuthenticationUser")
OnNewStatusClientActivated
Short description
Event to notfiy the status if client is activated.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if active. |
Sample (auto-generated)
function handleOnNewStatusClientActivated(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusClientActivated", "handleOnNewStatusClientActivated")
OnNewStatusClientAuthentication
Short description
Event to notfiy the status if client authentication is enabled.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
TRUE if enabled. |
Sample (auto-generated)
function handleOnNewStatusClientAuthentication(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusClientAuthentication", "handleOnNewStatusClientAuthentication")
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_MultiHTTPClient.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
OnNewStatusExtendedResponse
Short description
Event to notfiy the status if extended response is active.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusExtendedResponse(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusExtendedResponse", "handleOnNewStatusExtendedResponse")
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_MultiHTTPClient.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewStatusRegisteredEvent
Short description
Notify name of event the request is registered to receive trigger and optionally data to forward as payload.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
eventname |
STRING |
1 |
Name of event. |
Sample (auto-generated)
function handleOnNewStatusRegisteredEvent(eventname)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusRegisteredEvent", "handleOnNewStatusRegisteredEvent")
OnNewStatusRequestContentDisabled
Short description
Event to notfiy if the selected request mode supports to send a request content.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusRequestContentDisabled(state)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewStatusRequestContentDisabled", "handleOnNewStatusRequestContentDisabled")
OnNewValueToForwardNUM
Short description
Example of dynamically created event to forward data from instance thread to Controller part of module, e.g. to forward values to UI.
NUM will be replaced by the number of instance (e.g. "OnNewValueToForward1").
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_MultiHTTPClient.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
OnNewValueUpdateNUM
Short description
Example of dynamically created event to sync paramters between instance threads and Controller part of module.
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_MultiHTTPClient.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
OnNewVerboseMode
Short description
Notify if verbose mode of HTTP client is active.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewVerboseMode(status)
-- Do something
end
Script.register("CSK_MultiHTTPClient.OnNewVerboseMode", "handleOnNewVerboseMode")
OnPersistentDataModuleAvailable
Short description
Notify status if features of CSK_PersistentData 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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.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_MultiHTTPClient.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
MultiHTTPClient_FC
Short description
Crown to provide CSK_FlowConfig relevant features.
Overview
MultiHTTPClient_FC.SendRequest
Short description
Forward data via HTTP request.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
Instance |
INT |
1 |
Numeric identifier of processing instance. |
RequestName |
STRING |
1 |
Name of request. |
Mode |
1 |
Mode of request. |
|
Protocol |
1 |
Protocol of request. |
|
Endpoint |
STRING |
1 |
Endpoint for request WITHOUT leading 'http://' |
Port |
INT |
1 |
Port for request. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = MultiHTTPClient_FC.SendRequest.create(Instance, RequestName, Mode, Protocol, Endpoint, Port)
sendRequest()
Short description
Set source of incoming data to forward via HTTP request.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
source |
STRING |
1 |
Source of data to forward via HTTP request. Parameter: 1: Data (STRING) |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
OnNewResponse |
STRING |
1 |
'CSK_MultiHTTPClient.OnNewResponse[NUM]_[NAME]' Parameter: 1: Response (STRING) |
Sample (auto-generated)
OnNewResponse = MultiHTTPClient_FC.SendRequest.sendRequest(handle, source)
Enumerations
CSK_MultiHTTPClient.Protocol
Protocol to use for requests.
Value | Name | Description |
---|---|---|
HTTP |
HTTP |
HTTP |
HTTPS |
HTTPS |
HTTPS |
CSK_MultiHTTPClient.RequestMode
Mode of HTTP request.
Value | Name | Description |
---|---|---|
GET |
GET |
|
POST |
POST |
|
HEAD |
HEAD |
|
PUT |
PUT |
|
PATCH |
PATCH |
|
DELETE |
DELETE |
|
TRACE |
TRACE |
|
OPTIONS |
OPTIONS |