Base class for Ethernet-based Transports.
More...
#include <daemon/face/ethernet-transport.hpp>
Base class for Ethernet-based Transports.
Definition at line 41 of file ethernet-transport.hpp.
◆ Counters
◆ EthernetTransport()
| nfd::face::EthernetTransport::EthernetTransport |
( |
const ndn::net::NetworkInterface & |
localEndpoint, |
|
|
const ethernet::Address & |
remoteEndpoint |
|
) |
| |
|
protected |
◆ afterChangePersistency()
| void nfd::face::Transport::afterChangePersistency |
( |
ndn::nfd::FacePersistency |
oldPersistency | ) |
|
|
protectedvirtualinherited |
◆ canChangePersistencyTo()
| 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 142 of file transport.cpp.
◆ canChangePersistencyToImpl()
| bool nfd::face::Transport::canChangePersistencyToImpl |
( |
ndn::nfd::FacePersistency |
newPersistency | ) |
const |
|
protectedvirtualinherited |
◆ close()
| 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 79 of file transport.cpp.
◆ doClose()
| void nfd::face::EthernetTransport::doClose |
( |
| ) |
|
|
finalprotectedvirtual |
performs Transport specific operations to close the transport
This is invoked once by close() after changing state to CLOSING. It will not be invoked by Transport class if the transport is already CLOSING or CLOSED.
When the cleanup procedure is complete, this method should change state to CLOSED. This transition can happen synchronously or asynchronously.
Implements nfd::face::Transport.
Definition at line 78 of file ethernet-transport.cpp.
◆ getCounters()
◆ getExpirationTime()
| 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 457 of file transport.hpp.
◆ getFace()
| const Face * nfd::face::Transport::getFace |
( |
| ) |
const |
|
inlineinherited |
◆ getLinkService() [1/2]
| const LinkService * nfd::face::Transport::getLinkService |
( |
| ) |
const |
|
inlineinherited |
◆ getLinkService() [2/2]
◆ getLinkType()
| ndn::nfd::LinkType nfd::face::Transport::getLinkType |
( |
| ) |
const |
|
inlineinherited |
- Returns
- the link type of the transport
Definition at line 421 of file transport.hpp.
◆ getLocalUri()
| FaceUri nfd::face::Transport::getLocalUri |
( |
| ) |
const |
|
inlineinherited |
- Returns
- a FaceUri representing local endpoint
Definition at line 379 of file transport.hpp.
◆ getMtu()
| 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 433 of file transport.hpp.
◆ getPersistency()
| ndn::nfd::FacePersistency nfd::face::Transport::getPersistency |
( |
| ) |
const |
|
inlineinherited |
◆ getRemoteUri()
| FaceUri nfd::face::Transport::getRemoteUri |
( |
| ) |
const |
|
inlineinherited |
- Returns
- a FaceUri representing remote endpoint
Definition at line 391 of file transport.hpp.
◆ getScope()
| ndn::nfd::FaceScope nfd::face::Transport::getScope |
( |
| ) |
const |
|
inlineinherited |
- Returns
- whether face is local or non-local for scope control purpose
Definition at line 403 of file transport.hpp.
◆ getSendQueueCapacity()
| 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 439 of file transport.hpp.
◆ getSendQueueLength()
| virtual ssize_t nfd::face::Transport::getSendQueueLength |
( |
| ) |
|
|
inlinevirtualinherited |
- 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 in nfd::face::MulticastUdpTransport, nfd::face::DatagramTransport< Protocol, Addressing >, nfd::face::DatagramTransport< boost::asio::ip::udp, Unicast >, nfd::face::DatagramTransport< boost::asio::ip::udp, Multicast >, nfd::face::StreamTransport< Protocol >, nfd::face::StreamTransport< boost::asio::ip::tcp >, nfd::face::StreamTransport< boost::asio::local::stream_protocol >, and nfd::face::TcpTransport.
Definition at line 256 of file transport.hpp.
◆ getState()
◆ hasRecentlyReceived()
| bool nfd::face::EthernetTransport::hasRecentlyReceived |
( |
| ) |
const |
|
inlineprotected |
◆ receive()
| void nfd::face::Transport::receive |
( |
const Block & |
packet, |
|
|
const EndpointId & |
endpoint = 0 |
|
) |
| |
|
protectedinherited |
Pass a received link-layer packet to the upper layer for further processing.
- Parameters
-
| packet | the received packet, must be a valid and well-formed TLV block |
| endpoint | the source endpoint |
- Warning
- Behavior is undefined if packet size exceeds the MTU limit
Definition at line 113 of file transport.cpp.
◆ receivePayload()
| void nfd::face::EthernetTransport::receivePayload |
( |
const uint8_t * |
payload, |
|
|
size_t |
length, |
|
|
const ethernet::Address & |
sender |
|
) |
| |
Processes the payload of an incoming frame.
- Parameters
-
| payload | Pointer to the first byte of data after the Ethernet header |
| length | Payload length |
| sender | Sender address |
Definition at line 205 of file ethernet-transport.cpp.
◆ resetRecentlyReceived()
| void nfd::face::EthernetTransport::resetRecentlyReceived |
( |
| ) |
|
|
inlineprotected |
◆ send()
| void nfd::face::Transport::send |
( |
const Block & |
packet | ) |
|
|
inherited |
Send a link-layer packet.
- Parameters
-
| packet | the packet to be sent, must be a valid and well-formed TLV block |
- Note
- This operation has no effect if getState() is neither UP nor DOWN
- Warning
- Behavior is undefined if packet size exceeds the MTU limit
Definition at line 92 of file transport.cpp.
◆ setExpirationTime()
| void nfd::face::Transport::setExpirationTime |
( |
const time::steady_clock::TimePoint & |
expirationTime | ) |
|
|
inlineprotectedinherited |
◆ setFaceAndLinkService()
| void nfd::face::Transport::setFaceAndLinkService |
( |
Face & |
face, |
|
|
LinkService & |
service |
|
) |
| |
|
inherited |
◆ setLinkType()
| void nfd::face::Transport::setLinkType |
( |
ndn::nfd::LinkType |
linkType | ) |
|
|
inlineprotectedinherited |
◆ setLocalUri()
| void nfd::face::Transport::setLocalUri |
( |
const FaceUri & |
uri | ) |
|
|
inlineprotectedinherited |
◆ setMtu()
| void nfd::face::Transport::setMtu |
( |
ssize_t |
mtu | ) |
|
|
protectedinherited |
◆ setPersistency()
| void nfd::face::Transport::setPersistency |
( |
ndn::nfd::FacePersistency |
newPersistency | ) |
|
|
inherited |
◆ setRemoteUri()
| void nfd::face::Transport::setRemoteUri |
( |
const FaceUri & |
uri | ) |
|
|
inlineprotectedinherited |
◆ setScope()
| void nfd::face::Transport::setScope |
( |
ndn::nfd::FaceScope |
scope | ) |
|
|
inlineprotectedinherited |
◆ setSendQueueCapacity()
| void nfd::face::Transport::setSendQueueCapacity |
( |
ssize_t |
sendQueueCapacity | ) |
|
|
inlineprotectedinherited |
◆ setState()
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 187 of file transport.cpp.
◆ afterStateChange
signals when transport state changes
Definition at line 243 of file transport.hpp.
◆ m_destAddress
| ethernet::Address nfd::face::EthernetTransport::m_destAddress |
|
protected |
◆ m_interfaceName
| std::string nfd::face::EthernetTransport::m_interfaceName |
|
protected |
◆ m_pcap
◆ m_socket
| boost::asio::posix::stream_descriptor nfd::face::EthernetTransport::m_socket |
|
protected |
◆ m_srcAddress
| ethernet::Address nfd::face::EthernetTransport::m_srcAddress |
|
protected |
◆ nInBytes
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 78 of file transport.hpp.
◆ nInPackets
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 62 of file transport.hpp.
◆ nOutBytes
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 86 of file transport.hpp.
◆ nOutPackets
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 69 of file transport.hpp.
Inheritance diagram for nfd::face::EthernetTransport:
1.8.13