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
Structs ¶ HttpResult (Struct) URL (Struct)
HttpResult (STRUCT) ¶ TYPE HttpResult : STRUCT The result of a http request InOut: Name Type Comment iStatus INT http status wsHeader WSTRING(g_udiMaxHeaderSize) http header as WSTRING wsContent WSTRING(g_udiMaxResponseSize) The result of the request as WSTRING sHeader STRING(g_udiMaxHeaderSize) http header as STRING sContent STRING(g_udiMaxResponseSize) The result of the request as STRING diContentLength DINT Count of bytes in sContent
URL (STRUCT) ¶ TYPE URL : STRUCT URL structure InOut: Name Type Comment sProtocol STRING(5) Protocol e.g. http, NOTE: ONLY HTTP IS SUPPORTED! sDomain STRING(255) The domain e.g. ‘twitter.api.com’ uiPort UINT Port of the server sPath STRING(1024) The path e.g. ‘/1.1/statuses/update.json’