Function Blocks ¶ CLClient (FunctionBlock) IRPCCLClient Abort (Method) Cancel (Method) CommStatus (Property) EndSession (Method) FaultStatus (Property) Init (Method) Invoke (Method) RequestState (Property) Session (Property) StartSession (Method) State (Property) Properties InterfaceIP (Property) SetSourcePortRange (Method) CLServer (FunctionBlock) Abort (Method) GetResolutionByActivityID (Method) Init (Method) Properties InterfaceIP (Property) ResponseState (Property) State (Property) RegisterIRPCProvider (Method) SetSourcePortRange (Method) UnregisterIRPCProvider (Method) Utils UUIDGenerator (FunctionBlock) CreateUUID (Method)

CLClient (FB) ¶ FUNCTION_BLOCK CLClient IMPLEMENTS IRPCCLClient The CLClient calls RPCs offered by a server. How to use the CLClient: CLClient instances need to be called cyclically. Call Init() Call StartSession() Check CommState, FaultStatus and State for indication of an Error: Call Abort() and continue with step 2 As soon as State has moved to WORKING, Invoke() can be called. 4.1 As long as the InvokeCallback was not called the RPC may be canceled with Cancel(). 4.2 If a Cancel() was performed, the client will do a CancelCallback() after the server has acknowledged the cancel. After the client has received the response from the server InvokeCallback() is called. Continue with step 3 FINALLY: Call EndSession() Properties: CommStatus FaultStatus InterfaceIP RequestState Session State Methods: SetSourcePortRange Abort Cancel EndSession Init Invoke StartSession Structure: IRPCCLClient Abort (Method) Cancel (Method) CommStatus (Property) EndSession (Method) FaultStatus (Property) Init (Method) Invoke (Method) RequestState (Property) Session (Property) StartSession (Method) State (Property) Properties InterfaceIP (Property) SetSourcePortRange (Method)

RPC ¶ Enums CommStatus (Enum) ERROR (Enum) FaultStatus (Enum) NCAPDUFaultStatus (Enum) RPCNCARejectStatus (Enum) State Machines CLClientState (Enum) CLRequestState (Enum) SysTargetOperationNumber (Enum) Function Blocks CLClient (FunctionBlock) IRPCCLClient Abort (Method) Cancel (Method) CommStatus (Property) EndSession (Method) FaultStatus (Property) Init (Method) Invoke (Method) RequestState (Property) Session (Property) StartSession (Method) State (Property) Properties InterfaceIP (Property) SetSourcePortRange (Method) CLServer (FunctionBlock) Abort (Method) GetResolutionByActivityID (Method) Init (Method) Properties InterfaceIP (Property) ResponseState (Property) State (Property) RegisterIRPCProvider (Method) SetSourcePortRange (Method) UnregisterIRPCProvider (Method) Utils UUIDGenerator (FunctionBlock) CreateUUID (Method) Functions UUID_COMPARE (Function) GlobalConstants Constants (GVL) RemoteProcedureCalls (GVL) GlobalVariables Settings (GVL) Interfaces IRPCCLClient (Interface) Abort (Method) Cancel (Method) CommStatus (Property) EndSession (Method) FaultStatus (Property) Init (Method) Invoke (Method) RequestState (Property) Session (Property) StartSession (Method) State (Property) IRPCCLClientCallback (Interface) CancelCallback (Method) InvokeCallback (Method) IRPCProvider (Interface) Cancel (Method) InterfaceUUID (Property) ObjectUUID (Property) Request (Method) IRPCProviderCallback (Interface) GetActivityUUID (Method) RequestCallback (Method) Structs CLClientOptions (Struct) CLServerOptions (Struct) DataRepresentation (Struct) InterfaceVersion (Struct) RPCDataRepresentation (Struct) RemoteProcedureCall (Struct) UUID (Struct)

Enums ¶ CommStatus (Enum) ERROR (Enum) FaultStatus (Enum) NCAPDUFaultStatus (Enum) RPCNCARejectStatus (Enum) State Machines CLClientState (Enum) CLRequestState (Enum) SysTargetOperationNumber (Enum)

