A representation of an internet endpoint/connection. More...

#include "ipv4-end-point.h"

Collaboration diagram for ns3::Ipv4EndPoint:

Public Member Functions
	Ipv4EndPoint (Ipv4Address address, uint16_t port)
	Constructor. More...

	~Ipv4EndPoint ()

void	BindToNetDevice (Ptr< NetDevice > netdevice)
	Bind a socket to specific device. More...

void	ForwardIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo)
	Forward the ICMP packet to the upper level. More...

void	ForwardUp (Ptr< Packet > p, const Ipv4Header &header, uint16_t sport, Ptr< Ipv4Interface > incomingInterface)
	Forward the packet to the upper level. More...

Ptr< NetDevice >	GetBoundNetDevice () const
	Returns socket's bound netdevice, if any. More...

Ipv4Address	GetLocalAddress () const
	Get the local address. More...

uint16_t	GetLocalPort () const
	Get the local port. More...

Ipv4Address	GetPeerAddress () const
	Get the peer address. More...

uint16_t	GetPeerPort () const
	Get the peer port. More...

bool	IsRxEnabled () const
	Checks if the endpoint can receive packets. More...

void	SetDestroyCallback (Callback< void > callback)
	Set the default destroy callback. More...

void	SetIcmpCallback (Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t > callback)
	Set the ICMP callback. More...

void	SetLocalAddress (Ipv4Address address)
	Set the local address. More...

void	SetPeer (Ipv4Address address, uint16_t port)
	Set the peer information (address and port). More...

void	SetRxCallback (Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface >> callback)
	Set the reception callback. More...

void	SetRxEnabled (bool enabled)
	Enable or Disable the endpoint Rx capability. More...

Private Attributes
Ptr< NetDevice >	m_boundnetdevice
	The NetDevice the EndPoint is bound to (if any). More...

Callback< void >	m_destroyCallback
	The destroy callback. More...

Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t >	m_icmpCallback
	The ICMPv6 callback. More...

Ipv4Address	m_localAddr
	The local address. More...

uint16_t	m_localPort
	The local port. More...

Ipv4Address	m_peerAddr
	The peer address. More...

uint16_t	m_peerPort
	The peer port. More...

Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface > >	m_rxCallback
	The RX callback. More...

bool	m_rxEnabled
	true if the endpoint can receive packets. More...

Detailed Description

A representation of an internet endpoint/connection.

This class provides an internet four-tuple (source and destination ports and addresses). These are used in the ns3::Ipv4EndPointDemux as targets of lookups. The class also has a callback for notification to higher layers that a packet from a lower layer was received. In the ns3 internet-stack, these notifications are automatically registered to be received by the corresponding socket.

Definition at line 51 of file ipv4-end-point.h.

Constructor & Destructor Documentation

◆ Ipv4EndPoint()

ns3::Ipv4EndPoint::Ipv4EndPoint	(	Ipv4Address	address,
		uint16_t	port
	)

Constructor.

Parameters

address	the IPv4 address
port	the port

Definition at line 31 of file ipv4-end-point.cc.

References first::address, NS_LOG_FUNCTION, and port.

◆ ~Ipv4EndPoint()

ns3::Ipv4EndPoint::~Ipv4EndPoint ( )

Definition at line 41 of file ipv4-end-point.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_destroyCallback, m_icmpCallback, m_rxCallback, NS_LOG_FUNCTION, and ns3::Callback< R, UArgs >::Nullify().

Here is the call graph for this function:

Member Function Documentation

◆ BindToNetDevice()

void ns3::Ipv4EndPoint::BindToNetDevice ( Ptr< NetDevice > netdevice )

Bind a socket to specific device.

This method corresponds to using setsockopt() SO_BINDTODEVICE of real network or BSD sockets. If set on a socket, this option will force packets to leave the bound device regardless of the device that IP routing would naturally choose. In the receive direction, only packets received from the bound interface will be delivered.

