WebSocketClient.SetInitialValue (METH) ¶ METHOD SetInitialValue : NBS.ERROR This method is used for setting the tls context to tcp client as an initial value. Note If the itfContext is zero this method uses default settings for tls. InOut: Scope Name Type Initial Return SetInitialValue NBS.ERROR Input itfContext NBS.ITLSContext itfAsyncProperty NBS.IAsyncProperty 0 itfTSNContext NBS.ITSNContext 0
WebSocketClient.Write (METH) ¶ METHOD Write : NBS.ERROR Sends messages to a WebSocket server. This method sends the payload pData with the size udiSize to the 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.
WebSocketRead (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL WebSocketRead EXTENDS CBML.LConC Function block to read incoming messages using the Common Behavior Model (e.g. for CFC applications). Note This function block OR the Write method of the WebSocketClient MUST be called in each cycle because the method also handles other requests in background (ping, pong etc.). Set xEnable to TRUE if xActive of the WebSocketClient is TRUE . InOut: Scope Name Type Comment Inherited from Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation LConC Output xBusy BOOL TRUE : Operation is running LConC xError BOOL TRUE : Error condition reached LConC Input itfWebSocketClient IWebSocketClient Reference to the WebSocketClient pData __XWORD Pointer to the payload data udiSize UDINT Maximum size of the payload Output xReady BOOL TRUE if data received udiCount UDINT Size of the received data 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.
WebSocketWrite (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL WebSocketWrite EXTENDS CBML.ETrigTo Function block to send messages to WebSocket server using the Common Behavior Model (e.g. for CFC applications). InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigTo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigTo Output xDone BOOL Ready condition reached ETrigTo xBusy BOOL Operation is running ETrigTo xError BOOL Error condition reached ETrigTo Input itfWebSocketClient IWebSocketClient Reference to the WebSocketClient 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.
Interfaces ¶ IWebSocketClient (Interface) Read (Method) Write (Method)
IWebSocketClient (ITF) ¶ INTERFACE IWebSocketClient Interface of the WebSocket client Methods: Read Write Structure: Read (Method) Write (Method)
Impl ¶ OAuth2ClientCredentials (FunctionBlock) ClientId (Property) ClientSecret (Property) Scope (Property) OAuth2RessourceOwnerCredentials (FunctionBlock) ClientId (Property) ClientSecret (Property) Password (Property) Scope (Property) Username (Property)
Interfaces ¶ IOAuth2ClientCredentials (Interface) IOAuth2Credentials (Interface) ClientId (Property) ClientSecret (Property) Scope (Property) IOAuth2RessourceOwnerCredentials (Interface) Password (Property) Username (Property)
Params ¶ Param (ParamList)
Param (PARAMS) ¶ HTTPClient parameters InOut: Scope Name Type Initial Comment Constant g_udiMaxRequestSize UDINT 20000 Maximum size of the http request in btyes g_udiMaxResponseSize UDINT 20000 Maximum size of the http response in bytes g_udiMaxHeaderSize UDINT 4000 Maximum size of the http header in bytes g_udiMaxOAuth2TokenSize UDINT 2048 Maximum size of the OAuth2 access and refresh token