inet::UdpJoinMulticastGroupsCommand Class Reference

Class generated from inet/transportlayer/contract/udp/UdpControlInfo.msg:282 by opp_msgtool. More...

#include <UdpControlInfo_m.h>

Inheritance diagram for inet::UdpJoinMulticastGroupsCommand:

Public Member Functions
	UdpJoinMulticastGroupsCommand ()
	UdpJoinMulticastGroupsCommand (const UdpJoinMulticastGroupsCommand &other)
virtual	~UdpJoinMulticastGroupsCommand ()
UdpJoinMulticastGroupsCommand &	operator= (const UdpJoinMulticastGroupsCommand &other)
virtual UdpJoinMulticastGroupsCommand *	dup () const override
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual void	setMulticastAddrArraySize (size_t size)
virtual size_t	getMulticastAddrArraySize () const
virtual const L3Address &	getMulticastAddr (size_t k) const
virtual L3Address &	getMulticastAddrForUpdate (size_t k)
virtual void	setMulticastAddr (size_t k, const L3Address &multicastAddr)
virtual void	insertMulticastAddr (size_t k, const L3Address &multicastAddr)
void	insertMulticastAddr (const L3Address &multicastAddr)
virtual void	appendMulticastAddr (const L3Address &multicastAddr)
virtual void	eraseMulticastAddr (size_t k)
virtual void	setInterfaceIdArraySize (size_t size)
virtual size_t	getInterfaceIdArraySize () const
virtual int	getInterfaceId (size_t k) const
virtual void	setInterfaceId (size_t k, int interfaceId)
virtual void	insertInterfaceId (size_t k, int interfaceId)
void	insertInterfaceId (int interfaceId)
virtual void	appendInterfaceId (int interfaceId)
virtual void	eraseInterfaceId (size_t k)
Public Member Functions inherited from inet::UdpSetOptionCommand
	UdpSetOptionCommand ()
	UdpSetOptionCommand (const UdpSetOptionCommand &other)
virtual	~UdpSetOptionCommand ()
UdpSetOptionCommand &	operator= (const UdpSetOptionCommand &other)
virtual UdpSetOptionSubcode	getOptionCode () const
virtual void	setOptionCode (UdpSetOptionSubcode optionCode)
Public Member Functions inherited from inet::UdpControlInfo
	UdpControlInfo ()
	UdpControlInfo (const UdpControlInfo &other)
virtual	~UdpControlInfo ()
UdpControlInfo &	operator= (const UdpControlInfo &other)

Protected Member Functions
bool	operator== (const UdpJoinMulticastGroupsCommand &)=delete
Protected Member Functions inherited from inet::UdpSetOptionCommand
bool	operator== (const UdpSetOptionCommand &)=delete
Protected Member Functions inherited from inet::UdpControlInfo
bool	operator== (const UdpControlInfo &)=delete

Protected Attributes
L3Address *	multicastAddr = nullptr
size_t	multicastAddr_arraysize = 0
int *	interfaceId = nullptr
size_t	interfaceId_arraysize = 0
Protected Attributes inherited from inet::UdpSetOptionCommand
UdpSetOptionSubcode	optionCode = static_cast<UdpSetOptionSubcode>(-1)

Private Member Functions
void	copy (const UdpJoinMulticastGroupsCommand &other)

Detailed Description

Class generated from inet/transportlayer/contract/udp/UdpControlInfo.msg:282 by opp_msgtool.

//
// Control info for letting an UDP socket join multicast groups.
// To set the option, send a message to the ~Udp module with kind=UDP_C_SETOPTION
// and an and instance of this control info class attached.
//
// The address-interfaceId pairs are passed as two separate arrays.
// When there are less interfaceIds than multicast addresses,
// then -1 is assumed (meaning join on all interfaces).
//
// @see ~UdpCommandCode
//
class UdpJoinMulticastGroupsCommand extends UdpSetOptionCommand
{
    optionCode = UDP_C_SETOPTION_JOIN_MCAST_GRP;
    L3Address multicastAddr[];
    int interfaceId[];
}

Constructor & Destructor Documentation

UdpJoinMulticastGroupsCommand() [1/2]

inet::UdpJoinMulticastGroupsCommand::UdpJoinMulticastGroupsCommand

(

)

UdpJoinMulticastGroupsCommand() [2/2]

inet::UdpJoinMulticastGroupsCommand::UdpJoinMulticastGroupsCommand

(

const UdpJoinMulticastGroupsCommand &

other

)

~UdpJoinMulticastGroupsCommand()

virtual inet::UdpJoinMulticastGroupsCommand::~UdpJoinMulticastGroupsCommand ( )

virtual

Member Function Documentation

appendInterfaceId()

