nw_udpv6_pkg Package Body Reference

Package >> nw_udpv6_pkg

Functions
t_slv_arr	f_udpv6_create_pkt ( ipv6_header: in t_ipv6_header udp_header: in t_udp_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER get_length: in boolean false )
t_slv_arr	f_udpv6_create_pkt ( ipv6_header: in t_ipv6_header udp_header: in t_udp_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Create UDP for IPv6 packet.
natural	f_udpv6_create_pkt_len ( ipv6_header: in t_ipv6_header udp_header: in t_udp_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Return length of UDP packet.
t_udp_header	f_udpv6_get_header ( udp_pkt: in t_slv_arr )
	Get UDP header.
t_slv_arr	f_udpv6_get_payload ( udp_pkt: in t_slv_arr , get_length: in boolean false )
t_slv_arr	f_udpv6_get_payload ( udp_pkt: in t_slv_arr )
	Get UDP payload.
natural	f_udpv6_get_payload_len ( udp_pkt: in t_slv_arr )
	Get UDP payload length.
boolean	f_udpv6_chksum_ok ( ipv6_header: in t_ipv6_header udp_pkt: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Check UDP checksum.

Member Function Documentation

f_udpv6_create_pkt()

t_slv_arr f_udpv6_create_pkt (   ipv6_header in t_ipv6_header ,   udp_header in t_udp_header ,   payload in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Create UDP for IPv6 packet.

Parameters

ipv6_header	IPv6 header (required for checksum calculation)
udp_header	UDP header
payload	UDP payload
routing_header	IPv6 routing extension header (default none)

Returns

UDP packet (8bit array) or length of UDP packet

Create UDP for IPv6 packet. Payload must be 8bit data array. A pseudo-header is generated from the IPv6 header which is included in the checksum calculation. If the IPv6 packet contains a routing extension header, it must be included here as the pseudo header destination address is the final destination.

Example use

v_ipv6_header := C_DEFAULT_IPV6_HEADER;
v_udp_header  := C_DEFAULT_UDP_HEADER;
v_packet_8bit := f_udpv6_create_pkt(v_ipv6_header, v_udp_header, payload); 

f_udpv6_create_pkt_len()

natural f_udpv6_create_pkt_len (   ipv6_header in t_ipv6_header ,   udp_header in t_udp_header ,   payload in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Return length of UDP packet.

Parameters

ipv6_header	IPv6 header (required for checksum calculation)
udp_header	UDP header
payload	UDP payload
routing_header	IPv6 routing extension header (default none)

Returns

Length of UDP packet

Return the length of the created UDP packet.

Example use

v_len                      := f_udpv6_create_pkt_len(C_DEFAULT_IPV6_HEADER, v_udp_header, payload); 
v_pkt_8bit(0 to v_len - 1) := f_udpv6_create_pkt(C_DEFAULT_IPV6_HEADER, v_udp_header, payload);

f_udpv6_get_header()

t_udp_header f_udpv6_get_header (   udp_pkt in t_slv_arr   )

Function

Get UDP header.

Parameters

udp_pkt

UDP packet (8bit)

Returns

UDP header

Extract UDP header from UDP packet.

Example use

v_udp_header := f_udpv6_get_header(data_array_8bit); 

f_udpv6_get_payload()

t_slv_arr f_udpv6_get_payload (   udp_pkt in t_slv_arr   )

Function

Get UDP payload.

Parameters

udp_pkt

UDP packet (8bit)

Returns

t_slv_arr

Extract UDP payload from UDP packet.

Example use

v_len                     := f_udpv6_get_payload_len(data_array_8bit); 
v_payload(0 to v_len - 1) := f_udpv6_get_payload(data_array_8bit); 

f_udpv6_get_payload_len()

natural f_udpv6_get_payload_len (   udp_pkt in t_slv_arr   )

Function

Get UDP payload length.

Parameters

udp_pkt

UDP packet (8bit)

Returns

UDP payload length

Get UDP payload length from UDP packet.

Example use

v_len := f_udpv6_get_payload_len(data_array_8bit); -- determine size of payload

f_udpv6_chksum_ok()

boolean f_udpv6_chksum_ok (   ipv6_header in t_ipv6_header ,   udp_pkt in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Check UDP checksum.

Parameters

ipv6_header	IPv6 header
udp_pkt	UDP packet (8bit)
routing_header	IPv6 routing extension header (default none)

Returns

Checksum is OK (True), or not (False)

Check checksum of UDP packet. The IPv6 header is required for the pseudo-header fields. If the IPv6 packet contains a routing extension header, it must be included here as the pseudo header destination address is the final destination.

Example use

v_check := f_udpv6_chksum_ok(ipv6_header, data_array_8bit); 

---

The documentation for this class was generated from the following file:

• nw_ipv6/src/nw_udpv6_pkg.vhd