RMPMessageBuffer (FB) ¶ FUNCTION_BLOCK FINAL RMPMessageBuffer This FB represents a queue of messages that are stored in a RMPService; it is used both for sending and receiving Methods: AddMessage ClearExpiredMessages Delete EnlargeExpirationTime ExistsMessageWithHandle GetMessage GetMessageForReceiver GetMessageToApplication Lock Unlock Structure: AddMessage (Method) ClearExpiredMessages (Method) Delete (Method) EnlargeExpirationTime (Method) ExistsMessageWithHandle (Method) GetMessage (Method) GetMessageForReceiver (Method) GetMessageToApplication (Method) Lock (Method) Unlock (Method)
RMPMessageBuffer.AddMessage (METH) ¶ METHOD FINAL AddMessage : UINT Queues message and returns the handle of this message or 16#FFFF, if the buffer was full InOut: Scope Name Type Comment Return AddMessage UINT Input udiSenderID UDINT The sender ID of the message udiReceiverID UDINT The receiver ID of the message tValidity TIME For send lists: tExpirationTime is the time distance, how long this message shall be kept in the receive queue for receive lists: tExpirationTime is the point in time, when it hat to be deleted if not acknowledged pmdData POINTER TO ARRAY [0..63] OF BYTE Data
RMPMessageBuffer.ClearExpiredMessages (METH) ¶ METHOD PUBLIC FINAL ClearExpiredMessages Clears the expired messages out of the buffer
RMPMessageBuffer.Delete (METH) ¶ METHOD FINAL Delete : BOOL This method frees a queue entry and may only be called on lockes messages InOut: Scope Name Type Comment Return Delete BOOL Input uiIndex UINT The index of the buffered message to be deleted
RMPMessageBuffer.EnlargeExpirationTime (METH) ¶ METHOD PUBLIC FINAL EnlargeExpirationTime Enlarges the expiration time of all messages InOut: Scope Name Type Comment Input tShift TIME The time by which the expiration times shall be increased
RMPMessageBuffer.ExistsMessageWithHandle (METH) ¶ METHOD FINAL ExistsMessageWithHandle : BOOL Checks if message with handle uiHandle exists InOut: Scope Name Type Comment Return ExistsMessageWithHandle BOOL Input uiHandle UINT Handle associated with the message
RMPMessageBuffer.GetMessage (METH) ¶ METHOD FINAL GetMessage : POINTER TO RMPBufferedMessage Returns pointer to message number uiIndex [0..] of buffer InOut: Scope Name Type Comment Return GetMessage POINTER TO RMPBufferedMessage Input uiIndex UINT The index of the message to get from the buffer
RMPService.GetComFBForComAddress (METH) ¶ METHOD GetComFBForComAddress : IRMPFBCommunication This functions returns the communication FB used to communicate to or from a given Module ComAddress of a Module. ..note: If communication FBs are not used for communication this function will always return 0! ..return: If FB communication was used and a FB communicating to or from the given ComAddress exists the correspnding FB/Interface is returned If no communication FB is available 0 is reutnred. InOut: Scope Name Type Comment Return GetComFBForComAddress IRMPFBCommunication Input udiModuleComAddress UDINT The ComAddress of the Module for which the CommunicationFB shall be received
RMPService.GetIsActionOngoing (METH) ¶ METHOD GetIsActionOngoing : BOOL ..return: If it was possible to get the current state of activity. If this is FALSE xIsActionOngoing is not valid! InOut: Scope Name Type Return GetIsActionOngoing BOOL Output xIsActionOngoing BOOL
RMPService.LocalAppID (PROP) ¶ PROPERTY FINAL LocalAppID : UINT