Struct IgmpMessage

pub struct IgmpMessage<B: SplitByteSlice, M: MessageType<B>> { /* private fields */ }

An IGMP message.

An IgmpMessage is a struct representing an IGMP message in memory; it holds the 3 IGMP message parts and is characterized by the MessageType trait.

Implementations

impl<B: SplitByteSlice> IgmpMessage<B, IgmpMembershipQueryV2>

pub fn is_igmpv1_query(&self) -> bool

Returns true if this is an IGMPv1 query.

Defined in RFC 2236 section 4.1:

The IGMPv1 router will send General Queries with the Max Response Time set to 0…

impl<B: SplitByteSlice> IgmpMessage<B, IgmpMembershipQueryV3>

pub fn as_v2_query(&self) -> IgmpMessage<&[u8], IgmpMembershipQueryV2>

Reinterprets this IgmpMembershipQueryV3 message as an IgmpMembershipQueryV2 message.

Given this crate parses the version separately, users desiring to operate in IGMPv2 or IGMPv1 modes SHOULD reinterpret V3 queries as the older version.

See RFC 3376 section 7.2.1 and RFC 2236 section 2.5.

impl<B: SplitByteSlice, M: MessageType<B>> IgmpMessage<B, M>

pub fn builder(&self) -> IgmpPacketBuilder<B, M>

Construct a builder with the same contents as this packet.

pub fn max_response_time(&self) -> M::MaxRespTime

Gets the interpreted Max Response Time for the message

pub fn header(&self) -> &M::FixedHeader

Returns the header.

pub fn body(&self) -> &M::VariableBody

Returns the body.

impl<B: SplitByteSlice, M: MessageType<B, FixedHeader = Ipv4Addr>> IgmpMessage<B, M>

pub fn group_addr(&self) -> Ipv4Addr

Returns the group address.

Trait Implementations

impl<B: Debug + SplitByteSlice, M: Debug + MessageType<B>> Debug for IgmpMessage<B, M>

where M::FixedHeader: Debug, M::VariableBody: Debug,

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

Formats the value using the given formatter.

impl<B: SplitByteSlice, M: MessageType<B>> ParsablePacket<B, ()> for IgmpMessage<B, M>

type Error = ParseError

The type of errors returned from parse and parse_mut.

fn parse_metadata(&self) -> ParseMetadata

Gets metadata about this packet required by [GrowBuffer::undo_parse].

fn parse<BV: BufferView<B>>(buffer: BV, _args: ()) -> Result<Self, ParseError>

Parses a packet from a buffer.

fn parse_mut<BV>(buffer: BV, args: ParseArgs) -> Result<Self, Self::Error>

where BV: BufferViewMut<B>, B: SplitByteSliceMut,

Parses a packet from a mutable buffer.