This option has no particular relationship to binding sockets to an address via Socket::Bind (). It is possible to bind sockets to a specific IP address on the bound interface by calling both Socket::Bind (address) and Socket::BindToNetDevice (device), but it is also possible to bind to mismatching device and address, even if the socket can not receive any packets as a result.

Parameters

netdevice Pointer to Netdevice of desired interface

Definition at line 97 of file ipv4-end-point.cc.

References m_boundnetdevice, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::Bind(), ns3::TcpSocketBase::BindToNetDevice(), and ns3::UdpSocketImpl::BindToNetDevice().

Here is the caller graph for this function:

◆ ForwardIcmp()

void ns3::Ipv4EndPoint::ForwardIcmp	(	Ipv4Address	icmpSource,
		uint8_t	icmpTtl,
		uint8_t	icmpType,
		uint8_t	icmpCode,
		uint32_t	icmpInfo
	)

Forward the ICMP packet to the upper level.

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

Parameters

icmpSource	source IP address
icmpTtl	time-to-live
icmpType	ICMP type
icmpCode	ICMP code
icmpInfo	ICMP info

Definition at line 148 of file ipv4-end-point.cc.

References m_icmpCallback, and NS_LOG_FUNCTION.

Referenced by ns3::TcpL4Protocol::ReceiveIcmp(), and ns3::UdpL4Protocol::ReceiveIcmp().

Here is the caller graph for this function:

◆ ForwardUp()

void ns3::Ipv4EndPoint::ForwardUp	(	Ptr< Packet >	p,
		const Ipv4Header &	header,
		uint16_t	sport,
		Ptr< Ipv4Interface >	incomingInterface
	)

Forward the packet to the upper level.

Called from an L4Protocol implementation to notify an endpoint of a packet reception.

Parameters

p	the packet
header	the packet header
sport	source port
incomingInterface	incoming interface

Definition at line 134 of file ipv4-end-point.cc.

References m_rxCallback, and NS_LOG_FUNCTION.

◆ GetBoundNetDevice()

Ptr< NetDevice > ns3::Ipv4EndPoint::GetBoundNetDevice ( ) const

Returns socket's bound netdevice, if any.

This method corresponds to using getsockopt() SO_BINDTODEVICE of real network or BSD sockets.

Returns: Pointer to interface.

Definition at line 104 of file ipv4-end-point.cc.

References m_boundnetdevice, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4EndPointDemux::Lookup().

Here is the caller graph for this function:

◆ GetLocalAddress()

Ipv4Address ns3::Ipv4EndPoint::GetLocalAddress ( ) const

Get the local address.

Returns: the local address

Definition at line 54 of file ipv4-end-point.cc.

References m_localAddr, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::DoSendTo(), ns3::TcpSocketBase::ForwardUp(), ns3::TcpSocketBase::GetSockName(), ns3::UdpSocketImpl::GetSockName(), ns3::Ipv4EndPointDemux::Lookup(), ns3::TcpSocketBase::PersistTimeout(), ns3::TcpSocketBase::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketCongestedRouter::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), and ns3::TcpSocketSmallAcks::SendEmptyPacket().

Here is the caller graph for this function:

◆ GetLocalPort()

uint16_t ns3::Ipv4EndPoint::GetLocalPort ( ) const

Get the local port.

Returns: the local port

Definition at line 68 of file ipv4-end-point.cc.

References m_localPort, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::DoSendTo(), ns3::TcpSocketBase::ForwardUp(), ns3::TcpSocketBase::GetSockName(), ns3::UdpSocketImpl::GetSockName(), ns3::Ipv4EndPointDemux::Lookup(), ns3::TcpSocketBase::PersistTimeout(), ns3::TcpSocketBase::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketCongestedRouter::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), and ns3::TcpSocketSmallAcks::SendEmptyPacket().

Here is the caller graph for this function:

◆ GetPeerAddress()

Ipv4Address ns3::Ipv4EndPoint::GetPeerAddress ( ) const

