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
RMPMessageBuffer.GetMessageForReceiver (METH) ¶ METHOD FINAL GetMessageForReceiver : UINT Returns position of oldest message treceived for uireceiverID (16#FFFF if no message received) InOut: Scope Name Type Comment Return GetMessageForReceiver UINT Input uiReceiverModuleID UINT The id of the receiver to get the message from the buffer for
RMPMessageBuffer.GetMessageToApplication (METH) ¶ METHOD FINAL GetMessageToApplication : UINT Returns position of oldest message to be transmitted to uiApplicationID (16#FFFF if no message to transmit) InOut: Scope Name Type Comment Return GetMessageToApplication UINT Input uiReceiverAppID UINT The ID of the receiver application to get the message from the buffer for
RMPMessageBuffer.Lock (METH) ¶ METHOD FINAL Lock : BOOL Locks a certain message InOut: Scope Name Type Comment Return Lock BOOL Input uiIndex UINT The index of the message to be locked in the buffer
RMPMessageBuffer.Unlock (METH) ¶ METHOD FINAL Unlock : BOOL Unlocks a certain message InOut: Scope Name Type Comment Return Unlock BOOL Input uiIndex UINT Index of the message to unlock in the buffer
RMPSendMessage (FB) ¶ FUNCTION_BLOCK FINAL RMPSendMessage EXTENDS CBM.ETRIG Function block that can be used to send a message from a module to another module. Use this function block for sending messages. If sending succeded xDone gets TRUE. If an error occurs during sending (i.e. receiving could not be assured) xError gets TRUE. Reset xExecute to FALSE before reusage of the function block by setting xExecute to TRUE. A possible call semantic could be: RMPSendMessage(xExecute := TRUE, itfRmp := pEnv^.rmps, udiReceiverID := udiProxyCom, uiSenderModuleID:= UDINT_TO_UINT(ComAddress AND 16#FFFF), tValidity:=T#1S, mdData := mdData ); This function block needs to be called until xDone is TRUE. If so, sending was successfull. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Inout mdData ARRAY [0..63] OF BYTE The data to send Input itfRmp IRmpService The RMP (Reliable Message Protocoll) sevrice to use for sending. This service can be aquired via the environment available in any module via IModule (see example of the function block description). udiReceiverID UDINT 32-Bit-ID of receiver. This ID normaly is received, when receiving a message from a proxy (via Receive of IRMPService in an RMP (Reliable Message Protocoll) service uiSenderModuleID UINT The (local) 16 bit address of the receiver, which equals the first 16bit of the ComAddress (see AND 16#FFFF) tValidity TIME TIME#1s0ms The time this message is valid when sending it Output uiError UINT If an error occured, the number accounts for one of the following errors: 1: send buffer full; 2: message cannot be transmitted before tValidity (connection broken or remote receive buffer full) 3: receiver application not connected to this app
Toplevel_Vertical_Template ¶ IP_Toplevel_Template (ImagePool)