A Transport that communicates on a UDP multicast group.
More...
#include <daemon/face/multicast-udp-transport.hpp>
|
static void | openRxSocket (protocol::socket &sock, const protocol::endpoint &multicastGroup, const boost::asio::ip::address &localAddress, const shared_ptr< const ndn::net::NetworkInterface > &netif=nullptr) |
|
static void | openTxSocket (protocol::socket &sock, const protocol::endpoint &localEndpoint, const shared_ptr< const ndn::net::NetworkInterface > &netif=nullptr, bool enableLoopback=false) |
|
|
static constexpr ssize_t | MIN_MTU = 64 |
| minimum MTU that may be set on a transport More...
|
|
A Transport that communicates on a UDP multicast group.
Definition at line 49 of file multicast-udp-transport.hpp.
identifies an endpoint on the link
Definition at line 118 of file transport.hpp.
nfd::face::MulticastUdpTransport::MulticastUdpTransport |
( |
const protocol::endpoint & |
multicastGroup, |
|
|
protocol::socket && |
recvSocket, |
|
|
protocol::socket && |
sendSocket, |
|
|
ndn::nfd::LinkType |
linkType |
|
) |
| |
Creates a UDP-based transport for multicast communication.
- Parameters
-
multicastGroup | multicast group |
recvSocket | socket used to receive multicast packets |
sendSocket | socket used to send to the multicast group |
linkType | either ndn::nfd::LINK_TYPE_MULTI_ACCESS or ndn::nfd::LINK_TYPE_AD_HOC |
Definition at line 45 of file multicast-udp-transport.cpp.
void nfd::face::Transport::afterChangePersistency |
( |
ndn::nfd::FacePersistency |
oldPersistency | ) |
|
|
protectedvirtualinherited |
bool nfd::face::Transport::canChangePersistencyTo |
( |
ndn::nfd::FacePersistency |
newPersistency | ) |
const |
|
inherited |
check whether the face persistency can be changed to newPersistency
This function serves as the external API, and invokes the protected function canChangePersistencyToImpl to perform further checks if newPersistency
differs from the current persistency.
- Returns
- true if the change can be performed, false otherwise
Definition at line 132 of file transport.cpp.
bool nfd::face::Transport::canChangePersistencyToImpl |
( |
ndn::nfd::FacePersistency |
newPersistency | ) |
const |
|
protectedvirtualinherited |
void nfd::face::Transport::close |
( |
| ) |
|
|
inherited |
request the transport to be closed
This operation is effective only if transport is in UP or DOWN state, otherwise it has no effect. The transport changes state to CLOSING, and performs cleanup procedure. The state will be changed to CLOSED when cleanup is complete, which may happen synchronously or asynchronously.
Definition at line 87 of file transport.cpp.
time::steady_clock::TimePoint nfd::face::Transport::getExpirationTime |
( |
| ) |
const |
|
inlineinherited |
- Returns
- expiration time of the transport
- Return values
-
time::steady_clock::TimePoint::max() | the transport has indefinite lifetime |
Definition at line 500 of file transport.hpp.
const Face * nfd::face::Transport::getFace |
( |
| ) |
const |
|
inlineinherited |
const LinkService * nfd::face::Transport::getLinkService |
( |
| ) |
const |
|
inlineinherited |
ndn::nfd::LinkType nfd::face::Transport::getLinkType |
( |
| ) |
const |
|
inlineinherited |
- Returns
- whether face is point-to-point or multi-access
Definition at line 457 of file transport.hpp.
FaceUri nfd::face::Transport::getLocalUri |
( |
| ) |
const |
|
inlineinherited |
- Returns
- a FaceUri representing local endpoint
Definition at line 415 of file transport.hpp.
ssize_t nfd::face::Transport::getMtu |
( |
| ) |
const |
|
inlineinherited |
- Returns
- maximum payload size
- Return values
-
MTU_UNLIMITED | transport has no limit on payload size |
This size is the maximum packet size that can be sent or received through this transport.
For a datagram-based transport, this is typically the Maximum Transmission Unit (MTU), after the overhead of headers introduced by the transport has been accounted for. For a stream-based transport, this is typically unlimited (MTU_UNLIMITED).
Definition at line 469 of file transport.hpp.
ndn::nfd::FacePersistency nfd::face::Transport::getPersistency |
( |
| ) |
const |
|
inlineinherited |
FaceUri nfd::face::Transport::getRemoteUri |
( |
| ) |
const |
|
inlineinherited |
- Returns
- a FaceUri representing remote endpoint
Definition at line 427 of file transport.hpp.
ndn::nfd::FaceScope nfd::face::Transport::getScope |
( |
| ) |
const |
|
inlineinherited |
- Returns
- whether face is local or non-local for scope control purpose
Definition at line 439 of file transport.hpp.
ssize_t nfd::face::Transport::getSendQueueCapacity |
( |
| ) |
const |
|
inlineinherited |
- Returns
- capacity of the send queue (in bytes)
- Return values
-
QUEUE_UNSUPPORTED | transport does not support queue capacity retrieval |
QUEUE_ERROR | transport was unable to retrieve the queue capacity |
Definition at line 482 of file transport.hpp.
ssize_t nfd::face::MulticastUdpTransport::getSendQueueLength |
( |
| ) |
|
|
finalvirtual |
- Returns
- current send queue length of the transport (in octets)
- Return values
-
QUEUE_UNSUPPORTED | transport does not support queue length retrieval |
QUEUE_ERROR | transport was unable to retrieve the queue length |
Reimplemented from nfd::face::Transport.
Definition at line 75 of file multicast-udp-transport.cpp.
void nfd::face::MulticastUdpTransport::openRxSocket |
( |
protocol::socket & |
sock, |
|
|
const protocol::endpoint & |
multicastGroup, |
|
|
const boost::asio::ip::address & |
localAddress, |
|
|
const shared_ptr< const ndn::net::NetworkInterface > & |
netif = nullptr |
|
) |
| |
|
static |
void nfd::face::MulticastUdpTransport::openTxSocket |
( |
protocol::socket & |
sock, |
|
|
const protocol::endpoint & |
localEndpoint, |
|
|
const shared_ptr< const ndn::net::NetworkInterface > & |
netif = nullptr , |
|
|
bool |
enableLoopback = false |
|
) |
| |
|
static |
void nfd::face::Transport::receive |
( |
Packet && |
packet | ) |
|
|
protectedinherited |
receive a link-layer packet
- Warning
- undefined behavior if packet size exceeds MTU limit
Definition at line 120 of file transport.cpp.
Receive datagram, translate buffer into packet, deliver to parent class.
void nfd::face::Transport::send |
( |
Packet && |
packet | ) |
|
|
inherited |
send a link-layer packet
- Note
- This operation has no effect if
getState()
is neither UP nor DOWN
- Warning
- undefined behavior if packet size exceeds MTU limit
Definition at line 100 of file transport.cpp.
void nfd::face::Transport::setExpirationTime |
( |
const time::steady_clock::TimePoint & |
expirationTime | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setFaceAndLinkService |
( |
Face & |
face, |
|
|
LinkService & |
service |
|
) |
| |
|
inherited |
void nfd::face::Transport::setLinkType |
( |
ndn::nfd::LinkType |
linkType | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setLocalUri |
( |
const FaceUri & |
uri | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setMtu |
( |
ssize_t |
mtu | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setPersistency |
( |
ndn::nfd::FacePersistency |
newPersistency | ) |
|
|
inherited |
void nfd::face::Transport::setRemoteUri |
( |
const FaceUri & |
uri | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setScope |
( |
ndn::nfd::FaceScope |
scope | ) |
|
|
inlineprotectedinherited |
void nfd::face::Transport::setSendQueueCapacity |
( |
ssize_t |
sendQueueCapacity | ) |
|
|
inlineprotectedinherited |
set transport state
Only the following transitions are valid: UP->DOWN, DOWN->UP, UP/DOWN->CLOSING/FAILED, CLOSING/FAILED->CLOSED
- Exceptions
-
std::runtime_error | transition is invalid. |
Definition at line 177 of file transport.cpp.
signals when transport state changes
Definition at line 274 of file transport.hpp.
const ssize_t nfd::face::Transport::MIN_MTU = 64 |
|
staticinherited |
minimum MTU that may be set on a transport
This is done to ensure the NDNLPv2 fragmentation feature functions properly.
Definition at line 374 of file transport.hpp.
total incoming bytes
This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.
Definition at line 83 of file transport.hpp.
count of incoming packets
A 'packet' typically means a top-level TLV block. For a datagram-based transport, an incoming packet that cannot be parsed as TLV would not be counted.
Definition at line 67 of file transport.hpp.
total outgoing bytes
This counter includes headers imposed by NFD (such as NDNLP), but excludes overhead of underlying protocol (such as IP header). This counter is increased only if transport is UP.
Definition at line 91 of file transport.hpp.
count of outgoing packets
A 'packet' typically means a top-level TLV block. This counter is incremented only if transport is UP.
Definition at line 74 of file transport.hpp.