Initialization ¶ StructClientInitialize (Struct) StructClientUseAsTCP (Struct) StructServerInitialize (Struct) StructServerUseAsTCP (Struct)
StructClientInitialize (STRUCT) ¶ TYPE StructClientInitialize : STRUCT Structure used to set the initial values of client InOut: Name Type Comment sAppName STRING(80) Application name iCmdRep INT How many time a command has to be repeated in case of error tRcvTimeout TIME Receiving data timeout tTrsTimeout TIME Transmission data timeout tHeartBeat TIME Heartbeat time, 0 = not used VisuClientTypeToHandle Visu_ClientType Client types to handle (add/remove). It can be used in OR uiWebVisuCmdTimeout UINT This timeout (ms) is sent to the webvisu JavaScript. It’s used there to check the timeout during a command sending to webserver
StructClientUseAsTCP (STRUCT) ¶ TYPE StructClientUseAsTCP : STRUCT Structure used to set the initial values of TCP client InOut: Name Type Comment sIPAddress STRING Ip address of the peer to send message uiPort UINT TCP port to use sIPAddressSO STRING Address of the peer device used to connect web client (switchover) uiPortSO UINT tConActiveTimeout TIME Connection active timeout xUseTLS BOOL If TLS has to be use xUseCert BOOL If certificate has to be used sCertThumb STRING Local certificate thumbprint sCertThumbPeer STRING Peer certificate thumbprint
StructCmdHandleCertificate (STRUCT) ¶ TYPE StructCmdHandleCertificate : STRUCT Struct that contains the answer of Certificate handling commands InOut: Name Type Comment udiError UDINT Error bThumb ARRAY [0..(GVL_CONSTANT.THUMB_SIZE - 1)] OF BYTE Certificate thumbprint rtsCryptoID CmpX509Cert.CmpX509Cert_Implementation.RtsCryptoID The hashing algorithmen used to generate the thumbprint.
StructCmdHandleClientAns (STRUCT) ¶ TYPE StructCmdHandleClientAns : STRUCT Struct that contains the answer of Client handling commands InOut: Name Type Comment iCnt INT Number of valid structures below asID ARRAY [1..GVL_CONSTANT.MAX_CLIENT_HANDLING] OF StructCmdHandleClientAnsSub bUtIndex BYTE Used for unit test only
StructCmdHandleClientAns2 (STRUCT) ¶ TYPE StructCmdHandleClientAns2 : STRUCT Struct that contains the answer of Client handling commands InOut: Name Type Comment iCnt INT Number of valid structures below asID ARRAY [1..GVL_CONSTANT.MAX_CLIENT_HANDLING] OF StructCmdHandleClientAnsSub2 bUtIndex BYTE Used for unit test only
StructCmdHandleClientAnsSub (STRUCT) ¶ TYPE StructCmdHandleClientAnsSub : STRUCT Struct that contains the single error for each client handled InOut: Name Type Comment iError INT Eventually error dwExternIdCL DWORD External ID created on client side, the original one dwExternIdSV DWORD External ID created on server side, the duplicated one sTicket TicketType Ticket to link to the ID just created
StructCmdHandleClientAnsSub2 (STRUCT) ¶ TYPE StructCmdHandleClientAnsSub2 : STRUCT Struct that contains the single data for each client handled InOut: Name Type Comment iError INT Eventually error dwExternIdSV DWORD External ID created on server side xRegistered BOOL If the client has been registered
StructCmdNewClient (STRUCT) ¶ TYPE StructCmdNewClient : STRUCT Structure that contains the data to send in case of new client InOut: Name Type Comment ClientType Visu_ClientType Client type dwExternIdCL DWORD External ID created on client side, the original one dwCreationFlags DWORD Creation flags iNumTag INT Number of following tag. The “following tags” will be added during the creation list
StructCmdNewFrame (STRUCT) ¶ TYPE StructCmdNewFrame : STRUCT Structure that contains the data to send in case of new frame InOut: Name Type Comment ClientType Visu_ClientType Client type dwExternId DWORD External ID iFrame INT Frame index iSelected INT Page selected into frame sPageFr STRING Page name, where the frame belongs to sPageDisp STRING Page name actually displayed