IDriverStateMachine (ITF) ¶ INTERFACE IDriverStateMachine EXTENDS __SYSTEM.IQueryInterface Properties: ShutdownAfterError Methods: Connecting PollRequestResult ResetAfterError SendRequest ShuttingDown StartConnect StartShutdown Structure: Connecting (Method) PollRequestResult (Method) ResetAfterError (Method) SendRequest (Method) ShutdownAfterError (Property) ShuttingDown (Method) StartConnect (Method) StartShutdown (Method)
IDriverStateMachine.Connecting (METH) ¶ METHOD Connecting : SysTypes.RTS_IEC_RESULT Using this method the driver is polled whether the startup of the connection is already finshed. InOut: Scope Name Type Comment Return Connecting SysTypes.RTS_IEC_RESULT An error code representing the result of the polling operation. In case the operation is not yet finished, ERR_PENDING should be returned. When it finished successfully, ERR_OK should be returned. When connecting failed, an error code should be returned and then the whole connection will be set up again.
IDriverStateMachine.PollRequestResult (METH) ¶ METHOD PollRequestResult : SysTypes.RTS_IEC_RESULT Using this method the driver is polled whether the given request is already finshed. InOut: Scope Name Type Comment Return PollRequestResult SysTypes.RTS_IEC_RESULT An error code representing the result of the polling operation. In case the operation is not yet finished, ERR_PENDING should be returned. When it finished successfully, 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 IDriverRequest The request object to check for it’s result
IDriverStateMachine.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.
IDriverStateMachine.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, ERR_PENDING should be returned. This will then cause followup calls to IDriverStateMachine.PollRequestResult . In case the operation finished synchronously, 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 IDriverRequest The request object representing the information that should be sent to the connected device.
IDriverStateMachine.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.
IDriverStateMachine.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, 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 .
IDriverStateMachine.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 ERR_PENDING. A successfull return (ERR_OK) of this method will then cause followup calls to IDriverStateMachine.Connecting .
IDriverStateMachine.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 ERR_PENDING. A successfull return (ERR_OK) of this method will then cause followup calls to IDriverStateMachine.ShuttingDown .
IDriverStateMachine2 (ITF) ¶ INTERFACE IDriverStateMachine2 EXTENDS IDriverStateMachine Properties: ShutdownAfterError , inherited from IDriverStateMachine Methods: WaitingForCommSetting Connecting , inherited from IDriverStateMachine PollRequestResult , inherited from IDriverStateMachine ResetAfterError , inherited from IDriverStateMachine SendRequest , inherited from IDriverStateMachine ShuttingDown , inherited from IDriverStateMachine StartConnect , inherited from IDriverStateMachine StartShutdown , inherited from IDriverStateMachine Structure: WaitingForCommSetting (Method)
