Struct capsule::packets::icmp::v6::ndp::RouterAdvertisement

pub struct RouterAdvertisement<E: Ipv6Packet> { /* fields omitted */ }

Router Advertisement Message defined in IETF RFC 4861.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Type      |     Code      |          Checksum             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Cur Hop Limit |M|O|  Reserved |       Router Lifetime         |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Reachable Time                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                          Retrans Timer                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   Options ...
+-+-+-+-+-+-+-+-+-+-+-+-

• Cur Hop Limit: 8-bit unsigned integer. The default value that should be placed in the Hop Count field of the IP header for outgoing IP packets. A value of zero means unspecified (by this router).

• M: 1-bit "Managed address configuration" flag. When set, it indicates that addresses are available via Dynamic Host Configuration Protocol DHCPv6.

• O: 1-bit "Other configuration" flag. When set, it indicates that other configuration information is available via DHCPv6.

Note: If neither M nor O flags are set, this indicates that no information is available via DHCPv6.

• Reserved: A 6-bit unused field. It MUST be initialized to zero by the sender and MUST be ignored by the receiver.

• Router Lifetime: 16-bit unsigned integer. The lifetime associated with the default router in units of seconds.

• Reachable Time: 32-bit unsigned integer. The time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation.

• Retrans Timer: 32-bit unsigned integer. The time, in milliseconds, between retransmitted Neighbor Solicitation messages.

Possible options:

• Source link-layer address: The link-layer address of the interface from which the Router Advertisement is sent.

• MTU: SHOULD be sent on links that have a variable MTU (as specified in the document that describes how to run IP over the particular link type). MAY be sent on other links.

• Prefix Information: These options specify the prefixes that are on-link and/or are used for stateless address autoconfiguration.

Implementations

impl<E: Ipv6Packet> RouterAdvertisement<E>

pub fn current_hop_limit(&self) -> u8

Returns the current hop limit.

pub fn set_current_hop_limit(&mut self, current_hop_limit: u8)

Sets the current hop limit.

pub fn managed_addr_cfg(&self) -> bool

Returns a flag indicating that addresses are available via DHCPv6.

pub fn set_managed_addr_cfg(&mut self)

Sets the managed address flag.

pub fn unset_managed_addr_cfg(&mut self)

Unsets the managed address flag.

pub fn other_cfg(&self) -> bool

Returns a flag indicating that other configuration information is available via DHCPv6.

pub fn set_other_cfg(&mut self)

Sets the other configuration flag.

pub fn unset_other_cfg(&mut self)

Unsets the other configuration flag.

pub fn router_lifetime(&self) -> u16

Returns the lifetime associated with the default router in units of seconds.

pub fn set_router_lifetime(&mut self, router_lifetime: u16)

Sets the router's default lifetime.

pub fn reachable_time(&self) -> u32

Returns the time, in milliseconds, that a node assumes a neighbor is reachable.

pub fn set_reachable_time(&mut self, reachable_time: u32)

Sets the neighbor reachable time.

pub fn retrans_timer(&self) -> u32

Returns the time, in milliseconds, between retransmitted Neighbor Solicitation messages.

pub fn set_retrans_timer(&mut self, retrans_timer: u32)

Sets the retransmission timer.

Trait Implementations

impl<E: Ipv6Packet> Debug for RouterAdvertisement<E>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<E: Ipv6Packet> Icmpv6Message for RouterAdvertisement<E>

type Envelope = E

The preceding packet type that encapsulates this message.

fn msg_type() -> Icmpv6Type

Returns the assigned message type.

fn icmp(&self) -> &Icmpv6<Self::Envelope>

Returns a reference to the generic ICMPv6 packet.

fn icmp_mut(&mut self) -> &mut Icmpv6<Self::Envelope>

Returns a mutable reference to the generic ICMPv6 packet.

fn into_icmp(self) -> Icmpv6<Self::Envelope>

Converts the message back to the generic ICMPv6 packet.

unsafe fn clone(&self, internal: Internal) -> Self

Returns a copy of the message.

fn try_parse(
    icmp: Icmpv6<Self::Envelope>,
    _internal: Internal
) -> Fallible<Self>

Parses the ICMPv6 packet's payload as this message type.

fn try_push(icmp: Icmpv6<Self::Envelope>, _internal: Internal) -> Fallible<Self>

Prepends a new ICMPv6 message to the beginning of the envelope's payload.

fn reconcile(&mut self)

Reconciles the derivable header fields against the changes made to the packet. The default implementation computes the [checksum] based on the pseudo-header and the ICMPv6 message.

impl<E: Ipv6Packet> Icmpv6Packet for RouterAdvertisement<E>

fn msg_type(&self) -> Icmpv6Type

Returns the message type.

fn code(&self) -> u8

Returns the code.

fn set_code(&mut self, code: u8)

Sets the code.

fn checksum(&self) -> u16

Returns the checksum.

impl<E: Ipv6Packet> NdpPacket for RouterAdvertisement<E>

fn options_offset(&self) -> usize

Returns the buffer offset where the options begin.

fn options_iter(&self) -> ImmutableNdpOptionsIterator

Returns an iterator to read the options in the packet.

fn options_mut(&mut self) -> NdpOptions

Returns a mutable reference to the options in the packet.

impl<E: Ipv6Packet> Packet for RouterAdvertisement<E>

type Envelope = E

The preceding packet type that encapsulates this packet.

fn envelope(&self) -> &Self::Envelope

Returns a reference to the envelope.

fn envelope_mut(&mut self) -> &mut Self::Envelope

Returns a mutable reference to the envelope.

fn offset(&self) -> usize

Returns the buffer offset where the current packet begins.

fn header_len(&self) -> usize

Returns the length of the packet header.

unsafe fn clone(&self, internal: Internal) -> Self

Returns a copy of the packet.

fn try_parse(envelope: Self::Envelope, _internal: Internal) -> Fallible<Self>

Parses the envelope's payload as this packet type.

fn try_push(envelope: Self::Envelope, internal: Internal) -> Fallible<Self>

Prepends a new packet to the beginning of the envelope's payload.

fn deparse(self) -> Self::Envelope

Deparses the packet back to the envelope's packet type.

fn reconcile(&mut self)

Reconciles the derivable header fields against the changes made to the packet.

fn mbuf(&self) -> &Mbuf

Returns a reference to the raw message buffer.

fn mbuf_mut(&mut self) -> &mut Mbuf

Returns a mutable reference to the raw message buffer.

fn payload_offset(&self) -> usize

Returns the buffer offset where the packet payload begins.

fn len(&self) -> usize

Returns the length of the packet with the payload.

fn payload_len(&self) -> usize

Returns the length of the packet payload.

fn parse<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Parses the packet's payload as a packet of type T.

fn peek<T: Packet<Envelope = Self>>(&self) -> Fallible<Immutable<T>> where
    Self: Sized, 

Peeks into the packet's payload as a packet of type T.

fn push<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Prepends a new packet of type T to the beginning of the envelope's payload.

fn remove(self) -> Fallible<Self::Envelope> where
    Self: Sized, 

Removes this packet's header from the message buffer.

fn remove_payload(&mut self) -> Fallible<()>

Removes the packet's payload from the message buffer.

fn reset(self) -> Mbuf where
    Self: Sized, 

Resets the parsed packet back to Mbuf.

fn reconcile_all(&mut self)

Reconciles against the changes recursively through all layers.