CommStatus (ENUM) ¶ TYPE CommStatus : InOut: Name Initial rpc_s_no_error 0 rpc_s_access_control_info_inv 16#16C9A04A rpc_s_cancel_timeout 16#16C9A030 rpc_s_comm_failure 16#16C9A016 rpc_s_connect_closed_by_rem 16#16C9A04C rpc_s_connect_no_resources 16#16C9A044 rpc_s_connect_rejected 16#16C9A042 rpc_s_connect_timed_out 16#16C9A041 rpc_s_connection_closed 16#16C9A036 rpc_s_host_unreachable 16#16C9A049 rpc_s_fault_remote_comm_failure 16#16C9A085 rpc_s_loc_connect_aborted 16#16C9A04B rpc_s_network_unreachable 16#16C9A043 rpc_s_no_memory 16#16C9A012 rpc_s_no_more_bindings 16#16C9A0B5 rpc_s_no_ns_permission 16#16C9A0A8 rpc_s_no_rem_endpoint 16#16C9A047 rpc_s_op_rng_error 16#16C9A001 rpc_s_rem_host_crashed 16#16C9A04D rpc_s_rem_host_down 16#16C9A048 rpc_s_rem_network_shutdown 16#16C9A045 rpc_s_too_many_rem_connects 16#16C9A046 rpc_s_unknown_if 16#16C9A02C rpc_s_unsupported_type 16#16C9A02D rpc_s_wrong_boot_time 16#16C9A006

ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name NO_ERROR TIME_OUT SESSION_ALREADY_ESTABLISHED ACTIVITY_ID_MISSMATCH INVALID_STATE PING_TIME_OUT RESPONSE_TIME_OUT OUT_OF_MEMORY RESPONSE_ALREADY_IN_PROGRESS REQUEST_ALREADY_IN_PROGRESS CANCEL_ALREADY_IN_PROGRESS TOO_MUCH_REQUEST_DATA OUT_FRAG_NUM_MISSMATCH NO_REQUEST_IN_PROGRESS INVALID_COMM_PARAMETER NULL_POINTER UNKNOWN_INTERFACE UNKNOWN_OBJECT MAX_NUM_PROVIDER_REACHED PROVIDER_NOT_FOUND INVALID_SESSION BINDING_TO_BROADCAST_FAILED INITIALIZING_END_POINT_MAPPER_FAILED ERR_SOCKET OUT_OF_SOCKET_ADDR FAILED

FaultStatus (ENUM) ¶ TYPE FaultStatus : DCE RPC Spec. page 672 Table E-3 InOut: Name Initial rps_s_no_error 0 rpc_s_fault_object_not_found 16#16C9A01B rpc_s_call_cancelled 16#16C9A031 rpc_s_fault_addr_error 16#16C9A074 rpc_s_fault_context_mismatch 16#16C9A075 rpc_s_fault_fp_div_by_zero 16#16C9A076 rpc_s_fault_fp_error 16#16C9A077 rpc_s_fault_fp_overflow 16#16C9A078 rpc_s_fault_fp_underflow 16#16C9A079 rpc_s_fault_ill_inst 16#16C9A07A rpc_s_fault_int_div_by_zero 16#16C9A07B rpc_s_fault_int_overflow 16#16C9A07C rpc_s_fault_invalid_bound 16#16C9A07D rpc_s_fault_invalid_tag 16#16C9A07E rpc_s_fault_pipe_closed 16#16C9A07F rpc_s_fault_pipe_comm_error 16#16C9A080 rpc_s_fault_pipe_discipline 16#16C9A081 rpc_s_fault_pipe_empty 16#16C9A082 rpc_s_fault_pipe_memory 16#16C9A083 rpc_s_fault_pipe_order 16#16C9A084 rpc_s_fault_remote_no_memory 16#16C9A086 rpc_s_fault_unspec 16#16C9A087 rpc_s_fault_user_defined 16#16C9A113 rpc_s_fault_tx_open_failed 16#16C9A116 rpc_s_fault_codeset_conv_error 16#16C9A16E rpc_s_fault_no_client_stub 16#16C9A170

