IDriverSpecifiedSettings ¶ ReconnectWaitTime (Method) TimeoutSyncShutdown (Method)
Driver.Init (METH) ¶ METHOD Init This method passes an instance of the configuration object to the driver. The according concrete type is driver dependent and the codegeneration will allocate and initialize the configuration object accordingly before calling this method. InOut: Scope Name Type Input pCFGData POINTER TO BYTE
StateMachine.ResetAfterError (METH) ¶ METHOD ResetAfterError This method is called after a failed call to one of the other methods where |IDriverStateMachine.ShutdownAfterError| returns FALSE. Implementations can use this call to get into a state where it is possible to start a new connection after some delay.
StateMachine.SendRequest (METH) ¶ METHOD SendRequest : SysTypes.RTS_IEC_RESULT Using this method a request should be sent by the driver. InOut: Scope Name Type Comment Return SendRequest SysTypes.RTS_IEC_RESULT An error code representing the result of the polling operation. In case the operation is not yet finished, CmpErrors.Errors.ERR_PENDING should be returned. This will then cause followup calls to |IDriverStateMachine.PollRequestResult| . In case the operation finished synchronously, CmpErrors.Errors.ERR_OK should be returned. When sending a request failed, an error code should be returned and then the whole connection will be set up again. Input request IDatasources.IDriverRequest The request object representing the information that should be sent to the connected device.
StateMachine.ShutdownAfterError (PROP) ¶ PROPERTY ShutdownAfterError : BOOL This property returns TRUE when the shutdown sequence should be called after a previous error. The property will be evaluated after there was an error return from one of the state machine methods.
StateMachine.ShutdownTimedout (METH) ¶ METHOD ShutdownTimedout Called when the shutdown operation timed out.
StateMachine.ShuttingDown (METH) ¶ METHOD ShuttingDown : SysTypes.RTS_IEC_RESULT This method is called during the shutdown sequence. Implementations can use it to implement the shutdown sequence (like loggint out from the connected device, closing connection resources etc.) InOut: Scope Name Type Comment Return ShuttingDown SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. In case the sequence is not yet finished, CmpErrors.Errors.ERR_PENDING should be returned. After a successfull or failed return, the implementation should be in a state where a new connection could be setup using a possible followup call to |IDriverStateMachine.StartConnect| .
StateMachine.StartConnect (METH) ¶ METHOD StartConnect : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Comment Return StartConnect SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. Please remark that this operation is not expected to return CmpErrors.Errors.ERR_PENDING. A successfull return (CmpErrors.Errors.ERR_OK) of this method will then cause followup calls to |IDriverStateMachine.Connecting| .
StateMachine.StartShutdown (METH) ¶ METHOD StartShutdown : SysTypes.RTS_IEC_RESULT This method is called to start the shutdown sequence. Implementations can use it to start logging out from the connected device for example. This method is not called while a request is pending. InOut: Scope Name Type Comment Return StartShutdown SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. Please remark that this operation is not expected to return CmpErrors.Errors.ERR_PENDING. A successfull return (CmpErrors.Errors.ERR_OK) of this method will then cause followup calls to |IDriverStateMachine.ShuttingDown| .
StateMachine.WaitingForCommSetting (METH) ¶ METHOD WaitingForCommSetting : SysTypes.RTS_IEC_RESULT Waiting for communication settings InOut: Scope Name Type Return WaitingForCommSetting SysTypes.RTS_IEC_RESULT Input xPreview BOOL
