CAPLfunctionGetPDUsTPUDPSrcPort

GetPDUsTPUDPSrcPort

Valid for: CANoe DE • CANoe4SW DE

Function Syntax

long GetPDUsTPUDPSrcPort(this, dword &udpSourcePort);

Description

This function can only be used within a on PDU handler. If the PDU was received via UDP, with this function the UDP source port can be requested.

Parameters

• this: Handle to the currently handled (received) PDU object.
• udpSourcePort: UDP source port.

Return Values

• 0: Data access successful.
• -1: Wrong bus system.
• -2: The requested information was not available. Most probably the PDU was not received by an UDP layer.
• -3: The PDU object is invalid.
• -4: PDU is not of RX type.
• -5: Parameter too small (e.g. array has too less bytes)
• -6: Message or PDU is not available (any more)

Example

on PDU engineDataPDU
{
  dword srcAddr, dstAddr, srcPort, dstPort;
  char srcAddrAsString[16], dstAddrAsString[16];

  if (GetPDUsTPIPv4SrcAddr(this, srcAddr)==0
      && GetPDUsTPIPv4DstAddr(this, dstAddr)==0)
  {
    IpGetAddressAsString(srcAddr, srcAddrAsString, elcount(srcAddrAsString));
    IpGetAddressAsString(dstAddr, dstAddrAsString, elcount(dstAddrAsString));

    if(GetPDUsTPUDPSrcPort(this, srcPort)==0
       && GetPDUsTPUDPDstPort(this, dstPort)==0)
    {
      write("PDU received by UDP from %s:%u to %s:%u", srcAddrAsString, srcPort, dstAddrAsString, dstPort);
    }

    if (GetPDUsTPTCPSrcPort(this, srcPort)==0
        && GetPDUsTPTCPDstPort(this, dstPort)==0)
    {
      write("PDU received by TCP from %s:%u to %s:%u", srcAddrAsString, srcPort, dstAddrAsString, dstPort);
    }
  }
}

GetPDUsTPIPv4DstAddr • GetPDUsTPIPv4SrcAddr • GetPDUsTPIPv6DstAddr • GetPDUsTPIPv6SrcAddr • GetPDUsTPTCPDstPort • GetPDUsTPTCPSrcPort • GetPDUsTPUDPDstPort