NS-3
ns3::Ipv6EndPoint Class Reference

An IPv6 end point, four tuples identification. More...

#include <ipv6-end-point.h>

Collaboration diagram for ns3::Ipv6EndPoint:

List of all members.

Public Member Functions

 Ipv6EndPoint (Ipv6Address addr, uint16_t port)
 Constructor.
 ~Ipv6EndPoint ()
 Destructor.
Ipv6Address GetLocalAddress ()
 Get the local address.
void SetLocalAddress (Ipv6Address addr)
 Set the local address.
uint16_t GetLocalPort ()
 Get the local port.
void SetLocalPort (uint16_t port)
 Set the local port.
Ipv6Address GetPeerAddress ()
 Get the peer address.
uint16_t GetPeerPort ()
 Get the peer port.
void SetPeer (Ipv6Address addr, uint16_t port)
 Set the peer informations (address and port).
void SetRxCallback (Callback< void, Ptr< Packet >, Ipv6Address, uint16_t > callback)
 Set the reception callback.
void SetIcmpCallback (Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t > callback)
 Set the ICMP callback.
void SetDestroyCallback (Callback< void > callback)
 Set the default destroy callback.
void ForwardUp (Ptr< Packet > p, Ipv6Address addr, uint16_t port)
 Forward the packet to the upper level.
void ForwardIcmp (Ipv6Address src, uint8_t ttl, uint8_t type, uint8_t code, uint32_t info)
 Function called from an L4Protocol implementation to notify an endpoint of an icmp message reception.

Detailed Description

An IPv6 end point, four tuples identification.


Constructor & Destructor Documentation

ns3::Ipv6EndPoint::Ipv6EndPoint ( Ipv6Address  addr,
uint16_t  port 
)

Constructor.

Parameters:
addrthe IPv6 address
portthe port

Member Function Documentation

void ns3::Ipv6EndPoint::ForwardIcmp ( Ipv6Address  src,
uint8_t  ttl,
uint8_t  type,
uint8_t  code,
uint32_t  info 
)

Function called from an L4Protocol implementation to notify an endpoint of an icmp message reception.

Parameters:
srcsource IPv6 address
ttltime-to-live
typeICMPv6 type
codeICMPv6 code
infoICMPv6 info
void ns3::Ipv6EndPoint::ForwardUp ( Ptr< Packet p,
Ipv6Address  addr,
uint16_t  port 
)

Forward the packet to the upper level.

Parameters:
pthe packet
addrsource address
portsource port
Ipv6Address ns3::Ipv6EndPoint::GetLocalAddress ( )

Get the local address.

Returns:
the local address
uint16_t ns3::Ipv6EndPoint::GetLocalPort ( )

Get the local port.

Returns:
the local port
Ipv6Address ns3::Ipv6EndPoint::GetPeerAddress ( )

Get the peer address.

Returns:
the peer address
uint16_t ns3::Ipv6EndPoint::GetPeerPort ( )

Get the peer port.

Returns:
the peer port
void ns3::Ipv6EndPoint::SetDestroyCallback ( Callback< void >  callback)

Set the default destroy callback.

Parameters:
callbackcallback function
void ns3::Ipv6EndPoint::SetIcmpCallback ( Callback< void, Ipv6Address, uint8_t, uint8_t, uint8_t, uint32_t >  callback)

Set the ICMP callback.

Parameters:
callbackcallback function
void ns3::Ipv6EndPoint::SetLocalAddress ( Ipv6Address  addr)

Set the local address.

Parameters:
addrthe address to set
void ns3::Ipv6EndPoint::SetLocalPort ( uint16_t  port)

Set the local port.

Parameters:
portthe port to set
void ns3::Ipv6EndPoint::SetPeer ( Ipv6Address  addr,
uint16_t  port 
)

Set the peer informations (address and port).

Parameters:
addrpeer address
portpeer port
void ns3::Ipv6EndPoint::SetRxCallback ( Callback< void, Ptr< Packet >, Ipv6Address, uint16_t >  callback)

Set the reception callback.

Parameters:
callbackcallback function

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