IUdp

Package: inet.transportlayer.contract

IUdp

module interface

UDP protocol interface.

The UDP protocol header is represented by the class UdpHeader.

Communication with clients (applications)

The module can (should) be connected to several applications. For sending an Udp packet, the application should attach an UdpControlInfo object to the payload, and send it to Udp. Udp will also attach an UdpControlInfo object to any payload message in sends up to the application.

For receiving UDP packets, the connected applications should first "bind" to the given UDP port. This can be done by sending an arbitrary message with message kind UDP_C_BIND and an UdpControlInfo attached with srcPort filled in.

If there is only one app which doesn't bind to any port, it will receive all packets.

Communication with the IPv4 (IPv4/IPv6) layer

The Udp model relies on sending and receiving L3AddressReq/L3AddressInd objects attached to packets.

See also: Udp, UdpHeader, UdpControlInfo, UdpCommandCode

IUdp

Used in compound modules

Name Type Description
LdpMplsRouter compound module

An LDP-capable router.

TransportLayerNodeBase compound module (no description)

Properties

Name Value Description
display i=block/transport

Source code

//
// UDP protocol interface.
//
// The UDP protocol header is represented by the class ~UdpHeader.
//
// <b>Communication with clients (applications)</b>
//
// The module can (should) be connected to several applications.
// For sending an Udp packet, the application should attach an ~UdpControlInfo
// object to the payload, and send it to ~Udp.
// ~Udp will also attach an ~UdpControlInfo object to any payload
// message in sends up to the application.
//
// For receiving UDP packets, the connected applications should first
// "bind" to the given UDP port. This can be done by sending an
// arbitrary message with message kind UDP_C_BIND and an ~UdpControlInfo
// attached with srcPort filled in.
//
// If there is only one app which doesn't bind to any port, it will
// receive all packets.
//
// <b>Communication with the IPv4 (IPv4/IPv6) layer</b>
//
// The ~Udp model relies on sending and receiving ~L3AddressReq/~L3AddressInd
// objects attached to packets.
//
// @see ~Udp, ~UdpHeader, ~UdpControlInfo, ~UdpCommandCode
//
moduleinterface IUdp
{
    parameters:
        @display("i=block/transport");

    gates:
        input appIn @labels(UdpControlInfo/down);
        input ipIn @labels(UdpHeader,Ipv4ControlInfo/up,Ipv6ControlInfo/up);
        output appOut @labels(UdpControlInfo/up);
        output ipOut @labels(UdpHeader,Ipv4ControlInfo/down,Ipv6ControlInfo/down);
}

File: src/inet/transportlayer/contract/IUdp.ned