BASE64_DECODE (FUN) ¶ FUNCTION BASE64_DECODE Base 64 decoder InOut: Scope Name Type Comment Input diSizeIn DINT Size of ‘in’ in POINTER TO BYTE Input: Pointer to STRING out POINTER TO BYTE Output: Pointer to BYTE array Output diSizeOut DINT
BASE64_ENCODE (FUN) ¶ FUNCTION BASE64_ENCODE Base 64 encoder InOut: Scope Name Type Comment Input diSizeIn DINT Size of ‘in’ in POINTER TO BYTE Input: Pointer to BYTE array out POINTER TO BYTE Output: Pointer to STRING Output diSizeOut DINT
FindJSONValue (FUN) ¶ FUNCTION FindJSONValue : DINT Finds the corresponding value of a key in a JSON String. Objects and arrays are NOT supported. InOut: Scope Name Type Comment Return FindJSONValue DINT Input pwsIn POINTER TO WORD Pointer to JSON wstring udiSizeIn UDINT Size of pwsIn pwsKey POINTER TO WORD Pointer to key wstring diSearchStartPos DINT Startposition of the search Inout wsValue WSTRING(255) Value
FindJSONValue2 (FUN) ¶ FUNCTION FindJSONValue2 : DINT Finds the corresponding value of a key in a JSON String. Objects and arrays are NOT supported. InOut: Scope Name Type Comment Return FindJSONValue2 DINT Input pwsIn POINTER TO WORD Pointer to JSON wstring udiSizeIn UDINT Size of pwsIn pwsKey POINTER TO WORD Pointer to key wstring diSearchStartPos DINT Startposition of the search pwsValue POINTER TO WSTRING Pointer to the result value udiValueSize UDINT Size of pwsValue Output eError ERROR
ConvertUTF16toUTF8 (FUN) ¶ FUNCTION ConvertUTF16toUTF8 : UDINT Converts a WSTRING to STRING InOut: Scope Name Type Initial Comment Return ConvertUTF16toUTF8 UDINT Input sourceStart POINTER TO WORD Pointer to WSTRING targetStart POINTER TO BYTE Pointer to STRING dwTargetBufferSize DWORD Size of STRING bStrictConversion BOOL udiSourceLength UDINT 0 Size of Source string
IWebSocketClient.Read (METH) ¶ METHOD Read : NBS.ERROR Read incoming messages. InOut: Scope Name Type Comment Return Read NBS.ERROR Input pData __XWORD Pointer to the payload data udiSize UDINT Maximum size of the payload Output udiCount UDINT Size of the received data xReceived BOOL TRUE if data received eFrameType FRAME_TYPE Type of the payload xIsFinalFragment BOOL FALSE if the payload is incomplete and is sent via multiple packets. TRUE, if the payload is complete or if the payload was incomplete and this packet is the last packet of a message.
IWebSocketClient.Write (METH) ¶ METHOD Write : NBS.ERROR Send messages to a WebSocket server. InOut: Scope Name Type Initial Comment Return Write NBS.ERROR Input pData __XWORD Pointer to the payload data udiSize UDINT Size of the payload eFrameType FRAME_TYPE FRAME_TYPE.BINARY Type of the payload data Output udiCount UDINT Number of sent bytes. Note It can take more than one cycles to send a message if the payload is greater than the maximum buffer size.
Structs ¶ HttpProxySettings (Struct)
HttpProxySettings (STRUCT) ¶ TYPE HttpProxySettings : STRUCT Http proxy settings InOut: Name Type Comment sProxyServer STRING(255) Hostname or IP address of the proxy server. Leave blank if no proxy server is used. uiProxyPort UINT Port of the proxy server sProxyUser STRING Name of the proxy user. Leave blank if no authentication is required. sProxyPassword STRING Password of the proxy user.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 06.05.2024, 08:29:46 companyName string 3S-Smart Software Solutions GmbH libraryFile Web Socket Client SL.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Web Socket Client SL.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True IsEndUserLibrary True OnlineHelp True Released True SourceLibrary False LastModificationDateTime date 06.05.2024, 08:29:44 LibraryCategories library-category-list Application|Utils Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace WEB_SOCKET Description See: Description DocFormat reStructuredText DocLanguages de,en LanguageModelAttribute qualified-access-only Placeholder Web_Socket_Client_SL Project Web Socket Client SL Title Web Socket Client SL Version version 1.10.0.0