virtual void inet::UdpJoinMulticastGroupsCommand::appendInterfaceId ( int  interfaceId )

virtual

appendMulticastAddr()

virtual void inet::UdpJoinMulticastGroupsCommand::appendMulticastAddr ( const L3Address &  multicastAddr )

virtual

copy()

void inet::UdpJoinMulticastGroupsCommand::copy ( const UdpJoinMulticastGroupsCommand &  other )

private

dup()

virtual UdpJoinMulticastGroupsCommand* inet::UdpJoinMulticastGroupsCommand::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::UdpSetOptionCommand.

{return new UdpJoinMulticastGroupsCommand(*this);}

eraseInterfaceId()

virtual void inet::UdpJoinMulticastGroupsCommand::eraseInterfaceId ( size_t  k )

virtual

eraseMulticastAddr()

virtual void inet::UdpJoinMulticastGroupsCommand::eraseMulticastAddr ( size_t  k )

virtual

getInterfaceId()

virtual int inet::UdpJoinMulticastGroupsCommand::getInterfaceId ( size_t  k ) const

virtual

getInterfaceIdArraySize()

virtual size_t inet::UdpJoinMulticastGroupsCommand::getInterfaceIdArraySize ( ) const

virtual

getMulticastAddr()

virtual const L3Address& inet::UdpJoinMulticastGroupsCommand::getMulticastAddr ( size_t  k ) const

virtual

getMulticastAddrArraySize()

virtual size_t inet::UdpJoinMulticastGroupsCommand::getMulticastAddrArraySize ( ) const

virtual

getMulticastAddrForUpdate()

virtual L3Address& inet::UdpJoinMulticastGroupsCommand::getMulticastAddrForUpdate ( size_t  k )

inlinevirtual

{ return const_cast<L3Address&>(const_cast<UdpJoinMulticastGroupsCommand*>(this)->getMulticastAddr(k));}

insertInterfaceId() [1/2]

void inet::UdpJoinMulticastGroupsCommand::insertInterfaceId ( int  interfaceId )

inline

{appendInterfaceId(interfaceId);}

insertInterfaceId() [2/2]

virtual void inet::UdpJoinMulticastGroupsCommand::insertInterfaceId ( size_t  k, int  interfaceId  )

virtual

insertMulticastAddr() [1/2]

void inet::UdpJoinMulticastGroupsCommand::insertMulticastAddr ( const L3Address &  multicastAddr )

inline

{appendMulticastAddr(multicastAddr);}

insertMulticastAddr() [2/2]

virtual void inet::UdpJoinMulticastGroupsCommand::insertMulticastAddr ( size_t  k, const L3Address &  multicastAddr  )

virtual

operator=()

UdpJoinMulticastGroupsCommand& inet::UdpJoinMulticastGroupsCommand::operator=

(

const UdpJoinMulticastGroupsCommand &

other

)

operator==()

bool inet::UdpJoinMulticastGroupsCommand::operator== ( const UdpJoinMulticastGroupsCommand &  )

protecteddelete

parsimPack()

virtual void inet::UdpJoinMulticastGroupsCommand::parsimPack ( omnetpp::cCommBuffer *  b ) const

overridevirtual

Reimplemented from inet::UdpSetOptionCommand.

Referenced by inet::doParsimPacking().

parsimUnpack()

virtual void inet::UdpJoinMulticastGroupsCommand::parsimUnpack ( omnetpp::cCommBuffer *  b )

overridevirtual

Reimplemented from inet::UdpSetOptionCommand.

Referenced by inet::doParsimUnpacking().

setInterfaceId()

virtual void inet::UdpJoinMulticastGroupsCommand::setInterfaceId ( size_t  k, int  interfaceId  )

virtual

setInterfaceIdArraySize()

virtual void inet::UdpJoinMulticastGroupsCommand::setInterfaceIdArraySize ( size_t  size )

virtual

setMulticastAddr()

virtual void inet::UdpJoinMulticastGroupsCommand::setMulticastAddr ( size_t  k, const L3Address &  multicastAddr  )

virtual

setMulticastAddrArraySize()

virtual void inet::UdpJoinMulticastGroupsCommand::setMulticastAddrArraySize ( size_t  size )

virtual

Member Data Documentation

interfaceId

int* inet::UdpJoinMulticastGroupsCommand::interfaceId = nullptr

protected

interfaceId_arraysize

size_t inet::UdpJoinMulticastGroupsCommand::interfaceId_arraysize = 0

protected

multicastAddr

L3Address* inet::UdpJoinMulticastGroupsCommand::multicastAddr = nullptr

protected

multicastAddr_arraysize

size_t inet::UdpJoinMulticastGroupsCommand::multicastAddr_arraysize = 0

protected

---

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

• UdpControlInfo_m.h