Constants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant gc_uiDefaultUDPPort UINT 135 gc_uiDefaultTCPPort UINT 135 gc_udiBroadcast UDINT 16#FFFFFFFF gc_udiSubnetBroadcast UDINT 16#FF gc_usiRPCVersion USINT 4 RPC Header gc_udiRPCServerBootTime UDINT 0 Bit 0 – 15: RPCInterfaceVersion.Major; Bit 16 – 31: RPCInterfaceVersion.Minor gc_udiRPCInterfaceHint UINT 16#FFFF The value should be set to no hint (0xFFFF) for this version. gc_udiRPCActivityHint UINT 16#FFFF The value should be set to no hint (0xFFFF) for this version. The client shall start with “no hint” for the first call and should use the server response for the following calls to allow a server opt imization. gc_usiRPCAuthentication USINT 0 0 = no auth gc_uiMaxNumIRPCProvider UINT 8 Maximum number of IRPCProvider that can be registered at a rpc server gc_uiNumberOfAddressResolutions UINT 32 Maximum Number of Adress Resolution entries (IP to GUID) gc_uiMustRecvFragSize UINT 1464 rpc spec. page 686 Table K-2 gc_uiMaxPDUBodySize UINT (gc_uiMustRecvFragSize - 80) Maximum size of the pdu body. (= MustRecvFragSize (1464) - RPC Header (80) = 1384 gc_uiInitNumOfPDUs UINT 4 Initial number of PDU allocated by the memory manager gc_uiMaxPDUBufferSize UINT 13 Size of the PDU Input/Output Buffer (= max. Number of Fragments a Request & a Response can have)

RemoteProcedureCalls (GVL) ¶ List of available RPCs of the CLServer FB. All results are returned in Intel Byte Order (= little Endian) Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant CODESYS_OBJECT_UUID UUID STRUCT(Data1 := 16#25CE9503, Data2 := 16#674, Data3 := 16#47EE, Data4 := [16#86, 16#20, 16#77, 16#3C, 16#1B, 16#93, 16#D0, 16#E1]) UUID of CODESYS SYSTARGET_INTERFACE_UUID UUID STRUCT(Data1 := 16#27E2FD4E, Data2 := 16#4ED8, Data3 := 16#41EA, Data4 := [16#B2, 16#95, 16#6, 16#C1, 16#7F, 16#27, 16#3B, 16#96]) UUID of SysTarget library END_POINT_MAPPER_INTERFACE_UUID UUID STRUCT(Data1 := 16#E1AF8308, Data2 := 16#5D1F, Data3 := 16#11C9, Data4 := [16#91, 16#A4, 16#8, 16#0, 16#2B, 16#14, 16#A0, 16#FA]) UUID of End Point Mapper NDR_32_BIT_UUID UUID STRUCT(Data1 := 16#8A885D04, Data2 := 16#1CEB, Data3 := 16#11C9, Data4 := [16#9F, 16#E8, 16#8, 16#0, 16#2B, 16#10, 16#48, 16#60]) UUID of 32 bit NDR GetTargetNodeName RemoteProcedureCall STRUCT(ObjectID := CODESYS_OBJECT_UUID, InterfaceID := SYSTARGET_INTERFACE_UUID, OperationNumber := SysTargetOperationNumber.GetTargetNodeName) Get a human readable name that identifies this node in the network. NOTE: This could be the registered host name of the target in the network. Parameter value: none Return value: WSTRING(64) Type is 2 byte unicode! GetTargetVersion RemoteProcedureCall STRUCT(ObjectID := CODESYS_OBJECT_UUID, InterfaceID := SYSTARGET_INTERFACE_UUID, OperationNumber := SysTargetOperationNumber.GetTargetVersion) Returns the target version. Parameter value: none Return value: DWORD GetTargetId RemoteProcedureCall STRUCT(ObjectID := CODESYS_OBJECT_UUID, InterfaceID := SYSTARGET_INTERFACE_UUID, OperationNumber := SysTargetOperationNumber.GetTargetId) Returns the TargetId. NOTE: Highword of the TargetId is the VendorId! The VendorId is managed by 3S. Parameter value: none Return value: DWORD

GlobalVariables ¶ Settings (GVL)