Get the peer address.

Returns: the peer address

Definition at line 75 of file ipv4-end-point.cc.

References m_peerAddr, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::ForwardUp(), ns3::TcpSocketBase::GetPeerName(), ns3::Ipv4EndPointDemux::Lookup(), ns3::TcpSocketBase::PersistTimeout(), ns3::TcpSocketBase::RecvFrom(), ns3::TcpSocketBase::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketCongestedRouter::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), ns3::TcpSocketSmallAcks::SendEmptyPacket(), and ns3::TcpSocketBase::SetupEndpoint().

Here is the caller graph for this function:

◆ GetPeerPort()

uint16_t ns3::Ipv4EndPoint::GetPeerPort ( ) const

Get the peer port.

Returns: the peer port

Definition at line 82 of file ipv4-end-point.cc.

References m_peerPort, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::ForwardUp(), ns3::TcpSocketBase::GetPeerName(), ns3::Ipv4EndPointDemux::Lookup(), ns3::TcpSocketBase::PersistTimeout(), ns3::TcpSocketBase::RecvFrom(), ns3::TcpSocketBase::SendDataPacket(), TcpDctcpCongestedRouter::SendDataPacket(), ns3::TcpSocketCongestedRouter::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), and ns3::TcpSocketSmallAcks::SendEmptyPacket().

Here is the caller graph for this function:

◆ IsRxEnabled()

bool ns3::Ipv4EndPoint::IsRxEnabled ( ) const

Checks if the endpoint can receive packets.

Returns: true if the endpoint can receive packets.

Definition at line 169 of file ipv4-end-point.cc.

References m_rxEnabled.

Referenced by ns3::Ipv4EndPointDemux::Lookup().

Here is the caller graph for this function:

◆ SetDestroyCallback()

void ns3::Ipv4EndPoint::SetDestroyCallback ( Callback< void > callback )

Set the default destroy callback.

Parameters

callback callback function

Definition at line 127 of file ipv4-end-point.cc.

References m_destroyCallback, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::DeallocateEndPoint(), ns3::UdpSocketImpl::FinishBind(), and ns3::TcpSocketBase::SetupCallback().

Here is the caller graph for this function:

◆ SetIcmpCallback()

void ns3::Ipv4EndPoint::SetIcmpCallback ( Callback< void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t > callback )

Set the ICMP callback.

Parameters

callback callback function

Definition at line 119 of file ipv4-end-point.cc.

References m_icmpCallback, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::FinishBind(), and ns3::TcpSocketBase::SetupCallback().

Here is the caller graph for this function:

◆ SetLocalAddress()

void ns3::Ipv4EndPoint::SetLocalAddress ( Ipv4Address address )

Set the local address.

Parameters

address the address to set

Definition at line 61 of file ipv4-end-point.cc.

References first::address, m_localAddr, and NS_LOG_FUNCTION.

Referenced by ns3::TcpSocketBase::SetupEndpoint().

Here is the caller graph for this function:

◆ SetPeer()

void ns3::Ipv4EndPoint::SetPeer	(	Ipv4Address	address,
		uint16_t	port
	)

Set the peer information (address and port).

Parameters

address	peer address
port	peer port

Definition at line 89 of file ipv4-end-point.cc.

References first::address, m_peerAddr, m_peerPort, NS_LOG_FUNCTION, and port.

Referenced by ns3::TcpSocketBase::Connect(), and ns3::TcpSocketBase::ProcessSynRcvd().

Here is the caller graph for this function:

◆ SetRxCallback()

void ns3::Ipv4EndPoint::SetRxCallback ( Callback< void, Ptr< Packet >, Ipv4Header, uint16_t, Ptr< Ipv4Interface >> callback )

Set the reception callback.

Parameters

callback callback function

Definition at line 111 of file ipv4-end-point.cc.

References m_rxCallback, and NS_LOG_FUNCTION.

Referenced by ns3::UdpSocketImpl::FinishBind(), and ns3::TcpSocketBase::SetupCallback().

Here is the caller graph for this function:

◆ SetRxEnabled()

void ns3::Ipv4EndPoint::SetRxEnabled ( bool enabled )

Enable or Disable the endpoint Rx capability.

Parameters

enabled true if Rx is enabled

Definition at line 163 of file ipv4-end-point.cc.

References m_rxEnabled.

Referenced by ns3::UdpSocketImpl::ShutdownRecv().

Here is the caller graph for this function:

Member Data Documentation

◆ m_boundnetdevice

Ptr<NetDevice> ns3::Ipv4EndPoint::m_boundnetdevice

private

The NetDevice the EndPoint is bound to (if any).

Definition at line 217 of file ipv4-end-point.h.

Referenced by BindToNetDevice(), and GetBoundNetDevice().

◆ m_destroyCallback

Callback<void> ns3::Ipv4EndPoint::m_destroyCallback

private

The destroy callback.

Definition at line 232 of file ipv4-end-point.h.

Referenced by ~Ipv4EndPoint(), and SetDestroyCallback().

◆ m_icmpCallback

Callback<void, Ipv4Address, uint8_t, uint8_t, uint8_t, uint32_t> ns3::Ipv4EndPoint::m_icmpCallback

private

The ICMPv6 callback.

Definition at line 227 of file ipv4-end-point.h.

Referenced by ~Ipv4EndPoint(), ForwardIcmp(), and SetIcmpCallback().

◆ m_localAddr

Ipv4Address ns3::Ipv4EndPoint::m_localAddr

private

The local address.

Definition at line 197 of file ipv4-end-point.h.

Referenced by GetLocalAddress(), and SetLocalAddress().

◆ m_localPort

uint16_t ns3::Ipv4EndPoint::m_localPort

private

The local port.

Definition at line 202 of file ipv4-end-point.h.

Referenced by GetLocalPort().

◆ m_peerAddr

Ipv4Address ns3::Ipv4EndPoint::m_peerAddr

private

The peer address.

Definition at line 207 of file ipv4-end-point.h.

Referenced by GetPeerAddress(), and SetPeer().

◆ m_peerPort

uint16_t ns3::Ipv4EndPoint::m_peerPort

private

The peer port.

Definition at line 212 of file ipv4-end-point.h.

Referenced by GetPeerPort(), and SetPeer().

◆ m_rxCallback

Callback<void, Ptr<Packet>, Ipv4Header, uint16_t, Ptr<Ipv4Interface> > ns3::Ipv4EndPoint::m_rxCallback

private

The RX callback.

Definition at line 222 of file ipv4-end-point.h.

Referenced by ~Ipv4EndPoint(), ForwardUp(), and SetRxCallback().

◆ m_rxEnabled

bool ns3::Ipv4EndPoint::m_rxEnabled

private

true if the endpoint can receive packets.

Definition at line 237 of file ipv4-end-point.h.

Referenced by IsRxEnabled(), and SetRxEnabled().

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

src/internet/model/ipv4-end-point.h
src/internet/model/ipv4-end-point.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ipv4EndPoint()

◆ ~Ipv4EndPoint()

Member Function Documentation

◆ BindToNetDevice()

◆ ForwardIcmp()

◆ ForwardUp()

◆ GetBoundNetDevice()

◆ GetLocalAddress()

◆ GetLocalPort()

◆ GetPeerAddress()

◆ GetPeerPort()

◆ IsRxEnabled()

◆ SetDestroyCallback()

◆ SetIcmpCallback()

◆ SetLocalAddress()

◆ SetPeer()

◆ SetRxCallback()

◆ SetRxEnabled()

Member Data Documentation

◆ m_boundnetdevice

◆ m_destroyCallback

◆ m_icmpCallback

◆ m_localAddr

◆ m_localPort

◆ m_peerAddr

◆ m_peerPort

◆ m_rxCallback

◆ m_rxEnabled